Symbols

loading...

Files

loading...

Summary Syntax Methods Related References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::Buffer

ot::Buffer class

Represents a Message buffer.

Syntax

Show:

Summary

Declaration

from message.hpp:153

class Buffer : public otMessageBuffer, public LinkedListEntry<Buffer> { friend class Message; public: Buffer *GetNextBuffer(void) { return GetNext(); } const Buffer *GetNextBuffer(void) const { return GetNext(); } void SetNextBuffer(Buffer *aNext) { SetNext(aNext); } protected: struct Metadata { bool mDirectTx : 1; bool mLinkSecurity : 1; bool mInPriorityQ : 1; bool mTxSuccess : 1; bool mDoNotEvict : 1; bool mMulticastLoop : 1; bool mResolvingAddress : 1; bool mAllowLookbackToHost : 1; bool mIsDstPanIdBroadcast : 1; #if OPENTHREAD_CONFIG_MULTI_RADIO bool mIsRadioTypeSet : 1; #endif #if OPENTHREAD_CONFIG_TIME_SYNC_ENABLE bool mTimeSync : 1; #endif uint8_t mPriority : 2; uint8_t mOrigin : 2; #if OPENTHREAD_CONFIG_MULTI_RADIO uint8_t mRadioType : 2; static_assert(Mac::kNumRadioTypes <= (1 << 2), "mRadioType bitfield cannot store all radio type values"); #endif uint8_t mType : 3; uint8_t mSubType : 4; uint8_t mMleCommand; uint8_t mChannel; #if OPENTHREAD_CONFIG_TIME_SYNC_ENABLE uint8_t mTimeSyncSeq; #endif uint16_t mLength; uint16_t mOffset; uint16_t mReserved; uint16_t mMeshDest; uint16_t mPanId; uint32_t mDatagramTag; #if OPENTHREAD_CONFIG_TIME_SYNC_ENABLE int64_t mNetworkTimeOffset; #endif TimeMilli mTimestamp; Message *mNext; Message *mPrev; MessagePool *mMessagePool; void *mQueue; RssAverager mRssAverager; LqiAverager mLqiAverager; #if OPENTHREAD_FTD ChildMask mChildMask; #endif }; static_assert(kBufferSize > sizeof(Metadata) + sizeof(otMessageBuffer), "Metadata does not fit in a single buffer"); static constexpr uint16_t kBufferDataSize = kBufferSize - sizeof(otMessageBuffer); static constexpr uint16_t kHeadBufferDataSize = kBufferDataSize - sizeof(Metadata); Metadata &GetMetadata(void) { return mBuffer.mHead.mMetadata; } const Metadata &GetMetadata(void) const { return mBuffer.mHead.mMetadata; } uint8_t *GetFirstData(void) { return mBuffer.mHead.mData; } const uint8_t *GetFirstData(void) const { return mBuffer.mHead.mData; } uint8_t *GetData(void) { return mBuffer.mData; } const uint8_t *GetData(void) const { return mBuffer.mData; } private: union { struct { Metadata mMetadata; uint8_t mData[kHeadBufferDataSize]; } mHead; uint8_t mData[kBufferDataSize]; } mBuffer; };

Fields

Field

Declared as

ot::Buffer::kBufferDataSize

ot::Buffer::kHeadBufferDataSize

ot::Buffer::mBuffer

union { struct { Metadata mMetadata; uint8_t mData[kHeadBufferDataSize]; } mHead; uint8_t mData[kBufferDataSize]; }

Methods

GetNextBuffer()

Returns a pointer to the next message buffer.

GetNextBuffer() const

Returns a pointer to the next message buffer.

SetNextBuffer()

Sets the pointer to the next message buffer.

GetMetadata()

GetMetadata() const

GetFirstData()

GetFirstData() const

GetData()

GetData() const

References

Code

Location

Scope

Referrer

class Buffer : public otMessageBuffer, public LinkedListEntry<Buffer>

message.hpp:153

DefineCoreType(otCacheEntryIterator, AddressResolver::Iterator);

address_resolver.hpp:400

DefineCoreType(otCacheEntryInfo, AddressResolver::EntryInfo);

address_resolver.hpp:401

DefineCoreType(otChildInfo, Child::Info);

DefineCoreType(otCoapTxParameters, Coap::TxParameters);

DefineCoreType(otCoapResource, Coap::Resource);

DefineCoreType(otCoapOption, Coap::Option);

coap_message.hpp:1175

DefineCoreType(otCoapOptionIterator, Coap::Option::Iterator);

coap_message.hpp:1176

DefineCoreType(otOperationalDatasetComponents, MeshCoP::Dataset::Components);

dataset.hpp:783

DefineCoreType(otOperationalDataset, MeshCoP::Dataset::Info);

dataset.hpp:784

DefineCoreType(otDnsQueryConfig, Dns::Client::QueryConfig);

dns_client.hpp:892

DefineCoreType(otDnsAddressResponse, Dns::Client::AddressResponse);

dns_client.hpp:893

DefineCoreType(otDnsBrowseResponse, Dns::Client::BrowseResponse);

dns_client.hpp:895

DefineCoreType(otDnsServiceResponse, Dns::Client::ServiceResponse);

dns_client.hpp:896

DefineCoreType(otDnsServiceInfo, Dns::Client::ServiceInfo);

dns_client.hpp:897

DefineCoreType(otDnsTxtEntry, Dns::TxtEntry);

dns_types.hpp:2734

DefineCoreType(otDnsTxtEntryIterator, Dns::TxtEntry::Iterator);

dns_types.hpp:2735

DefineCoreType(otPlatCryptoEcdsaSignature, Crypto::Ecdsa::P256::Signature);

DefineCoreType(otPlatCryptoEcdsaKeyPair, Crypto::Ecdsa::P256::KeyPair);

DefineCoreType(otPlatCryptoEcdsaPublicKey, Crypto::Ecdsa::P256::PublicKey);

DefineCoreType(otExtendedPanId, MeshCoP::ExtendedPanId);

extended_panid.hpp:106

DefineCoreType(otIcmp6Header, Ip6::Icmp::Header);

DefineCoreType(otIcmp6Handler, Ip6::Icmp::Handler);

DefineCoreType(otInstance, Instance);

instance.hpp:741

DefineCoreType(otBufferInfo, Instance::BufferInfo);

instance.hpp:742

DefineCoreType(otIp4Address, Ip4::Address);

ip4_types.hpp:661

DefineCoreType(otIp4Cidr, Ip4::Cidr);

ip4_types.hpp:662

DefineCoreType(otIp6NetworkPrefix, Ip6::NetworkPrefix);

ip6_address.hpp:986

DefineCoreType(otIp6Prefix, Ip6::Prefix);

ip6_address.hpp:987

DefineCoreType(otIp6InterfaceIdentifier, Ip6::InterfaceIdentifier);

ip6_address.hpp:988

DefineCoreType(otIp6Address, Ip6::Address);

ip6_address.hpp:989

DefineCoreType(otSecurityPolicy, SecurityPolicy);

key_manager.hpp:646

DefineCoreType(otNetworkKey, NetworkKey);

key_manager.hpp:647

DefineCoreType(otPskc, Pskc);

key_manager.hpp:648

DefineCoreType(otExtAddress, Mac::ExtAddress);

mac_types.hpp:923

DefineCoreType(otMacKey, Mac::Key);

mac_types.hpp:924

DefineCoreType(otThreadLinkInfo, ThreadLinkInfo);

mesh_forwarder.hpp:662

DefineCoreType(otJoinerPskd, MeshCoP::JoinerPskd);

meshcop.hpp:515

DefineCoreType(otJoinerDiscerner, MeshCoP::JoinerDiscerner);

meshcop.hpp:516

DefineCoreType(otSteeringData, MeshCoP::SteeringData);

meshcop.hpp:517

DefineCoreType(otCommissioningDataset, MeshCoP::CommissioningDataset);

meshcop.hpp:518

DefineCoreType(otMessageBuffer, Buffer);

message.hpp:1901

DefineCoreType(otMessageSettings, Message::Settings);

message.hpp:1902

DefineCoreType(otMessage, Message);

message.hpp:1903

DefineCoreType(otMessageQueue, MessageQueue);

message.hpp:1904

DefineCoreType(otLeaderData, Mle::LeaderData);

mle_types.hpp:699

DefineCoreType(otDeviceProperties, Mle::DeviceProperties);

mle_types.hpp:702

DefineCoreType(otNeighborInfo, Neighbor::Info);

neighbor.hpp:773

DefineCoreType(otNetifAddress, Ip6::Netif::UnicastAddress);

DefineCoreType(otNetifMulticastAddress, Ip6::Netif::MulticastAddress);

DefineCoreType(otBorderRouterConfig, NetworkData::OnMeshPrefixConfig);

network_data_types.hpp:400

DefineCoreType(otExternalRouteConfig, NetworkData::ExternalRouteConfig);

network_data_types.hpp:401

DefineCoreType(otLowpanContextInfo, NetworkData::LowpanContextInfo);

network_data_types.hpp:402

DefineCoreType(otServiceConfig, NetworkData::ServiceConfig);

network_data_types.hpp:403

DefineCoreType(otServerConfig, NetworkData::ServiceConfig::ServerConfig);

network_data_types.hpp:404

DefineCoreType(otNetworkName, MeshCoP::NetworkName);

network_name.hpp:262

DefineCoreType(otPingSenderReply, Utils::PingSender::Reply);

ping_sender.hpp:179

DefineCoreType(otPingSenderConfig, Utils::PingSender::Config);

ping_sender.hpp:180

DefineCoreType(otPingSenderStatistics, Utils::PingSender::Statistics);

ping_sender.hpp:181

DefineCoreType(otRouterInfo, Router::Info);

DefineCoreType(otCryptoSha256Hash, Crypto::Sha256::Hash);

DefineCoreType(otMessageInfo, Ip6::MessageInfo);

DefineCoreType(otSockAddr, Ip6::SockAddr);

DefineCoreType(otSrpClientHostInfo, Srp::Client::HostInfo);

srp_client.hpp:1116

DefineCoreType(otSrpClientService, Srp::Client::Service);

srp_client.hpp:1117

DefineCoreType(otSrpClientBuffersServiceEntry, Utils::SrpClientBuffers::ServiceEntry);

srp_client_buffers.hpp:248

DefineCoreType(otCryptoKey, Crypto::Key);

storage.hpp:323

DefineCoreType(otTcpEndpoint, Ip6::Tcp::Endpoint);

DefineCoreType(otTcpListener, Ip6::Tcp::Listener);

DefineCoreType(otTcpCircularSendBuffer, Ip6::TcpCircularSendBuffer);

tcp6_ext.hpp:129

DefineCoreType(otUdpSocket, Ip6::Udp::SocketHandle);

DefineCoreType(otUdpReceiver, Ip6::Udp::Receiver);

Buffer *MessagePool::NewBuffer(Message::Priority aPriority)

message.cpp:103

ot::MessagePool

ot::MessagePool::NewBuffer()

Buffer *buffer = nullptr;

message.cpp:105

ot::MessagePool::NewBuffer()

void MessagePool::FreeBuffers(Buffer *aBuffer)

message.cpp:134

ot::MessagePool::FreeBuffers()

ot::MessagePool::FreeBuffers()::aBuffer

Buffer *next = aBuffer->GetNextBuffer();

message.cpp:138

ot::MessagePool::FreeBuffers()

Buffer *curBuffer = this;

message.cpp:224

ot::Message::ResizeMessage()

Buffer *lastBuffer;

message.cpp:225

ot::Message::ResizeMessage()

for (const Buffer *curBuffer = GetNextBuffer(); curBuffer; curBuffer = curBuffer->GetNextBuffer())

message.cpp:300

ot::Message::GetBufferCount() const

Buffer *newBuffer = nullptr;

message.cpp:420

ot::Message::PrependBytes()

Buffer *GetNextBuffer(void) { return GetNext(); }

message.hpp:163

ot::Buffer::GetNextBuffer()

const Buffer *GetNextBuffer(void) const { return GetNext(); }

message.hpp:170

ot::Buffer::GetNextBuffer() const

void SetNextBuffer(Buffer *aNext) { SetNext(aNext); }

message.hpp:177

ot::Buffer::SetNextBuffer()

ot::Buffer::SetNextBuffer()::aNext

static_assert(sizeof(Buffer) >= kBufferSize,

message.hpp:257

class Message : public otMessage, public Buffer, public GetProvider<Message>

message.hpp:263

const Buffer *GetBuffer(void) const { return mBuffer; }

message.hpp:1519

ot::Message::Chunk

ot::Message::Chunk::GetBuffer() const

void SetBuffer(const Buffer *aBuffer) { mBuffer = aBuffer; }

message.hpp:1520

ot::Message::Chunk::SetBuffer()

ot::Message::Chunk::SetBuffer()::aBuffer

const Buffer *mBuffer; // Buffer containing the chunk

message.hpp:1523

ot::Message::Chunk

ot::Message::Chunk::mBuffer

Buffer *NewBuffer(Message::Priority aPriority);

message.hpp:1884

ot::MessagePool

ot::MessagePool::NewBuffer()

void FreeBuffers(Buffer *aBuffer);

message.hpp:1885

ot::MessagePool::FreeBuffers()

ot::MessagePool::FreeBuffers()::aBuffer

Pool<Buffer, kNumBuffers> mBufferPool;

message.hpp:1889

DefineCoreType(otMessageBuffer, Buffer);

message.hpp:1901

ot::CoreType::Type

Call Tree

All items filtered out

All items filtered out

Data Use

All items filtered out

All items filtered out

Class Tree

ot::Buffer inherits 1 classes and is inherited by 1 classes:

ot::Buffer

otMessageBuffer

Override Tree

All items filtered out

All items filtered out

Implementations

All items filtered out

All items filtered out

Lifecycle

All items filtered out

All items filtered out