Symbols ![]()
loading...
Files ![]()
loading...
ot::Spinel::Buffer::WritePosition struct
Defines the structure to hold a write position for an input frame (frame being written). It should be considered as an opaque data structure to users of `Buffer`.
Syntax
struct WritePosition
{
public:
WritePosition(void)
: mPosition(nullptr)
, mSegmentHead(nullptr)
{
}
private:
uint8_t *mPosition;
uint8_t *mSegmentHead;
friend class Buffer;
};
Fields
Field
Declared as
Related Functions
Found 4 other functions taking a WritePosition
argument:
Function
Description
Gets the current write position in the input frame. The write position is returned in @p aPosition. The saved position can later be used to overwrite the frame content (using `InFrameOverwrite()`) or discard a portion of written frame and move the write pointer back to the saved position (using `InFrameReset()`).
Overwrites the previously written content in the current input frame at a given write position. The write position @p aPostion must belong to the same input frame saved earlier with `InFrameGetPosition()`. Does not allow writing beyond the current end of the input frame (i.e., it can only write over previously added content). If writing @p aDataBufferLength bytes from write position @p aPosition goes beyond the end, this method does not change the input frame and returns error status `OT_ERROR_INVALID_ARGS`. Cannot be used if the input frame has an added `otMessage` (i.e., a previous call to `InFrameFeedMessage()`).
Resets the write position of input frame back to a previously saved position. Any previously added content after the write position is discarded. The write position @p aPosition must belong to the same input frame saved earlier with `InFrameGetPosition()`. Cannot be used if the input frame has an added `otMessage` (i.e., a previous call to `InFrameFeedMessage()`).
Gets the distance (number of bytes) from a given saved position to current end of frame. The write position @p aPosition must belong to the same input frame saved earlier with `InFrameGetPosition()`. Cannot be used if the input frame has an added `otMessage` (i.e., a previous call to `InFrameFeedMessage()`). In case of invalid argument, this method returns zero.