116 lines
3.5 KiB
C++
116 lines
3.5 KiB
C++
/*
|
|
* Copyright (c) 2016, The OpenThread Authors.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 3. Neither the name of the copyright holder nor the
|
|
* names of its contributors may be used to endorse or promote products
|
|
* derived from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
* This file contains definitions for a CLI server on the CONSOLE service.
|
|
*/
|
|
|
|
#ifndef CLI_CONSOLE_HPP_
|
|
#define CLI_CONSOLE_HPP_
|
|
|
|
#include <openthread-types.h>
|
|
#include <cli/cli_server.hpp>
|
|
#include <cli/cli-console.h>
|
|
|
|
namespace Thread {
|
|
namespace Cli {
|
|
|
|
/**
|
|
* This class implements the CLI server on top of the CONSOLE platform abstraction.
|
|
*
|
|
*/
|
|
class Console: public Server
|
|
{
|
|
public:
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param[in] aInstance The OpenThread instance structure.
|
|
*
|
|
*/
|
|
Console(otInstance *aInstance);
|
|
|
|
/**
|
|
* This method delivers raw characters to the client.
|
|
*
|
|
* @param[in] aBuf A pointer to a buffer.
|
|
* @param[in] aBufLength Number of bytes in the buffer.
|
|
*
|
|
* @returns The number of bytes placed in the output queue.
|
|
*
|
|
*/
|
|
int Output(const char *aBuf, uint16_t aBufLength);
|
|
|
|
/**
|
|
* This method delivers formatted output to the client.
|
|
*
|
|
* @param[in] aFmt A pointer to the format string.
|
|
* @param[in] ... A variable list of arguments to format.
|
|
*
|
|
* @returns The number of bytes placed in the output queue.
|
|
*
|
|
*/
|
|
int OutputFormat(const char *fmt, ...);
|
|
|
|
/**
|
|
* This method sets a callback that is called when console has some output.
|
|
*
|
|
* @param[in] aCallback A pointer to a callback method.
|
|
*
|
|
*/
|
|
void SetOutputCallback(otCliConsoleOutputCallback aCallback);
|
|
|
|
/**
|
|
* This method sets a context that is returned with the callback.
|
|
*
|
|
* @param[in] aContext A pointer to a user context.
|
|
*
|
|
*/
|
|
void SetContext(void *aContext);
|
|
|
|
void ReceiveTask(char *aBuf, uint16_t aBufLength);
|
|
|
|
private:
|
|
enum
|
|
{
|
|
kMaxLineLength = 128,
|
|
};
|
|
|
|
otCliConsoleOutputCallback mCallback;
|
|
void *mContext;
|
|
|
|
Interpreter mInterpreter;
|
|
|
|
};
|
|
|
|
} // namespace Cli
|
|
} // namespace Thread
|
|
|
|
#endif // CLI_CONSOLE_HPP_
|