Symbols ![]()
loading...
Files ![]()
loading...
otSrpClientService struct
Represents an SRP client service. The values in this structure, including the string buffers for the names and the TXT record entries, MUST persist and stay constant after an instance of this structure is passed to OpenThread from `otSrpClientAddService()` or `otSrpClientRemoveService()`. The `mState`, `mData`, `mNext` fields are used/managed by OT core only. Their value is ignored when an instance of `otSrpClientService` is passed in `otSrpClientAddService()` or `otSrpClientRemoveService()` or other functions. The caller does not need to set these fields. The `mLease` and `mKeyLease` fields specify the desired lease and key lease intervals for this service. Zero value indicates that the interval is unspecified and then the default lease or key lease intervals from `otSrpClientGetLeaseInterval()` and `otSrpClientGetKeyLeaseInterval()` are used for this service. If the key lease interval (whether set explicitly or determined from the default) is shorter than the lease interval for a service, SRP client will re-use the lease interval value for key lease interval as well. For example, if in service `mLease` is explicitly set to 2 days and `mKeyLease` is set to zero and default key lease is set to 1 day, then when registering this service, the requested key lease for this service is also set to 2 days.
Syntax
typedef struct otSrpClientService
{
const char *mName;
const char *mInstanceName;
const char *const *mSubTypeLabels;
const otDnsTxtEntry *mTxtEntries;
uint16_t mPort;
uint16_t mPriority;
uint16_t mWeight;
uint8_t mNumTxtEntries;
otSrpClientItemState mState;
uint32_t mData;
struct otSrpClientService *mNext;
uint32_t mLease;
uint32_t mKeyLease;
} otSrpClientService;
Fields
Field
Declared as
const char *
const char *
const char *const *
uint16_t
uint16_t
uint16_t
uint32_t
uint32_t
uint32_t
Related Functions
Found 8 other functions taking a otSrpClientService
argument:
Function
Description
Adds a service to be registered with server. After a successful call to this function, `otSrpClientCallback` will be called to report the status of the service addition/registration with SRP server. The `otSrpClientService` instance being pointed to by @p aService MUST persist and remain unchanged after returning from this function (with `OT_ERROR_NONE`). OpenThread will save the pointer to the service instance. The `otSrpClientService` instance is not longer tracked by OpenThread and can be reclaimed only when - It is removed explicitly by a call to `otSrpClientRemoveService()` or removed along with other services by a call to `otSrpClientRemoveHostAndServices() and only after the `otSrpClientCallback` is called indicating the service was removed. Or, - A call to `otSrpClientClearHostAndServices()` which removes the host and all related services immediately.
Requests a service to be unregistered with server. After a successful call to this function, `otSrpClientCallback` will be called to report the status of remove request with SRP server. The `otSrpClientService` instance being pointed to by @p aService MUST persist and remain unchanged after returning from this function (with `OT_ERROR_NONE`). OpenThread will keep the service instance during the remove process. Only after the `otSrpClientCallback` is called indicating the service instance is removed from SRP client service list and can be be freed/reused.
Clears a service, immediately removing it from the client service list. Unlike `otSrpClientRemoveService()` which sends an update message to the server to remove the service, this function clears the service from the client's service list without any interaction with the server. On a successful call to this function, the `otSrpClientCallback` will NOT be called and the @p aService entry can be reclaimed and re-used by the caller immediately. Can be used along with a subsequent call to `otSrpClientAddService()` (potentially reusing the same @p aService entry with the same service and instance names) to update some of the parameters in an existing service.