Symbols ![]()
loading...
Files ![]()
loading...
ot::Srp::Server::Host class
Implements the Host which registers services on the SRP server.
Syntax
class Host;
enum State : uint8_t
{
kStateDisabled = OT_SRP_SERVER_STATE_DISABLED,
kStateRunning = OT_SRP_SERVER_STATE_RUNNING,
kStateStopped = OT_SRP_SERVER_STATE_STOPPED,
};
class Service : public otSrpServerService,
public LinkedListEntry<Service>,
private Heap::Allocatable<Service>,
private NonCopyable
{
friend class Server;
friend class LinkedList<Service>;
friend class LinkedListEntry<Service>;
friend class Heap::Allocatable<Service>;
friend class AdvertisingProxy;
public:
bool IsDeleted(void) const { return mIsDeleted; }
const char *GetInstanceName(void) const { return mInstanceName.AsCString(); }
const char *GetInstanceLabel(void) const { return mInstanceLabel.AsCString(); }
const char *GetServiceName(void) const { return mServiceName.AsCString(); }
uint16_t GetNumberOfSubTypes(void) const { return mSubTypes.GetLength(); }
const char *GetSubTypeServiceNameAt(uint16_t aIndex) const;
bool HasSubTypeServiceName(const char *aSubTypeServiceName) const;
static Error ParseSubTypeServiceName(const char *aSubTypeServiceName, char *aLabel, uint8_t aLabelSize);
uint32_t GetTtl(void) const { return mTtl; }
uint16_t GetPort(void) const { return mPort; }
uint16_t GetWeight(void) const { return mWeight; }
uint16_t GetPriority(void) const { return mPriority; }
const uint8_t *GetTxtData(void) const { return mTxtData.GetBytes(); }
uint16_t GetTxtDataLength(void) const { return mTxtData.GetLength(); }
const Host &GetHost(void) const { return *mHost; }
uint32_t GetLease(void) const { return mLease; }
uint32_t GetKeyLease(void) const { return mKeyLease; }
TimeMilli GetExpireTime(void) const;
TimeMilli GetKeyExpireTime(void) const;
void GetLeaseInfo(LeaseInfo &aLeaseInfo) const;
bool MatchesInstanceName(const char *aInstanceName) const;
bool MatchesServiceName(const char *aServiceName) const;
private:
enum Action : uint8_t
{
kAddNew,
kUpdateExisting,
kKeepUnchanged,
kRemoveButRetainName,
kFullyRemove,
kLeaseExpired,
kKeyLeaseExpired,
};
Error Init(const char *aInstanceName, const char *aInstanceLabel, Host &aHost, TimeMilli aUpdateTime);
Error SetTxtDataFromMessage(const Message &aMessage, uint16_t aOffset, uint16_t aLength);
bool Matches(const char *aInstanceName) const;
void Log(Action aAction) const;
template <uint16_t kLabelSize>
static Error ParseSubTypeServiceName(const char *aSubTypeServiceName, char (&aLabel)[kLabelSize])
{
return ParseSubTypeServiceName(aSubTypeServiceName, aLabel, kLabelSize);
}
Service *mNext;
Heap::String mInstanceName;
Heap::String mInstanceLabel;
Heap::String mServiceName;
Heap::Array<Heap::String> mSubTypes;
Host *mHost;
Heap::Data mTxtData;
uint16_t mPriority;
uint16_t mWeight;
uint16_t mPort;
uint32_t mTtl;
uint32_t mLease;
uint32_t mKeyLease;
TimeMilli mUpdateTime;
bool mIsDeleted : 1;
bool mIsCommitted : 1;
bool mParsedDeleteAllRrset : 1;
bool mParsedSrv : 1;
bool mParsedTxt : 1;
#if OPENTHREAD_CONFIG_SRP_SERVER_ADVERTISING_PROXY_ENABLE
bool mIsRegistered : 1;
bool mIsKeyRegistered : 1;
bool mIsReplaced : 1;
bool mShouldAdvertise : 1;
bool mShouldRegisterKey : 1;
Dnssd::RequestId mAdvId;
Dnssd::RequestId mKeyAdvId;
#endif
};
class Host : public otSrpServerHost,
public InstanceLocator,
public LinkedListEntry<Host>,
private Heap::Allocatable<Host>,
private NonCopyable;
Implemented in ![]()
srp_server.hpp:430
Fields
Field
Declared as
Heap::Array<Ip6::Address>
uint32_t
uint32_t
uint32_t
Related Functions
Found 14 other functions taking a Host
argument:
Function
Description
Returns the next registered SRP host.
References
Code
Location
Scope
Referrer
Class Tree
ot::Srp::Server::Host is inherited by 3 classess:
Instances
Instance
Scope
Location
Project