Symbols

loading (2/5)...

Files

loading (4/5)...

Summary Syntax Methods References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::Ip6::TcpCircularSendBuffer

ot::Ip6::TcpCircularSendBuffer class

Represents a TCP circular send buffer.

Syntax

Show:

Summary

Declaration

from tcp6_ext.hpp:58

class TcpCircularSendBuffer : public otTcpCircularSendBuffer { public: void Initialize(void *aDataBuffer, size_t aCapacity); Error Write(Tcp::Endpoint &aEndpoint, const void *aData, size_t aLength, size_t &aWritten, uint32_t aFlags); void HandleForwardProgress(size_t aInSendBuffer); size_t GetFreeSpace(void) const; void ForceDiscardAll(void); Error Deinitialize(void); private: size_t GetIndex(size_t aStart, size_t aOffsetFromStart) const; };

Methods

Initialize()

Initializes a TCP circular send buffer. @sa otTcpCircularSendBufferInitialize.

Write()

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.

HandleForwardProgress()

Performs circular-send-buffer-specific handling in the otTcpForwardProgress callback. @sa otTcpCircularSendBufferHandleForwardProgress.

GetFreeSpace() const

Returns the amount of free space in this TCP circular send buffer. @sa otTcpCircularSendBufferFreeSpace.

ForceDiscardAll()

Forcibly discards all data in this TCP circular send buffer. @sa otTcpCircularSendBufferForceDiscardAll.

Deinitialize()

Deinitializes this TCP circular send buffer. @sa otTcpCircularSendBufferDeinitialize.

GetIndex() const

References

Code

Location

Referrer

class TcpCircularSendBuffer : public otTcpCircularSendBuffer

tcp6_ext.hpp:58

DefineCoreType(otTcpCircularSendBuffer, Ip6::TcpCircularSendBuffer);

tcp6_ext.hpp:129

ot::CoreType::Type

Call Tree

All items filtered out

Data Use

All items filtered out

Class Tree

ot::Ip6::TcpCircularSendBuffer is inherited by 1 classes:

ot::Ip6::TcpCircularSendBuffer

otTcpCircularSendBuffer

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Instance

Scope

Location

Project

ot::CoreType::Type

tcp6_ext.hpp:129

Lifecycle

All items filtered out