ot::Hdlc::Encoder::Encode() method

Encodes a given block of data into current frame. Returns success only if there is space in buffer to encode the entire block of data. If there is no space to encode the entire block of data, the write pointer in frame buffer remains the same.

Syntax

Show:

Summary

Declaration

Definition

from hdlc.hpp:99

otError Encode(const uint8_t *aData, uint16_t aLength);

Implemented in hdlc.cpp:153

Arguments

Argument

Description

aData

A pointer to a buffer containing the data to encode.

aLength

The number of bytes in @p aData.

Return value

OT_ERROR_NONE Successfully encoded and added the data to frame. OT_ERROR_NO_BUFS Insufficient buffer space available to add the frame.

Examples

References

from examples

ot::Hdlc::Encoder::Encode() method

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle