BeginFrame()
Begins a new frame to be added/written to the frame buffer. If there is a previous frame being written (for which `EndFrame()` has not yet been called), calling `BeginFrame()` will discard and clear the previous unfinished frame.
BeginFrame()
Begins a new frame to be added/written to the frame buffer. If there is a previous frame being written (for which `EndFrame()` has not yet been called), calling `BeginFrame()` will discard and clear the previous unfinished frame.
BeginFrame()
Begins a new frame to be added/written to the frame buffer. If there is a previous frame being written (for which `EndFrame()` has not yet been called), calling `BeginFrame()` will discard and clear the previous unfinished frame.
OverwriteWithLastStatusError()
Overwrites the property key with `LAST_STATUS` in a property update command frame. Should be only used after a successful `BeginFrame(aHeader, aCommand, aPropertyKey)`, otherwise, its behavior is undefined. Moves the write position back to saved position by `BeginFrame()` and replaces the property key `SPINEL_PROP_LAST_STATUS` and writes the given spinel status error.
EndFrame()
Finalizes/ends the current frame being written to the buffer. Before using this method `BeginFrame()` must be called to start and prepare a new frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the frame and return error status `OT_ERROR_NO_BUFS`. Ensures to close any open structure (previously opened using `OpenStruct()` but not closed using `CloseStruct()`).
WriteBool()
Encodes and writes a boolean value to current input frame. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WriteUint8()
Encodes and writes a `uint8_t` value to current input frame. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WriteInt8()
Encodes and writes an `int8_t` value to current input frame. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WriteUint16()
Encodes and writes a `uint16_t` value to current input frame. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WriteInt16()
Encodes and writes an `int16_t` value to current input frame. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WriteUint32()
Encodes and writes a `uint32_t` value to current input frame. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WriteInt32()
Encodes and writes an `int32_t` value to current input frame. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WriteUint64()
Encodes and writes a `uint64_t` value to current input frame. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WriteInt64()
Encodes and writes an `int64_t` value to current input frame. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WriteUintPacked()
Encodes (using spinel packed integer format) and writes a value to current input frame. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WriteIp6Address()
Encodes and writes an IPv6 address to current input frame. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WriteIp6Address()
Encodes and writes an IPv6 address to current input frame. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WriteIp6Address()
Encodes and writes an IPv6 address to current input frame. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WriteEui64()
Encodes and writes an EUI64 value to current input frame. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WriteEui64()
Encodes and writes an EUI64 value to current input frame. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WriteEui64()
Encodes and writes an EUI64 value to current input frame. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WriteEui48()
Encodes and writes an EUI48 value to current input frame. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WriteEui48()
Encodes and writes an EUI48 value to current input frame. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WriteUtf8()
Encodes and writes a UTF8 string to current input frame. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WriteData()
Encodes and writes a sequence of bytes to current input frame. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WriteDataWithLen()
Encodes and writes a data blob (sequence of bytes) with its length prepended before the data. The length of the data (in bytes) is prepended (with the length encoded as a `uint16`). The size of the length field is not included in the length. This is similar to `SPINEL_DATATYPE_DATA_WLEN` type. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`.
WritePacked()
Encodes and writes a set of variables to the current input frame using a given spinel packing format string. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`. Note that the encoded buffer should fit in `kPackFormatBufferSize` bytes.
WriteVPacked()
Encodes and writes a set of variables to the current input frame using a given spinel packing format string. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the current input frame and return the error status `OT_ERROR_NO_BUFS`. Note that the encoded buffer should fit in `kPackFormatBufferSize` bytes.
OpenStruct()
Opens a struct in the current input frame. After a successful call to this method, all the subsequent `Write()` methods add the field/value to the current open struct until the struct is closed using `CloseStruct()` method. Structures can be nested. Up to `kMaxNestedStructs` nested structs can be opened at the same time. Before using this method `BeginFrame()` must be called to start and prepare a new input frame. Otherwise, this method does nothing and returns error status `OT_ERROR_INVALID_STATE`. If no buffer space is available, this method will discard and clear the frame and return error status `OT_ERROR_NO_BUFS`.
CloseStruct()
Closes the most recently opened struct (using `OpenStruct()`) in the current input frame. Each call to `CloseStruct()` must correspond to an earlier successfully opened struct. If a frame is ended using `EndFrame()` with remaining open structs, the `EndFrame()` method will close all the remaining structs. If no buffer space is available, this method will discard and clear the frame and return error status `OT_ERROR_NO_BUFS`.
SavePosition()
Saves the current write position in the input frame. The saved position can later be used to discard a portion of written/encoded frame and move the write pointer back to the saved position (using `ResetToSaved()`).
ResetToSaved()
Resets the write position of input frame back to a previously saved position. Any added content after the write position is discarded. The saved position must belong to the same input frame saved earlier with `SavePosition()`. This method cannot be used if the input frame has an added `otMessage`.
ClearNcpBuffer()
Clear NCP buffer on reset command.