Symbols ![]()
loading...
Files ![]()
loading...
ot::Srp::Client::Service class
Represents an SRP client service.
Syntax
class Service : public otSrpClientService, public LinkedListEntry<Service>
{
friend class Client;
friend class LinkedList<Service>;
public:
Error Init(void);
const char *GetName(void) const { return mName; }
const char *GetInstanceName(void) const { return mInstanceName; }
bool HasSubType(void) const { return (mSubTypeLabels != nullptr); }
const char *GetSubTypeLabelAt(uint16_t aIndex) const { return mSubTypeLabels[aIndex]; }
uint16_t GetPort(void) const { return mPort; }
uint16_t GetPriority(void) const { return mPriority; }
uint16_t GetWeight(void) const { return mWeight; }
const Dns::TxtEntry *GetTxtEntries(void) const { return AsCoreTypePtr(mTxtEntries); }
uint8_t GetNumTxtEntries(void) const { return mNumTxtEntries; }
ItemState GetState(void) const { return static_cast<ItemState>(mState); }
uint32_t GetLease(void) const { return (mLease & kLeaseMask); }
uint32_t GetKeyLease(void) const { return mKeyLease; }
private:
static constexpr uint32_t kAppendedInMsgFlag = (1U << 31);
static constexpr uint32_t kLeaseMask = ~kAppendedInMsgFlag;
bool SetState(ItemState aState);
TimeMilli GetLeaseRenewTime(void) const { return TimeMilli(mData); }
void SetLeaseRenewTime(TimeMilli aTime) { mData = aTime.GetValue(); }
bool IsAppendedInMessage(void) const { return mLease & kAppendedInMsgFlag; }
void MarkAsAppendedInMessage(void) { mLease |= kAppendedInMsgFlag; }
void ClearAppendedInMessageFlag(void) { mLease &= ~kAppendedInMsgFlag; }
bool Matches(const Service &aOther) const;
bool Matches(ItemState aState) const { return GetState() == aState; }
};
Fields
Related Functions
Found 8 other functions taking a Service
argument:
Function
Description
Adds a service to be registered with server. After a successful call to this method, `Callback` will be called to report the status of the service addition/registration with SRP server.
Removes a service to be unregistered with server.
Clears a service, immediately removing it from the client service list. Unlike `RemoveService()` which sends an update message to the server to remove the service, this method clears the service from the client's service list without any interaction with the server. On a successful call to this method, the `Callback` will NOT be called and the @p aService entry can be reclaimed and re-used by the caller immediately.
References
Code
Location
Scope
Referrer
Class Tree
ot::Srp::Client::Service is inherited by 1 classes:
Instances
Instance
Scope
Location
Project