nl::Weave::TLV::CircularTLVWriter

Summary

Inheritance

Inherits from: nl::Weave::TLV::TLVWriter

Public functions
Init(WeaveCircularTLVBuffer *buf)
void
Initializes a TLVWriter object to write from a single WeaveCircularTLVBuffer.

Public functions

Init

void Init(
  WeaveCircularTLVBuffer *buf
)

Initializes a TLVWriter object to write from a single WeaveCircularTLVBuffer.

Writing begins at the last byte of the buffer. The number of bytes to be written is not constrained by the underlying circular buffer: writing new elements to the buffer will kick out previous elements as long as an individual top-level TLV structure fits within the buffer. For example, writing a 7-byte top-level boolean TLV into a 7 byte buffer will work indefinitely, but writing an 8-byte TLV structure will result in an error.

Details
Parameters
[in] buf
A pointer to a fully initialized WeaveCircularTLVBuffer