Symbols

Files

loading (3/5)...

Summary Syntax Methods Related References Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::FrameBuilder

ot::FrameBuilder class

The `FrameBuilder` can be used to construct frame content in a given data buffer.

Syntax

Show:

Summary

Declaration

from frame_builder.hpp:49

class FrameBuilder { public: void Init(void *aBuffer, uint16_t aMaxLength); const uint8_t *GetBytes(void) const { return mBuffer; } uint16_t GetLength(void) const { return mLength; } uint16_t GetMaxLength(void) const { return mMaxLength; } void SetMaxLength(uint16_t aLength) { mMaxLength = aLength; } uint16_t GetRemainingLength(void) const { return mMaxLength - mLength; } bool CanAppend(uint16_t aLength) const { return (static_cast<uint32_t>(mLength) + aLength) <= mMaxLength; } Error AppendUint8(uint8_t aUint8); Error AppendBigEndianUint16(uint16_t aUint16); Error AppendBigEndianUint32(uint32_t aUint32); Error AppendLittleEndianUint16(uint16_t aUint16); Error AppendLittleEndianUint32(uint32_t aUint32); Error AppendBytes(const void *aBuffer, uint16_t aLength); Error AppendMacAddress(const Mac::Address &aMacAddress); #if OPENTHREAD_FTD || OPENTHREAD_MTD Error AppendBytesFromMessage(const Message &aMessage, uint16_t aOffset, uint16_t aLength); #endif template <typename ObjectType> Error Append(const ObjectType &aObject) { static_assert(!TypeTraits::IsPointer<ObjectType>::kValue, "ObjectType must not be a pointer"); return AppendBytes(&aObject, sizeof(ObjectType)); } void *AppendLength(uint16_t aLength); template <typename ObjectType> ObjectType *Append(void) { static_assert(!TypeTraits::IsPointer<ObjectType>::kValue, "ObjectType must not be a pointer"); return static_cast<ObjectType *>(AppendLength(sizeof(ObjectType))); } void WriteBytes(uint16_t aOffset, const void *aBuffer, uint16_t aLength); template <typename ObjectType> void Write(uint16_t aOffset, const ObjectType &aObject) { static_assert(!TypeTraits::IsPointer<ObjectType>::kValue, "ObjectType must not be a pointer"); WriteBytes(aOffset, &aObject, sizeof(ObjectType)); } Error InsertBytes(uint16_t aOffset, const void *aBuffer, uint16_t aLength); template <typename ObjectType> Error Insert(uint16_t aOffset, const ObjectType &aObject) { static_assert(!TypeTraits::IsPointer<ObjectType>::kValue, "ObjectType must not be a pointer"); return InsertBytes(aOffset, &aObject, sizeof(ObjectType)); } void RemoveBytes(uint16_t aOffset, uint16_t aLength); private: uint8_t *mBuffer; uint16_t mLength; uint16_t mMaxLength; };

Fields

Field

Declared as

ot::FrameBuilder::mBuffer

uint8_t *

ot::FrameBuilder::mLength

uint16_t

ot::FrameBuilder::mMaxLength

uint16_t

Methods

Init()

Initializes the `FrameBuilder` to use a given buffer. `FrameBuilder` MUST be initialized before its other methods are used.

GetBytes() const

Returns a pointer to the start of `FrameBuilder` buffer.

GetLength() const

Returns the current length of frame (number of bytes appended so far).

GetMaxLength() const

Returns the maximum length of the frame.

SetMaxLength()

Sets the maximum length of the frame. Does not perform any checks on the new given length. The caller MUST ensure that the specified max length is valid for the frame buffer.

GetRemainingLength() const

Returns the remaining length (number of bytes that can be appended) in the frame.

CanAppend() const

Indicates whether or not there are enough bytes remaining in the `FrameBuilder` buffer to append a given number of bytes.

AppendUint8()

Appends an `uint8_t` value to the `FrameBuilder`.

AppendBigEndianUint16()

Appends an `uint16_t` value assuming big endian encoding to the `FrameBuilder`.

AppendBigEndianUint32()

Appends an `uint32_t` value assuming big endian encoding to the `FrameBuilder`.

AppendLittleEndianUint16()

Appends an `uint16_t` value assuming little endian encoding to the `FrameBuilder`.

AppendLittleEndianUint32()

Appends an `uint32_t` value assuming little endian encoding to the `FrameBuilder`.

AppendBytes()

Appends bytes from a given buffer to the `FrameBuilder`.

AppendMacAddress()

Appends a given `Mac::Address` to the `FrameBuilder`.

AppendBytesFromMessage()

Appends bytes read from a given message to the `FrameBuilder`.

Append()

AppendLength()

Appends the given number of bytes to the `FrameBuilder`. This method reserves @p aLength bytes at the current position of the `FrameBuilder` and returns a pointer to the start of this reserved buffer if successful. The reserved bytes are left uninitialized. The caller is responsible for initializing them.

Append()

WriteBytes()

Writes bytes in `FrameBuilder` at a given offset overwriting the previously appended content. Does not perform any bound checks. The caller MUST ensure that the given data length fits within the previously appended content. Otherwise the behavior of this method is undefined.

Write()

InsertBytes()

Inserts bytes in `FrameBuilder` at a given offset, moving previous content forward. The caller MUST ensure that @p aOffset is within the current frame length (from 0 up to and including `GetLength()`). Otherwise the behavior of this method is undefined.

Insert()

RemoveBytes()

Removes a given number of bytes in `FrameBuilder` at a given offset, moving existing content after removed bytes backward. Does not perform any bound checks. The caller MUST ensure that the given length and offset fits within the previously appended content. Otherwise the behavior of this method is undefined.