ot::Utils::SrpClientBuffers class

Represents the SRP client buffers and service pool.

Syntax

Show:

Summary

Declaration

from srp_client_buffers.hpp:61

class SrpClientBuffers : public InstanceLocator, private NonCopyable { public: static constexpr uint16_t kMaxServices = OPENTHREAD_CONFIG_SRP_CLIENT_BUFFERS_MAX_SERVICES; static constexpr uint16_t kMaxHostAddresses = OPENTHREAD_CONFIG_SRP_CLIENT_BUFFERS_MAX_HOST_ADDRESSES; static constexpr uint16_t kHostNameSize = OPENTHREAD_CONFIG_SRP_CLIENT_BUFFERS_HOST_NAME_SIZE; static constexpr uint16_t kServiceNameSize = OPENTHREAD_CONFIG_SRP_CLIENT_BUFFERS_SERVICE_NAME_SIZE; static constexpr uint16_t kServiceMaxSubTypes = OPENTHREAD_CONFIG_SRP_CLIENT_BUFFERS_SERVICE_MAX_SUB_TYPES; static constexpr uint16_t kInstanceNameSize = OPENTHREAD_CONFIG_SRP_CLIENT_BUFFERS_SERVICE_INSTANCE_NAME_SIZE; static constexpr uint16_t kTxtBufferSize = OPENTHREAD_CONFIG_SRP_CLIENT_BUFFERS_TXT_BUFFER_SIZE; class ServiceEntry : public otSrpClientBuffersServiceEntry, public Clearable<ServiceEntry> { friend class SrpClientBuffers; friend class LinkedList<ServiceEntry >; public: char *GetServiceNameString(uint16_t &aSize) { aSize = sizeof(mServiceName); return mServiceName; } char *GetInstanceNameString(uint16_t &aSize) { aSize = sizeof(mInstanceName); return mInstanceName; } uint8_t *GetTxtBuffer(uint16_t &aSize) { aSize = sizeof(mTxtBuffer); return mTxtBuffer; } const char **GetSubTypeLabelsArray(uint16_t &aArrayLength) { aArrayLength = GetArrayLength(mSubTypeLabels); return mSubTypeLabels; } private: ServiceEntry *GetNext(void) { return reinterpret_cast<ServiceEntry *>(mService.mNext); } const ServiceEntry *GetNext(void) const { return reinterpret_cast<const ServiceEntry *>(mService.mNext); } void SetNext(ServiceEntry *aEntry) { mService.mNext = reinterpret_cast<Srp::Client::Service *>(aEntry); } char mServiceName[kServiceNameSize]; char mInstanceName[kInstanceNameSize]; uint8_t mTxtBuffer[kTxtBufferSize]; const char *mSubTypeLabels[kServiceMaxSubTypes + 1]; }; explicit SrpClientBuffers(Instance &aInstance); char *GetHostNameString(uint16_t &aSize) { aSize = sizeof(mHostName); return mHostName; } Ip6::Address *GetHostAddressesArray(uint8_t &aArrayLength) { aArrayLength = static_cast<uint8_t>(GetArrayLength(mHostAddresses)); return &mHostAddresses[0]; } ServiceEntry *AllocateService(void); void FreeService(ServiceEntry &aServiceEntry) { mServicePool.Free(aServiceEntry); } void FreeAllServices(void) { mServicePool.FreeAll(); } private: char mHostName[kHostNameSize]; Ip6::Address mHostAddresses[kMaxHostAddresses]; Pool<ServiceEntry, kMaxServices> mServicePool; };

Fields

Field

Description

Declared as

ot::Utils::SrpClientBuffers::kMaxServices

Maximum number of service entries in the pool.

ot::Utils::SrpClientBuffers::kMaxHostAddresses

Max number of host address entries.

ot::Utils::SrpClientBuffers::kHostNameSize

Size (number of char) of host name string (includes null `\0` termination char).

ot::Utils::SrpClientBuffers::kServiceNameSize

Size (number of char) of service name string (includes null `\0` termination char).

ot::Utils::SrpClientBuffers::kServiceMaxSubTypes

Array length for service subtype label.

ot::Utils::SrpClientBuffers::kInstanceNameSize

Size (number of char) of service instance name string (includes null `\0` termination char).

ot::Utils::SrpClientBuffers::kTxtBufferSize

Size (number of bytes) of TXT record buffer.

ot::Utils::SrpClientBuffers::mHostName

char[kHostNameSize]

ot::Utils::SrpClientBuffers::mHostAddresses

Ip6::Address[kMaxHostAddresses]

ot::Utils::SrpClientBuffers::mServicePool

Pool<ServiceEntry, kMaxServices>

Methods

GetHostNameString()

Gets the string buffer to use for SRP client host name.

GetHostAddressesArray()

Gets the array of IPv6 address entries to use as SRP client host address list.

AllocateService()

Allocates a new service entry from the pool. The returned service entry instance will be initialized as follows: - `mService.mName` points to a string buffer which can be retrieved using `GetServiceNameString()`. - `mService.mInstanceName` points to a string buffer which can be retrieved using `GetInstanceNameString()`. - `mService.mSubTypeLabels` points to array which can be retrieved using `GetSubTypeLabelsArray()`. - `mService.mTxtEntries` points to `mTxtEntry`. - `mService.mNumTxtEntries` is set to one (one entry in the list). - Other `mService` fields (port, priority, weight) are set to zero. - `mTxtEntry.mKey` is set to `nullptr` (value is treated as already encoded data). - `mTxtEntry.mValue` points to a buffer which can be retrieved using `GetTxtBuffer()` - `mTxtEntry.mValueLength` is set to zero. - All related data/string buffers and arrays are cleared to all zero.

FreeService()

Frees a previously allocated service entry. The @p aService MUST be previously allocated using `AllocateService()` and not yet freed. Otherwise the behavior of this method is undefined.