mirror of
https://github.com/espressif/openthread.git
synced 2026-08-14 14:47:46 +00:00
ncp: New API otNcpStreamWrite() (#318)
This API will initially be used for writing debug logs messages to the host, but may in the future be expanded for other purposes. This change also fixes a misspelling of "Property" in various internal methods.
This commit is contained in:
committed by
Jonathan Hui
parent
285bce2128
commit
1d6ed8f66a
@@ -35,6 +35,8 @@
|
||||
#ifndef NCP_H_
|
||||
#define NCP_H_
|
||||
|
||||
#include "../openthread-types.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
@@ -45,6 +47,30 @@ extern "C" {
|
||||
*/
|
||||
void otNcpInit(void);
|
||||
|
||||
/**
|
||||
* @brief Send data to the host via a specific stream.
|
||||
*
|
||||
* This function attempts to send the given data to the host
|
||||
* using the given aStreamId. This is useful for reporting
|
||||
* error messages, implementing debug/diagnostic consoles,
|
||||
* and potentially other types of datastreams.
|
||||
*
|
||||
* The write either is accepted in its entirety or rejected.
|
||||
* Partial writes are not attempted.
|
||||
*
|
||||
* @param[in] aStreamId A numeric identifier for the stream to write to.
|
||||
* If set to '0', will default to the debug stream.
|
||||
* @param[in] aDataPtr A pointer to the data to send on the stream.
|
||||
* If aDataLen is non-zero, this param MUST NOT be NULL.
|
||||
* @param[in] aDataLen The number of bytes of data from aDataPtr to send.
|
||||
*
|
||||
* @retval kThreadError_None The data was queued for delivery to the host.
|
||||
* @retval kThreadError_Busy There are not enough resources to complete this
|
||||
* request. This is usually a temporary condition.
|
||||
* @retval kThreadError_InvalidArgs The given aStreamId was invalid.
|
||||
*/
|
||||
ThreadError otNcpStreamWrite(int aStreamId, const uint8_t *aDataPtr, int aDataLen);
|
||||
|
||||
#ifdef __cplusplus
|
||||
} // extern "C"
|
||||
#endif
|
||||
|
||||
Reference in New Issue
Block a user