ot::Ip6::TcpCircularSendBuffer::Write() method

Sends out data on a TCP endpoint, using this TCP circular send buffer to manage buffering. @sa otTcpCircularSendBufferWrite, particularly for guidance on how @p aEndpoint must be chosen.

Syntax

Show:

Summary

Declaration

from tcp6_ext.hpp:86

Error Write(Tcp::Endpoint &aEndpoint, const void *aData, size_t aLength, size_t &aWritten, uint32_t aFlags);

Arguments

Argument

Description

aEndpoint

The TCP endpoint on which to send out data.

aData

A pointer to data to copy into the TCP circular send buffer.

aLength

The length of the data pointed to by @p aData to copy into the TCP circular send buffer.

aWritten

Populated with the amount of data copied into the send buffer, which might be less than @p aLength if the send buffer reaches capacity.

aFlags

Flags specifying options for this operation.

Return value

kErrorNone on success, or the error returned by the TCP endpoint on failure.

Examples

References

from examples

ot::Ip6::TcpCircularSendBuffer::Write() method

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle

ot::Ip6::TcpCircularSendBuffer::Write() method

Syntax

Arguments

Return value

Related Functions

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle