This module includes functions that control SRP client behavior.

Classes

struct  otSrpClientHostInfo
 This structure represents an SRP client host info.
 
struct  otSrpClientService
 This structure represents an SRP client service.
 
struct  otSrpClientBuffersServiceEntry
 This struct represents a SRP client service pool entry.
 
struct  otSrpServerTtlConfig
 This structure includes SRP server TTL configurations.
 
struct  otSrpServerLeaseConfig
 This structure includes SRP server LEASE and KEY-LEASE configurations.
 
struct  otSrpServerLeaseInfo
 This structure includes SRP server lease information of a host/service.
 
struct  otSrpServerResponseCounters
 This structure includes the statistics of SRP server responses.

Typedefs

typedef struct otSrpClientHostInfo otSrpClientHostInfo
 This structure represents an SRP client host info.
 
typedef struct otSrpClientService otSrpClientService
 This structure represents an SRP client service.
 
typedef void(* otSrpClientCallback) (otError aError, const otSrpClientHostInfo *aHostInfo, const otSrpClientService *aServices, const otSrpClientService *aRemovedServices, void *aContext)
 This function pointer type defines the callback used by SRP client to notify user of changes/events/errors.
 
typedef void(* otSrpClientAutoStartCallback) (const otSockAddr *aServerSockAddr, void *aContext)
 This function pointer type defines the callback used by SRP client to notify user when it is auto-started or stopped.
 
typedef struct otSrpClientBuffersServiceEntry otSrpClientBuffersServiceEntry
 This struct represents a SRP client service pool entry.
 
typedef struct otSrpServerHost otSrpServerHost
 This opaque type represents a SRP service host.
 
typedef struct otSrpServerService otSrpServerService
 This opaque type represents a SRP service.
 
typedef uint32_t otSrpServerServiceUpdateId
 The ID of a SRP service update transaction on the SRP Server.
 
typedef uint8_t otSrpServerServiceFlags
 The service flag type to indicate which services to include or exclude when searching in (or iterating over) the list of SRP services.
 
typedef enum otSrpServerAddressMode otSrpServerAddressMode
 This enumeration represents the address mode used by the SRP server.
 
typedef struct otSrpServerTtlConfig otSrpServerTtlConfig
 This structure includes SRP server TTL configurations.
 
typedef struct otSrpServerLeaseConfig otSrpServerLeaseConfig
 This structure includes SRP server LEASE and KEY-LEASE configurations.
 
typedef struct otSrpServerLeaseInfo otSrpServerLeaseInfo
 This structure includes SRP server lease information of a host/service.
 
typedef struct otSrpServerResponseCounters otSrpServerResponseCounters
 This structure includes the statistics of SRP server responses.
 
typedef void(* otSrpServerServiceUpdateHandler) (otSrpServerServiceUpdateId aId, const otSrpServerHost *aHost, uint32_t aTimeout, void *aContext)
 This function handles SRP service updates.

Enumerations

enum  otSrpClientItemState {
  OT_SRP_CLIENT_ITEM_STATE_TO_ADD,
  OT_SRP_CLIENT_ITEM_STATE_ADDING,
  OT_SRP_CLIENT_ITEM_STATE_TO_REFRESH,
  OT_SRP_CLIENT_ITEM_STATE_REFRESHING,
  OT_SRP_CLIENT_ITEM_STATE_TO_REMOVE,
  OT_SRP_CLIENT_ITEM_STATE_REMOVING,
  OT_SRP_CLIENT_ITEM_STATE_REGISTERED,
  OT_SRP_CLIENT_ITEM_STATE_REMOVED
}
 This enumeration specifies an SRP client item (service or host info) state.
 
enum  {
  OT_SRP_SERVER_SERVICE_FLAG_BASE_TYPE = 1 << 0,
  OT_SRP_SERVER_SERVICE_FLAG_SUB_TYPE = 1 << 1,
  OT_SRP_SERVER_SERVICE_FLAG_ACTIVE = 1 << 2,
  OT_SRP_SERVER_SERVICE_FLAG_DELETED = 1 << 3
}
 
enum  {
  OT_SRP_SERVER_FLAGS_ANY_SERVICE,
  OT_SRP_SERVER_FLAGS_BASE_TYPE_SERVICE_ONLY,
  OT_SRP_SERVER_FLAGS_SUB_TYPE_SERVICE_ONLY,
  OT_SRP_SERVER_FLAGS_ANY_TYPE_ACTIVE_SERVICE,
  OT_SRP_SERVER_FLAGS_ANY_TYPE_DELETED_SERVICE
}
 
enum  otSrpServerState {
  OT_SRP_SERVER_STATE_DISABLED = 0,
  OT_SRP_SERVER_STATE_RUNNING = 1,
  OT_SRP_SERVER_STATE_STOPPED = 2
}
 Represents the state of an SRP server.
 
enum  otSrpServerAddressMode {
  OT_SRP_SERVER_ADDRESS_MODE_UNICAST = 0,
  OT_SRP_SERVER_ADDRESS_MODE_ANYCAST = 1
}
 This enumeration represents the address mode used by the SRP server.

Functions

otError otSrpClientStart (otInstance *aInstance, const otSockAddr *aServerSockAddr)
 This function starts the SRP client operation.
 
void otSrpClientStop (otInstance *aInstance)
 This function stops the SRP client operation.
 
bool otSrpClientIsRunning (otInstance *aInstance)
 This function indicates whether the SRP client is running or not.
 
const otSockAddrotSrpClientGetServerAddress (otInstance *aInstance)
 This function gets the socket address (IPv6 address and port number) of the SRP server which is being used by SRP client.
 
void otSrpClientSetCallback (otInstance *aInstance, otSrpClientCallback aCallback, void *aContext)
 This function sets the callback to notify caller of events/changes from SRP client.
 
void otSrpClientEnableAutoStartMode (otInstance *aInstance, otSrpClientAutoStartCallback aCallback, void *aContext)
 This function enables the auto-start mode.
 
void otSrpClientDisableAutoStartMode (otInstance *aInstance)
 This function disables the auto-start mode.
 
bool otSrpClientIsAutoStartModeEnabled (otInstance *aInstance)
 This function indicates the current state of auto-start mode (enabled or disabled).
 
uint32_t otSrpClientGetTtl (otInstance *aInstance)
 This function gets the TTL value in every record included in SRP update requests.
 
void otSrpClientSetTtl (otInstance *aInstance, uint32_t aTtl)
 This function sets the TTL value in every record included in SRP update requests.
 
uint32_t otSrpClientGetLeaseInterval (otInstance *aInstance)
 This function gets the lease interval used in SRP update requests.
 
void otSrpClientSetLeaseInterval (otInstance *aInstance, uint32_t aInterval)
 This function sets the lease interval used in SRP update requests.
 
uint32_t otSrpClientGetKeyLeaseInterval (otInstance *aInstance)
 This function gets the key lease interval used in SRP update requests.
 
void otSrpClientSetKeyLeaseInterval (otInstance *aInstance, uint32_t aInterval)
 This function sets the key lease interval used in SRP update requests.
 
const otSrpClientHostInfootSrpClientGetHostInfo (otInstance *aInstance)
 This function gets the host info.
 
otError otSrpClientSetHostName (otInstance *aInstance, const char *aName)
 This function sets the host name label.
 
otError otSrpClientSetHostAddresses (otInstance *aInstance, const otIp6Address *aIp6Addresses, uint8_t aNumAddresses)
 This function sets/updates the list of host IPv6 address.
 
otError otSrpClientAddService (otInstance *aInstance, otSrpClientService *aService)
 This function adds a service to be registered with server.
 
otError otSrpClientRemoveService (otInstance *aInstance, otSrpClientService *aService)
 This function requests a service to be unregistered with server.
 
otError otSrpClientClearService (otInstance *aInstance, otSrpClientService *aService)
 This function clears a service, immediately removing it from the client service list.
 
const otSrpClientServiceotSrpClientGetServices (otInstance *aInstance)
 This function gets the list of services being managed by client.
 
otError otSrpClientRemoveHostAndServices (otInstance *aInstance, bool aRemoveKeyLease, bool aSendUnregToServer)
 This function starts the remove process of the host info and all services.
 
void otSrpClientClearHostAndServices (otInstance *aInstance)
 This function clears all host info and all the services.
 
const char * otSrpClientGetDomainName (otInstance *aInstance)
 This function gets the domain name being used by SRP client.
 
otError otSrpClientSetDomainName (otInstance *aInstance, const char *aName)
 This function sets the domain name to be used by SRP client.
 
const char * otSrpClientItemStateToString (otSrpClientItemState aItemState)
 This function converts a otSrpClientItemState to a string.
 
void otSrpClientSetServiceKeyRecordEnabled (otInstance *aInstance, bool aEnabled)
 This function enables/disables "service key record inclusion" mode.
 
bool otSrpClientIsServiceKeyRecordEnabled (otInstance *aInstance)
 This method indicates whether the "service key record inclusion" mode is enabled or disabled.
 
char * otSrpClientBuffersGetHostNameString (otInstance *aInstance, uint16_t *aSize)
 This function gets the string buffer to use for SRP client host name.
 
otIp6AddressotSrpClientBuffersGetHostAddressesArray (otInstance *aInstance, uint8_t *aArrayLength)
 This function gets the array of IPv6 address entries to use as SRP client host address list.
 
otSrpClientBuffersServiceEntryotSrpClientBuffersAllocateService (otInstance *aInstance)
 This function allocates a new service entry from the pool.
 
void otSrpClientBuffersFreeService (otInstance *aInstance, otSrpClientBuffersServiceEntry *aService)
 This function frees a previously allocated service entry.
 
void otSrpClientBuffersFreeAllServices (otInstance *aInstance)
 This function frees all previously allocated service entries.
 
char * otSrpClientBuffersGetServiceEntryServiceNameString (otSrpClientBuffersServiceEntry *aEntry, uint16_t *aSize)
 This function gets the string buffer for service name from a service entry.
 
char * otSrpClientBuffersGetServiceEntryInstanceNameString (otSrpClientBuffersServiceEntry *aEntry, uint16_t *aSize)
 This function gets the string buffer for service instance name from a service entry.
 
uint8_t * otSrpClientBuffersGetServiceEntryTxtBuffer (otSrpClientBuffersServiceEntry *aEntry, uint16_t *aSize)
 This function gets the buffer for TXT record from a service entry.
 
const char ** otSrpClientBuffersGetSubTypeLabelsArray (otSrpClientBuffersServiceEntry *aEntry, uint16_t *aArrayLength)
 This function gets the array for service subtype labels from the service entry.
 
const char * otSrpServerGetDomain (otInstance *aInstance)
 This function returns the domain authorized to the SRP server.
 
otError otSrpServerSetDomain (otInstance *aInstance, const char *aDomain)
 This function sets the domain on the SRP server.
 
otSrpServerState otSrpServerGetState (otInstance *aInstance)
 This function returns the state of the SRP server.
 
uint16_t otSrpServerGetPort (otInstance *aInstance)
 This function returns the port the SRP server is listening to.
 
otSrpServerAddressMode otSrpServerGetAddressMode (otInstance *aInstance)
 This function returns the address mode being used by the SRP server.
 
otError otSrpServerSetAddressMode (otInstance *aInstance, otSrpServerAddressMode aMode)
 This function sets the address mode to be used by the SRP server.
 
uint8_t otSrpServerGetAnycastModeSequenceNumber (otInstance *aInstance)
 This function returns the sequence number used with anycast address mode.
 
otError otSrpServerSetAnycastModeSequenceNumber (otInstance *aInstance, uint8_t aSequenceNumber)
 This function sets the sequence number used with anycast address mode.
 
void otSrpServerSetEnabled (otInstance *aInstance, bool aEnabled)
 This function enables/disables the SRP server.
 
void otSrpServerGetTtlConfig (otInstance *aInstance, otSrpServerTtlConfig *aTtlConfig)
 This function returns SRP server TTL configuration.
 
otError otSrpServerSetTtlConfig (otInstance *aInstance, const otSrpServerTtlConfig *aTtlConfig)
 This function sets SRP server TTL configuration.
 
void otSrpServerGetLeaseConfig (otInstance *aInstance, otSrpServerLeaseConfig *aLeaseConfig)
 This function returns SRP server LEASE and KEY-LEASE configurations.
 
otError otSrpServerSetLeaseConfig (otInstance *aInstance, const otSrpServerLeaseConfig *aLeaseConfig)
 This function sets SRP server LEASE and KEY-LEASE configurations.
 
void otSrpServerSetServiceUpdateHandler (otInstance *aInstance, otSrpServerServiceUpdateHandler aServiceHandler, void *aContext)
 This function sets the SRP service updates handler on SRP server.
 
void otSrpServerHandleServiceUpdateResult (otInstance *aInstance, otSrpServerServiceUpdateId aId, otError aError)
 This function reports the result of processing a SRP update to the SRP server.
 
const otSrpServerHostotSrpServerGetNextHost (otInstance *aInstance, const otSrpServerHost *aHost)
 This function returns the next registered host on the SRP server.
 
const otSrpServerResponseCountersotSrpServerGetResponseCounters (otInstance *aInstance)
 This function returns the response counters of the SRP server.
 
bool otSrpServerHostIsDeleted (const otSrpServerHost *aHost)
 This function tells if the SRP service host has been deleted.
 
const char * otSrpServerHostGetFullName (const otSrpServerHost *aHost)
 This function returns the full name of the host.
 
const otIp6AddressotSrpServerHostGetAddresses (const otSrpServerHost *aHost, uint8_t *aAddressesNum)
 This function returns the addresses of given host.
 
void otSrpServerHostGetLeaseInfo (const otSrpServerHost *aHost, otSrpServerLeaseInfo *aLeaseInfo)
 This function returns the LEASE and KEY-LEASE information of a given host.
 
const otSrpServerServiceotSrpServerHostGetNextService (const otSrpServerHost *aHost, const otSrpServerService *aService)
 This function returns the next service (excluding any sub-type services) of given host.
 
const otSrpServerServiceotSrpServerHostFindNextService (const otSrpServerHost *aHost, const otSrpServerService *aPrevService, otSrpServerServiceFlags aFlags, const char *aServiceName, const char *aInstanceName)
 This function finds the next matching service on the host.
 
bool otSrpServerServiceIsDeleted (const otSrpServerService *aService)
 This function indicates whether or not the SRP service has been deleted.
 
bool otSrpServerServiceIsSubType (const otSrpServerService *aService)
 This function indicates whether or not the SRP service is sub-type.
 
const char * otSrpServerServiceGetFullName (const otSrpServerService *aService)
 This function returns the full service instance name of the service.
 
const char * otSrpServerServiceGetInstanceName (const otSrpServerService *aService)
 This function returns the full service instance name of the service.
 
const char * otSrpServerServiceGetServiceName (const otSrpServerService *aService)
 This function returns the full service name of the service.
 
otError otSrpServerServiceGetServiceSubTypeLabel (const otSrpServerService *aService, char *aLabel, uint8_t aMaxSize)
 This function gets the sub-type label from service name.
 
uint16_t otSrpServerServiceGetPort (const otSrpServerService *aService)
 This function returns the port of the service instance.
 
uint16_t otSrpServerServiceGetWeight (const otSrpServerService *aService)
 This function returns the weight of the service instance.
 
uint16_t otSrpServerServiceGetPriority (const otSrpServerService *aService)
 This function returns the priority of the service instance.
 
uint32_t otSrpServerServiceGetTtl (const otSrpServerService *aService)
 This function returns the TTL of the service instance.
 
const uint8_t * otSrpServerServiceGetTxtData (const otSrpServerService *aService, uint16_t *aDataLength)
 This function returns the TXT record data of the service instance.
 
const otSrpServerHostotSrpServerServiceGetHost (const otSrpServerService *aService)
 This function returns the host which the service instance reside on.
 
void otSrpServerServiceGetLeaseInfo (const otSrpServerService *aService, otSrpServerLeaseInfo *aLeaseInfo)
 This function returns the LEASE and KEY-LEASE information of a given service.

Detailed Description

This module includes functions that control SRP client behavior.

This module includes functions of the Service Registration Protocol.

This module includes functions for SRP client buffers and service pool.

Functions in this module are only available when feature OPENTHREAD_CONFIG_SRP_CLIENT_BUFFERS_ENABLE is enabled.

Typedef Documentation

◆ otSrpClientAutoStartCallback

typedef void(* otSrpClientAutoStartCallback) (const otSockAddr *aServerSockAddr, void *aContext)

This function pointer type defines the callback used by SRP client to notify user when it is auto-started or stopped.

This is only used when auto-start feature OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE is enabled.

This callback is invoked when auto-start mode is enabled and the SRP client is either automatically started or stopped.

Parameters
[in]aServerSockAddrA non-NULL pointer indicates SRP server was started and pointer will give the selected server socket address. A NULL pointer indicates SRP server was stopped.
[in]aContextA pointer to an arbitrary context (provided when callback was registered).

◆ otSrpClientCallback

typedef void(* otSrpClientCallback) (otError aError, const otSrpClientHostInfo *aHostInfo, const otSrpClientService *aServices, const otSrpClientService *aRemovedServices, void *aContext)

This function pointer type defines the callback used by SRP client to notify user of changes/events/errors.

This callback is invoked on a successful registration of an update (i.e., add/remove of host-info and/or some service(s)) with the SRP server, or if there is a failure or error (e.g., server rejects a update request or client times out waiting for response, etc).

In case of a successful reregistration of an update, aError parameter would be OT_ERROR_NONE and the host info and the full list of services is provided as input parameters to the callback. Note that host info and services each track its own state in the corresponding mState member variable of the related data structure (the state indicating whether the host-info/service is registered or removed or still being added/removed, etc).

The list of removed services is passed as its own linked-list aRemovedServices in the callback. Note that when the callback is invoked, the SRP client (OpenThread implementation) is done with the removed service instances listed in aRemovedServices and no longer tracks/stores them (i.e., if from the callback we call otSrpClientGetServices() the removed services will not be present in the returned list). Providing a separate list of removed services in the callback helps indicate to user which items are now removed and allow user to re-claim/reuse the instances.

If the server rejects an SRP update request, the DNS response code (RFC 2136) is mapped to the following errors:

  • (0) NOERROR Success (no error condition) -> OT_ERROR_NONE
  • (1) FORMERR Server unable to interpret due to format error -> OT_ERROR_PARSE
  • (2) SERVFAIL Server encountered an internal failure -> OT_ERROR_FAILED
  • (3) NXDOMAIN Name that ought to exist, does not exist -> OT_ERROR_NOT_FOUND
  • (4) NOTIMP Server does not support the query type (OpCode) -> OT_ERROR_NOT_IMPLEMENTED
  • (5) REFUSED Server refused for policy/security reasons -> OT_ERROR_SECURITY
  • (6) YXDOMAIN Some name that ought not to exist, does exist -> OT_ERROR_DUPLICATED
  • (7) YXRRSET Some RRset that ought not to exist, does exist -> OT_ERROR_DUPLICATED
  • (8) NXRRSET Some RRset that ought to exist, does not exist -> OT_ERROR_NOT_FOUND
  • (9) NOTAUTH Service is not authoritative for zone -> OT_ERROR_SECURITY
  • (10) NOTZONE A name is not in the zone -> OT_ERROR_PARSE
  • (20) BADNAME Bad name -> OT_ERROR_PARSE
  • (21) BADALG Bad algorithm -> OT_ERROR_SECURITY
  • (22) BADTRUN Bad truncation -> OT_ERROR_PARSE
  • Other response codes -> OT_ERROR_FAILED

The following errors are also possible:

  • OT_ERROR_RESPONSE_TIMEOUT : Timed out waiting for response from server (client would continue to retry).
  • OT_ERROR_INVALID_ARGS : The provided service structure is invalid (e.g., bad service name or otDnsTxtEntry).
  • OT_ERROR_NO_BUFS : Insufficient buffer to prepare or send the update message.

Note that in case of any failure, the client continues the operation, i.e. it prepares and (re)transmits the SRP update message to the server, after some wait interval. The retry wait interval starts from the minimum value and is increased by the growth factor every failure up to the max value (please see configuration parameter OPENTHREAD_CONFIG_SRP_CLIENT_MIN_RETRY_WAIT_INTERVAL and the related ones for more details).

Parameters
[in]aErrorThe error (see above).
[in]aHostInfoA pointer to host info.
[in]aServicesThe head of linked-list containing all services (excluding the ones removed). NULL if the list is empty.
[in]aRemovedServicesThe head of linked-list containing all removed services. NULL if the list is empty.
[in]aContextA pointer to an arbitrary context (provided when callback was registered).

◆ otSrpClientService

This structure 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().

◆ otSrpServerAddressMode

This enumeration represents the address mode used by the SRP server.

Address mode specifies how the address and port number are determined by the SRP server and how this info is published in the Thread Network Data.

◆ otSrpServerServiceFlags

typedef uint8_t otSrpServerServiceFlags

The service flag type to indicate which services to include or exclude when searching in (or iterating over) the list of SRP services.

This is a combination of bit-flags. The specific bit-flags are defined in the enumeration OT_SRP_SERVER_FLAG_*.

◆ otSrpServerServiceUpdateHandler

typedef void(* otSrpServerServiceUpdateHandler) (otSrpServerServiceUpdateId aId, const otSrpServerHost *aHost, uint32_t aTimeout, void *aContext)

This function handles SRP service updates.

This function is called by the SRP server to notify that a SRP host and possibly SRP services are being updated. It is important that the SRP updates are not committed until the handler returns the result by calling otSrpServerHandleServiceUpdateResult or times out after aTimeout.

A SRP service observer should always call otSrpServerHandleServiceUpdateResult with error code OT_ERROR_NONE immediately after receiving the update events.

A more generic handler may perform validations on the SRP host/services and rejects the SRP updates if any validation fails. For example, an Advertising Proxy should advertise (or remove) the host and services on a multicast-capable link and returns specific error code if any failure occurs.

Parameters
[in]aIdThe service update transaction ID. This ID must be passed back with otSrpServerHandleServiceUpdateResult.
[in]aHostA pointer to the otSrpServerHost object which contains the SRP updates. The handler should publish/un-publish the host and each service points to this host with below rules:
  1. If the host is not deleted (indicated by otSrpServerHostIsDeleted), then it should be published or updated with mDNS. Otherwise, the host should be un-published (remove AAAA RRs).
  2. For each service points to this host, it must be un-published if the host is to be un-published. Otherwise, the handler should publish or update the service when it is not deleted (indicated by otSrpServerServiceIsDeleted) and un-publish it when deleted.
[in]aTimeoutThe maximum time in milliseconds for the handler to process the service event.
[in]aContextA pointer to application-specific context.
See also
otSrpServerSetServiceUpdateHandler
otSrpServerHandleServiceUpdateResult

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
OT_SRP_SERVER_SERVICE_FLAG_BASE_TYPE 

Include base services (not a sub-type).

OT_SRP_SERVER_SERVICE_FLAG_SUB_TYPE 

Include sub-type services.

OT_SRP_SERVER_SERVICE_FLAG_ACTIVE 

Include active (not deleted) services.

OT_SRP_SERVER_SERVICE_FLAG_DELETED 

Include deleted services.

◆ anonymous enum

anonymous enum
Enumerator
OT_SRP_SERVER_FLAGS_ANY_SERVICE 

This constant defines an otSrpServerServiceFlags combination accepting any service (base/sub-type, active/deleted).

OT_SRP_SERVER_FLAGS_BASE_TYPE_SERVICE_ONLY 

This constant defines an otSrpServerServiceFlags combination accepting base service only.

OT_SRP_SERVER_FLAGS_SUB_TYPE_SERVICE_ONLY 

This constant defines an otSrpServerServiceFlags combination accepting sub-type service only.

OT_SRP_SERVER_FLAGS_ANY_TYPE_ACTIVE_SERVICE 

This constant defines an otSrpServerServiceFlags combination accepting any active service (not deleted).

OT_SRP_SERVER_FLAGS_ANY_TYPE_DELETED_SERVICE 

This constant defines an otSrpServerServiceFlags combination accepting any deleted service.

◆ otSrpClientItemState

This enumeration specifies an SRP client item (service or host info) state.

Enumerator
OT_SRP_CLIENT_ITEM_STATE_TO_ADD 

Item to be added/registered.

OT_SRP_CLIENT_ITEM_STATE_ADDING 

Item is being added/registered.

OT_SRP_CLIENT_ITEM_STATE_TO_REFRESH 

Item to be refreshed (re-register to renew lease).

OT_SRP_CLIENT_ITEM_STATE_REFRESHING 

Item is being refreshed.

OT_SRP_CLIENT_ITEM_STATE_TO_REMOVE 

Item to be removed.

OT_SRP_CLIENT_ITEM_STATE_REMOVING 

Item is being removed.

OT_SRP_CLIENT_ITEM_STATE_REGISTERED 

Item is registered with server.

OT_SRP_CLIENT_ITEM_STATE_REMOVED 

Item is removed.

◆ otSrpServerAddressMode

This enumeration represents the address mode used by the SRP server.

Address mode specifies how the address and port number are determined by the SRP server and how this info is published in the Thread Network Data.

Enumerator
OT_SRP_SERVER_ADDRESS_MODE_UNICAST 

Unicast address mode.

OT_SRP_SERVER_ADDRESS_MODE_ANYCAST 

Anycast address mode.

◆ otSrpServerState

Represents the state of an SRP server.

Enumerator
OT_SRP_SERVER_STATE_DISABLED 

The SRP server is disabled.

OT_SRP_SERVER_STATE_RUNNING 

The SRP server is running.

OT_SRP_SERVER_STATE_STOPPED 

The SRP server is stopped.

Function Documentation

◆ otSrpClientAddService()

otError otSrpClientAddService ( otInstance aInstance,
otSrpClientService aService 
)

This function 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 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

Parameters
[in]aInstanceA pointer to the OpenThread instance.
[in]aServiceA pointer to a otSrpClientService instance to add.
Return values
OT_ERROR_NONEThe addition of service started successfully. The otSrpClientCallback will be called to report the status.
OT_ERROR_ALREADYA service with the same service and instance names is already in the list.
OT_ERROR_INVALID_ARGSThe service structure is invalid (e.g., bad service name or otDnsTxtEntry).

◆ otSrpClientBuffersAllocateService()

otSrpClientBuffersServiceEntry* otSrpClientBuffersAllocateService ( otInstance aInstance)

This function allocates a new service entry from the pool.

The returned service entry instance will be initialized as follows:

Parameters
[in]aInstanceA pointer to the OpenThread instance.
Returns
A pointer to the newly allocated service entry or NULL if not more entry available in the pool.

◆ otSrpClientBuffersFreeAllServices()

void otSrpClientBuffersFreeAllServices ( otInstance aInstance)

This function frees all previously allocated service entries.

Parameters
[in]aInstanceA pointer to the OpenThread instance.

◆ otSrpClientBuffersFreeService()

void otSrpClientBuffersFreeService ( otInstance aInstance,
otSrpClientBuffersServiceEntry aService 
)

This function frees a previously allocated service entry.

The aService MUST be previously allocated using otSrpClientBuffersAllocateService() and not yet freed. Otherwise the behavior of this function is undefined.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
[in]aServiceA pointer to the service entry to free (MUST NOT be NULL).

◆ otSrpClientBuffersGetHostAddressesArray()

otIp6Address* otSrpClientBuffersGetHostAddressesArray ( otInstance aInstance,
uint8_t *  aArrayLength 
)

This function gets the array of IPv6 address entries to use as SRP client host address list.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
[out]aArrayLengthPointer to a variable to return the array length i.e., number of IPv6 address entries in the array (MUST NOT be NULL).
Returns
A pointer to an array of otIp6Address entries (number of entries is returned in aArrayLength).

◆ otSrpClientBuffersGetHostNameString()

char* otSrpClientBuffersGetHostNameString ( otInstance aInstance,
uint16_t *  aSize 
)

This function gets the string buffer to use for SRP client host name.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
[out]aSizePointer to a variable to return the size (number of bytes) of the string buffer (MUST NOT be NULL).
Returns
A pointer to char buffer to use for SRP client host name.

◆ otSrpClientBuffersGetServiceEntryInstanceNameString()

char* otSrpClientBuffersGetServiceEntryInstanceNameString ( otSrpClientBuffersServiceEntry aEntry,
uint16_t *  aSize 
)

This function gets the string buffer for service instance name from a service entry.

Parameters
[in]aEntryA pointer to a previously allocated service entry (MUST NOT be NULL).
[out]aSizeA pointer to a variable to return the size (number of bytes) of the string buffer (MUST NOT be NULL).
Returns
A pointer to the string buffer.

◆ otSrpClientBuffersGetServiceEntryServiceNameString()

char* otSrpClientBuffersGetServiceEntryServiceNameString ( otSrpClientBuffersServiceEntry aEntry,
uint16_t *  aSize 
)

This function gets the string buffer for service name from a service entry.

Parameters
[in]aEntryA pointer to a previously allocated service entry (MUST NOT be NULL).
[out]aSizeA pointer to a variable to return the size (number of bytes) of the string buffer (MUST NOT be NULL).
Returns
A pointer to the string buffer.

◆ otSrpClientBuffersGetServiceEntryTxtBuffer()

uint8_t* otSrpClientBuffersGetServiceEntryTxtBuffer ( otSrpClientBuffersServiceEntry aEntry,
uint16_t *  aSize 
)

This function gets the buffer for TXT record from a service entry.

Parameters
[in]aEntryA pointer to a previously allocated service entry (MUST NOT be NULL).
[out]aSizeA pointer to a variable to return the size (number of bytes) of the buffer (MUST NOT be NULL).
Returns
A pointer to the buffer.

◆ otSrpClientBuffersGetSubTypeLabelsArray()

const char** otSrpClientBuffersGetSubTypeLabelsArray ( otSrpClientBuffersServiceEntry aEntry,
uint16_t *  aArrayLength 
)

This function gets the array for service subtype labels from the service entry.

Parameters
[in]aEntryA pointer to a previously allocated service entry (MUST NOT be NULL).
[out]aArrayLengthA pointer to a variable to return the array length (MUST NOT be NULL).
Returns
A pointer to the array.

◆ otSrpClientClearHostAndServices()

void otSrpClientClearHostAndServices ( otInstance aInstance)

This function clears all host info and all the services.

Unlike otSrpClientRemoveHostAndServices() which sends an update message to the server to remove all the info, this function clears all the info immediately without any interaction with the server.

Parameters
[in]aInstanceA pointer to the OpenThread instance.

◆ otSrpClientClearService()

otError otSrpClientClearService ( otInstance aInstance,
otSrpClientService aService 
)

This function 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 aService entry can be reclaimed and re-used by the caller immediately.

This function can be used along with a subsequent call to otSrpClientAddService() (potentially reusing the same aService entry with the same service and instance names) to update some of the parameters in an existing service.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
[in]aServiceA pointer to a otSrpClientService instance to delete.
Return values
OT_ERROR_NONEThe aService is deleted successfully. It can be reclaimed and re-used immediately.
OT_ERROR_NOT_FOUNDThe service could not be found in the list.

◆ otSrpClientDisableAutoStartMode()

void otSrpClientDisableAutoStartMode ( otInstance aInstance)

This function disables the auto-start mode.

This is only available when auto-start feature OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE is enabled.

Disabling the auto-start mode will not stop the client if it is already running but the client stops monitoring the Thread Network Data to verify that the selected SRP server is still present in it.

Note that a call to otSrpClientStop() will also disable the auto-start mode.

Parameters
[in]aInstanceA pointer to the OpenThread instance.

◆ otSrpClientEnableAutoStartMode()

void otSrpClientEnableAutoStartMode ( otInstance aInstance,
otSrpClientAutoStartCallback  aCallback,
void *  aContext 
)

This function enables the auto-start mode.

This is only available when auto-start feature OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE is enabled.

Config option OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_DEFAULT_MODE specifies the default auto-start mode (whether it is enabled or disabled at the start of OT stack).

When auto-start is enabled, the SRP client will monitor the Thread Network Data for SRP Server Service entries and automatically start and stop the client when an SRP server is detected.

If multiple SRP servers are found, a random one will be selected. If the selected SRP server is no longer detected (not longer present in the Thread Network Data), the SRP client will be stopped and then it may switch to another SRP server (if available).

When the SRP client is explicitly started through a successful call to otSrpClientStart(), the given SRP server address in otSrpClientStart() will continue to be used regardless of the state of auto-start mode and whether the same SRP server address is discovered or not in the Thread Network Data. In this case, only an explicit otSrpClientStop() call will stop the client.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
[in]aCallbackA callback to notify when client is auto-started/stopped. Can be NULL if not needed.
[in]aContextA context to be passed when invoking aCallback.

◆ otSrpClientGetDomainName()

const char* otSrpClientGetDomainName ( otInstance aInstance)

This function gets the domain name being used by SRP client.

This function requires OPENTHREAD_CONFIG_SRP_CLIENT_DOMAIN_NAME_API_ENABLE to be enabled.

If domain name is not set, "default.service.arpa" will be used.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
Returns
The domain name string.

◆ otSrpClientGetHostInfo()

const otSrpClientHostInfo* otSrpClientGetHostInfo ( otInstance aInstance)

This function gets the host info.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
Returns
A pointer to host info structure.

◆ otSrpClientGetKeyLeaseInterval()

uint32_t otSrpClientGetKeyLeaseInterval ( otInstance aInstance)

This function gets the key lease interval used in SRP update requests.

Note that this is the lease duration requested by the SRP client. The server may choose to accept a different lease interval.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
Returns
The key lease interval (in seconds).

◆ otSrpClientGetLeaseInterval()

uint32_t otSrpClientGetLeaseInterval ( otInstance aInstance)

This function gets the lease interval used in SRP update requests.

Note that this is the lease duration requested by the SRP client. The server may choose to accept a different lease interval.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
Returns
The lease interval (in seconds).

◆ otSrpClientGetServerAddress()

const otSockAddr* otSrpClientGetServerAddress ( otInstance aInstance)

This function gets the socket address (IPv6 address and port number) of the SRP server which is being used by SRP client.

If the client is not running, the address is unspecified (all zero) with zero port number.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
Returns
A pointer to the SRP server's socket address (is always non-NULL).

◆ otSrpClientGetServices()

const otSrpClientService* otSrpClientGetServices ( otInstance aInstance)

This function gets the list of services being managed by client.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
Returns
A pointer to the head of linked-list of all services or NULL if the list is empty.

◆ otSrpClientGetTtl()

uint32_t otSrpClientGetTtl ( otInstance aInstance)

This function gets the TTL value in every record included in SRP update requests.

Note that this is the TTL requested by the SRP client. The server may choose to accept a different TTL.

By default, the TTL will equal the lease interval. Passing 0 or a value larger than the lease interval via otSrpClientSetTtl() will also cause the TTL to equal the lease interval.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
Returns
The TTL (in seconds).

◆ otSrpClientIsAutoStartModeEnabled()

bool otSrpClientIsAutoStartModeEnabled ( otInstance aInstance)

This function indicates the current state of auto-start mode (enabled or disabled).

This is only available when auto-start feature OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE is enabled.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
Returns
TRUE if the auto-start mode is enabled, FALSE otherwise.

◆ otSrpClientIsRunning()

bool otSrpClientIsRunning ( otInstance aInstance)

This function indicates whether the SRP client is running or not.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
Returns
TRUE if the SRP client is running, FALSE otherwise.

◆ otSrpClientIsServiceKeyRecordEnabled()

bool otSrpClientIsServiceKeyRecordEnabled ( otInstance aInstance)

This method indicates whether the "service key record inclusion" mode is enabled or disabled.

This function is available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE configuration is enabled.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
Returns
TRUE if "service key record inclusion" mode is enabled, FALSE otherwise.

◆ otSrpClientItemStateToString()

const char* otSrpClientItemStateToString ( otSrpClientItemState  aItemState)

This function converts a otSrpClientItemState to a string.

Parameters
[in]aItemStateAn item state.
Returns
A string representation of aItemState.

◆ otSrpClientRemoveHostAndServices()

otError otSrpClientRemoveHostAndServices ( otInstance aInstance,
bool  aRemoveKeyLease,
bool  aSendUnregToServer 
)

This function starts the remove process of the host info and all services.

After returning from this function, otSrpClientCallback will be called to report the status of remove request with SRP server.

If the host info is to be permanently removed from server, aRemoveKeyLease should be set to true which removes the key lease associated with host on server. Otherwise, the key lease record is kept as before, which ensures that the server holds the host name in reserve for when the client is once again able to provide and register its service(s).

The aSendUnregToServer determines the behavior when the host info is not yet registered with the server. If aSendUnregToServer is set to false (which is the default/expected value) then the SRP client will immediately remove the host info and services without sending an update message to server (no need to update the server if nothing is yet registered with it). If aSendUnregToServer is set to true then the SRP client will send an update message to the server. Note that if the host info is registered then the value of aSendUnregToServer does not matter and the SRP client will always send an update message to server requesting removal of all info.

One situation where aSendUnregToServer can be useful is on a device reset/reboot, caller may want to remove any previously registered services with the server. In this case, caller can otSrpClientSetHostName() and then request otSrpClientRemoveHostAndServices() with aSendUnregToServer as true.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
[in]aRemoveKeyLeaseA boolean indicating whether or not the host key lease should also be removed.
[in]aSendUnregToServerA boolean indicating whether to send update to server when host info is not registered.
Return values
OT_ERROR_NONEThe removal of host info and services started successfully. The otSrpClientCallback will be called to report the status.
OT_ERROR_ALREADYThe host info is already removed.

◆ otSrpClientRemoveService()

otError otSrpClientRemoveService ( otInstance aInstance,
otSrpClientService aService 
)

This function 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 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.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
[in]aServiceA pointer to a otSrpClientService instance to remove.
Return values
OT_ERROR_NONEThe removal of service started successfully. The otSrpClientCallback will be called to report the status.
OT_ERROR_NOT_FOUNDThe service could not be found in the list.

◆ otSrpClientSetCallback()

void otSrpClientSetCallback ( otInstance aInstance,
otSrpClientCallback  aCallback,
void *  aContext 
)

This function sets the callback to notify caller of events/changes from SRP client.

The SRP client allows a single callback to be registered. So consecutive calls to this function will overwrite any previously set callback functions.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
[in]aCallbackThe callback to notify of events and changes. Can be NULL if not needed.
[in]aContextAn arbitrary context used with aCallback.

◆ otSrpClientSetDomainName()

otError otSrpClientSetDomainName ( otInstance aInstance,
const char *  aName 
)

This function sets the domain name to be used by SRP client.

This function requires OPENTHREAD_CONFIG_SRP_CLIENT_DOMAIN_NAME_API_ENABLE to be enabled.

If not set "default.service.arpa" will be used.

The name string buffer pointed to by aName MUST persist and stay unchanged after returning from this function. OpenThread will keep the pointer to the string.

The domain name can be set before client is started or after start but before host info is registered with server (host info should be in either STATE_TO_ADD or STATE_TO_REMOVE).

Parameters
[in]aInstanceA pointer to the OpenThread instance.
[in]aNameA pointer to the domain name string. If NULL sets it to default "default.service.arpa".
Return values
OT_ERROR_NONEThe domain name label was set successfully.
OT_ERROR_INVALID_STATEThe host info is already registered with server.

◆ otSrpClientSetHostAddresses()

otError otSrpClientSetHostAddresses ( otInstance aInstance,
const otIp6Address aIp6Addresses,
uint8_t  aNumAddresses 
)

This function sets/updates the list of host IPv6 address.

Host IPv6 addresses can be set/changed before start or during operation of SRP client (e.g. to add/remove or change a previously registered host address), except when the host info is being removed (client is busy handling a remove request from an earlier call to otSrpClientRemoveHostAndServices() and host info still being in either STATE_TO_REMOVE or STATE_REMOVING states).

The host IPv6 address array pointed to by aIp6Addresses MUST persist and remain unchanged after returning from this function (with OT_ERROR_NONE). OpenThread will save the pointer to the array.

After a successful call to this function, otSrpClientCallback will be called to report the status of the address registration with SRP server.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
[in]aIp6AddressesA pointer to the an array containing the host IPv6 addresses.
[in]aNumAddressesThe number of addresses in the aIp6Addresses array.
Return values
OT_ERROR_NONEThe host IPv6 address list change started successfully. The otSrpClientCallback will be called to report the status of registering addresses with server.
OT_ERROR_INVALID_ARGSThe address list is invalid (e.g., must contain at least one address).
OT_ERROR_INVALID_STATEHost is being removed and therefore cannot change host address.

◆ otSrpClientSetHostName()

otError otSrpClientSetHostName ( otInstance aInstance,
const char *  aName 
)

This function sets the host name label.

After a successful call to this function, otSrpClientCallback will be called to report the status of host info registration with SRP server.

The name string buffer pointed to by aName MUST persist and stay unchanged after returning from this function. OpenThread will keep the pointer to the string.

The host name can be set before client is started or after start but before host info is registered with server (host info should be in either STATE_TO_ADD or STATE_REMOVED).

Parameters
[in]aInstanceA pointer to the OpenThread instance.
[in]aNameA pointer to host name label string (MUST NOT be NULL). Pointer to the string buffer MUST persist and remain valid and constant after return from this function.
Return values
OT_ERROR_NONEThe host name label was set successfully.
OT_ERROR_INVALID_ARGSThe aName is NULL.
OT_ERROR_INVALID_STATEThe host name is already set and registered with the server.

◆ otSrpClientSetKeyLeaseInterval()

void otSrpClientSetKeyLeaseInterval ( otInstance aInstance,
uint32_t  aInterval 
)

This function sets the key lease interval used in SRP update requests.

Changing the lease interval does not impact the accepted lease interval of already registered services/host-info. It only affects any future SRP update messages (i.e., adding new services and/or refreshes of existing services).

Parameters
[in]aInstanceA pointer to the OpenThread instance.
[in]aIntervalThe key lease interval (in seconds). If zero, the default value specified by OPENTHREAD_CONFIG_SRP_CLIENT_DEFAULT_KEY_LEASE would be used.

◆ otSrpClientSetLeaseInterval()

void otSrpClientSetLeaseInterval ( otInstance aInstance,
uint32_t  aInterval 
)

This function sets the lease interval used in SRP update requests.

Changing the lease interval does not impact the accepted lease interval of already registered services/host-info. It only affects any future SRP update messages (i.e., adding new services and/or refreshes of the existing services).

Parameters
[in]aInstanceA pointer to the OpenThread instance.
[in]aIntervalThe lease interval (in seconds). If zero, the default value specified by OPENTHREAD_CONFIG_SRP_CLIENT_DEFAULT_LEASE would be used.

◆ otSrpClientSetServiceKeyRecordEnabled()

void otSrpClientSetServiceKeyRecordEnabled ( otInstance aInstance,
bool  aEnabled 
)

This function enables/disables "service key record inclusion" mode.

When enabled, SRP client will include KEY record in Service Description Instructions in the SRP update messages that it sends.

This function is available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE configuration is enabled.

Note
KEY record is optional in Service Description Instruction (it is required and always included in the Host Description Instruction). The default behavior of SRP client is to not include it. This function is intended to override the default behavior for testing only.
Parameters
[in]aInstanceA pointer to the OpenThread instance.
[in]aEnabledTRUE to enable, FALSE to disable the "service key record inclusion" mode.

◆ otSrpClientSetTtl()

void otSrpClientSetTtl ( otInstance aInstance,
uint32_t  aTtl 
)

This function sets the TTL value in every record included in SRP update requests.

Changing the TTL does not impact the TTL of already registered services/host-info. It only affects future SRP update messages (i.e., adding new services and/or refreshes of the existing services).

Parameters
[in]aInstanceA pointer to the OpenThread instance.
[in]aTtlThe TTL (in seconds). If value is zero or greater than lease interval, the TTL is set to the lease interval.

◆ otSrpClientStart()

otError otSrpClientStart ( otInstance aInstance,
const otSockAddr aServerSockAddr 
)

This function starts the SRP client operation.

SRP client will prepare and send "SRP Update" message to the SRP server once all the following conditions are met:

It does not matter in which order these functions are called. When all conditions are met, the SRP client will wait for a short delay before preparing an "SRP Update" message and sending it to server. This delay allows for user to add multiple services and/or IPv6 addresses before the first SRP Update message is sent (ensuring a single SRP Update is sent containing all the info). The config OPENTHREAD_CONFIG_SRP_CLIENT_UPDATE_TX_DELAY specifies the delay interval.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
[in]aServerSockAddrThe socket address (IPv6 address and port number) of the SRP server.
Return values
OT_ERROR_NONESRP client operation started successfully or it is already running with same server socket address and callback.
OT_ERROR_BUSYSRP client is busy running with a different socket address.
OT_ERROR_FAILEDFailed to open/connect the client's UDP socket.

◆ otSrpClientStop()

void otSrpClientStop ( otInstance aInstance)

This function stops the SRP client operation.

This function stops any further interactions with the SRP server. Note that it does not remove or clear host info and/or list of services. It marks all services to be added/removed again once the client is (re)started.

Parameters
[in]aInstanceA pointer to the OpenThread instance.

◆ otSrpServerGetAddressMode()

otSrpServerAddressMode otSrpServerGetAddressMode ( otInstance aInstance)

This function returns the address mode being used by the SRP server.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
Returns
The SRP server's address mode.

◆ otSrpServerGetAnycastModeSequenceNumber()

uint8_t otSrpServerGetAnycastModeSequenceNumber ( otInstance aInstance)

This function returns the sequence number used with anycast address mode.

The sequence number is included in "DNS/SRP Service Anycast Address" entry published in the Network Data.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
Returns
The anycast sequence number.

◆ otSrpServerGetDomain()

const char* otSrpServerGetDomain ( otInstance aInstance)

This function returns the domain authorized to the SRP server.

If the domain if not set by SetDomain, "default.service.arpa." will be returned. A trailing dot is always appended even if the domain is set without it.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
Returns
A pointer to the dot-joined domain string.

◆ otSrpServerGetLeaseConfig()

void otSrpServerGetLeaseConfig ( otInstance aInstance,
otSrpServerLeaseConfig aLeaseConfig 
)

This function returns SRP server LEASE and KEY-LEASE configurations.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[out]aLeaseConfigA pointer to an otSrpServerLeaseConfig instance.

◆ otSrpServerGetNextHost()

const otSrpServerHost* otSrpServerGetNextHost ( otInstance aInstance,
const otSrpServerHost aHost 
)

This function returns the next registered host on the SRP server.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[in]aHostA pointer to current host; use NULL to get the first host.
Returns
A pointer to the registered host. NULL, if no more hosts can be found.

◆ otSrpServerGetPort()

uint16_t otSrpServerGetPort ( otInstance aInstance)

This function returns the port the SRP server is listening to.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
Returns
The port of the SRP server. It returns 0 if the server is not running.

◆ otSrpServerGetResponseCounters()

const otSrpServerResponseCounters* otSrpServerGetResponseCounters ( otInstance aInstance)

This function returns the response counters of the SRP server.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
Returns
A pointer to the response counters of the SRP server.

◆ otSrpServerGetState()

otSrpServerState otSrpServerGetState ( otInstance aInstance)

This function returns the state of the SRP server.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
Returns
The current state of the SRP server.

◆ otSrpServerGetTtlConfig()

void otSrpServerGetTtlConfig ( otInstance aInstance,
otSrpServerTtlConfig aTtlConfig 
)

This function returns SRP server TTL configuration.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[out]aTtlConfigA pointer to an otSrpServerTtlConfig instance.

◆ otSrpServerHandleServiceUpdateResult()

void otSrpServerHandleServiceUpdateResult ( otInstance aInstance,
otSrpServerServiceUpdateId  aId,
otError  aError 
)

This function reports the result of processing a SRP update to the SRP server.

The Service Update Handler should call this function to return the result of its processing of a SRP update.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[in]aIdThe service update transaction ID. This should be the same ID provided via otSrpServerServiceUpdateHandler.
[in]aErrorAn error to be returned to the SRP server. Use OT_ERROR_DUPLICATED to represent DNS name conflicts.

◆ otSrpServerHostFindNextService()

const otSrpServerService* otSrpServerHostFindNextService ( const otSrpServerHost aHost,
const otSrpServerService aPrevService,
otSrpServerServiceFlags  aFlags,
const char *  aServiceName,
const char *  aInstanceName 
)

This function finds the next matching service on the host.

The combination of flags and service and instance names enables iterating over the full list of services and/or a subset of them matching certain conditions, or finding a specific service.

To iterate over all services of a host: service = otSrpServerHostFindNextService(host, service, OT_SRP_SERVER_FLAGS_ANY_SERVICE, NULL, NULL);

To iterate over base services only (exclude sub-types): service = otSrpServerHostFindNextService(host, service, OT_SRP_SERVER_FLAGS_BASE_TYPE_SERVICE_ONLY, NULL, NULL);

To iterate over sub-types of a specific instance name instanceName: service = otSrpServerHostFindNextService(host, service, OT_SRP_SERVER_FLAGS_SUB_TYPE_SERVICE_ONLY, NULL, instanceName);

To find a specific service with service name serviceName and service instance name instanceName: service = otSrpServerHostFindNextService(host, NULL, OT_SRP_SERVER_FLAGS_ANY_SERVICE, serviceName, instanceName);

To find the base type service with a given service instance name instanceName: service = otSrpServerHostFindNextService(host, NULL, OT_SRP_SERVER_FLAGS_BASE_TYPE_SERVICE_ONLY, NULL, instanceName);

Parameters
[in]aHostA pointer to the SRP service host (MUST NOT be NULL).
[in]aPrevServiceA pointer to the previous service or NULL to start from the beginning of the list.
[in]aFlagsFlags indicating which services to include (base/sub-type, active/deleted).
[in]aServiceNameThe service name to match. Set to NULL to accept any name.
[in]aInstanceNameThe service instance name to match. Set to NULL to accept any name.
Returns
A pointer to the next matching service or NULL if no matching service could be found.

◆ otSrpServerHostGetAddresses()

const otIp6Address* otSrpServerHostGetAddresses ( const otSrpServerHost aHost,
uint8_t *  aAddressesNum 
)

This function returns the addresses of given host.

Parameters
[in]aHostA pointer to the SRP service host.
[out]aAddressesNumA pointer to where we should output the number of the addresses to.
Returns
A pointer to the array of IPv6 Address.

◆ otSrpServerHostGetFullName()

const char* otSrpServerHostGetFullName ( const otSrpServerHost aHost)

This function returns the full name of the host.

Parameters
[in]aHostA pointer to the SRP service host.
Returns
A pointer to the null-terminated host name string.

◆ otSrpServerHostGetLeaseInfo()

void otSrpServerHostGetLeaseInfo ( const otSrpServerHost aHost,
otSrpServerLeaseInfo aLeaseInfo 
)

This function returns the LEASE and KEY-LEASE information of a given host.

Parameters
[in]aHostA pointer to the SRP server host.
[out]aLeaseInfoA pointer to where to output the LEASE and KEY-LEASE information.

◆ otSrpServerHostGetNextService()

const otSrpServerService* otSrpServerHostGetNextService ( const otSrpServerHost aHost,
const otSrpServerService aService 
)

This function returns the next service (excluding any sub-type services) of given host.

Note
This function is being deprecated and will be removed. otSrpServerHostFindNextService() can be used instead.
Parameters
[in]aHostA pointer to the SRP service host.
[in]aServiceA pointer to current SRP service instance; use NULL to get the first service.
Returns
A pointer to the next service or NULL if there is no more services.

◆ otSrpServerHostIsDeleted()

bool otSrpServerHostIsDeleted ( const otSrpServerHost aHost)

This function tells if the SRP service host has been deleted.

A SRP service host can be deleted but retains its name for future uses. In this case, the host instance is not removed from the SRP server/registry.

Parameters
[in]aHostA pointer to the SRP service host.
Returns
TRUE if the host has been deleted, FALSE if not.

◆ otSrpServerServiceGetFullName()

const char* otSrpServerServiceGetFullName ( const otSrpServerService aService)

This function returns the full service instance name of the service.

Note
This function is being deprecated and will be removed. otSrpServerServiceGetInstanceName() can be used instead.
Parameters
[in]aServiceA pointer to the SRP service.
Returns
A pointer to the null-terminated service instance name string.

◆ otSrpServerServiceGetHost()

const otSrpServerHost* otSrpServerServiceGetHost ( const otSrpServerService aService)

This function returns the host which the service instance reside on.

Parameters
[in]aServiceA pointer to the SRP service.
Returns
A pointer to the host instance.

◆ otSrpServerServiceGetInstanceName()

const char* otSrpServerServiceGetInstanceName ( const otSrpServerService aService)

This function returns the full service instance name of the service.

Parameters
[in]aServiceA pointer to the SRP service.
Returns
A pointer to the null-terminated service instance name string.

◆ otSrpServerServiceGetLeaseInfo()

void otSrpServerServiceGetLeaseInfo ( const otSrpServerService aService,
otSrpServerLeaseInfo aLeaseInfo 
)

This function returns the LEASE and KEY-LEASE information of a given service.

Parameters
[in]aServiceA pointer to the SRP server service.
[out]aLeaseInfoA pointer to where to output the LEASE and KEY-LEASE information.

◆ otSrpServerServiceGetPort()

uint16_t otSrpServerServiceGetPort ( const otSrpServerService aService)

This function returns the port of the service instance.

Parameters
[in]aServiceA pointer to the SRP service.
Returns
The port of the service.

◆ otSrpServerServiceGetPriority()

uint16_t otSrpServerServiceGetPriority ( const otSrpServerService aService)

This function returns the priority of the service instance.

Parameters
[in]aServiceA pointer to the SRP service.
Returns
The priority of the service.

◆ otSrpServerServiceGetServiceName()

const char* otSrpServerServiceGetServiceName ( const otSrpServerService aService)

This function returns the full service name of the service.

Parameters
[in]aServiceA pointer to the SRP service.
Returns
A pointer to the null-terminated service name string.

◆ otSrpServerServiceGetServiceSubTypeLabel()

otError otSrpServerServiceGetServiceSubTypeLabel ( const otSrpServerService aService,
char *  aLabel,
uint8_t  aMaxSize 
)

This function gets the sub-type label from service name.

This function is intended to be used when the aService is a sub-type, i.e., otSrpServerServiceIsSubType() for the service returns TRUE. If it is not a sub-type this function returns OT_ERROR_INVALID_ARGS.

The full service name for a sub-type service follows "<sub-label>._sub.<service-labels>.<domain>.". This function copies the <sub-label> into the aLabel buffer.

The aLabel is ensured to always be null-terminated after returning even in case of failure.

Parameters
[in]aServiceA pointer to the SRP service.
[out]aLabelA pointer to a buffer to copy the sub-type label name into.
[in]aMaxSizeMaximum size of aLabel buffer.
Return values
OT_ERROR_NONEaLabel was updated successfully.
OT_ERROR_NO_BUFSThe sub-type label could not fit in aLabel buffer (number of chars from label that could fit are copied in aLabel ensuring it is null-terminated).
OT_ERROR_INVALID_ARGSSRP service is not a sub-type.

◆ otSrpServerServiceGetTtl()

uint32_t otSrpServerServiceGetTtl ( const otSrpServerService aService)

This function returns the TTL of the service instance.

Parameters
[in]aServiceA pointer to the SRP service.
Returns
The TTL of the service instance..

◆ otSrpServerServiceGetTxtData()

const uint8_t* otSrpServerServiceGetTxtData ( const otSrpServerService aService,
uint16_t *  aDataLength 
)

This function returns the TXT record data of the service instance.

Parameters
[in]aServiceA pointer to the SRP service.
[out]aDataLengthA pointer to return the TXT record data length. MUST NOT be NULL.
Returns
A pointer to the buffer containing the TXT record data (the TXT data length is returned in aDataLength).

◆ otSrpServerServiceGetWeight()

uint16_t otSrpServerServiceGetWeight ( const otSrpServerService aService)

This function returns the weight of the service instance.

Parameters
[in]aServiceA pointer to the SRP service.
Returns
The weight of the service.

◆ otSrpServerServiceIsDeleted()

bool otSrpServerServiceIsDeleted ( const otSrpServerService aService)

This function indicates whether or not the SRP service has been deleted.

A SRP service can be deleted but retains its name for future uses. In this case, the service instance is not removed from the SRP server/registry. It is guaranteed that all services are deleted if the host is deleted.

Parameters
[in]aServiceA pointer to the SRP service.
Returns
TRUE if the service has been deleted, FALSE if not.

◆ otSrpServerServiceIsSubType()

bool otSrpServerServiceIsSubType ( const otSrpServerService aService)

This function indicates whether or not the SRP service is sub-type.

Parameters
[in]aServiceA pointer to the SRP service.
Returns
TRUE if the service is a sub-type, FALSE if not.

◆ otSrpServerSetAddressMode()

otError otSrpServerSetAddressMode ( otInstance aInstance,
otSrpServerAddressMode  aMode 
)

This function sets the address mode to be used by the SRP server.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[in]aModeThe address mode to use.
Return values
OT_ERROR_NONESuccessfully set the address mode.
OT_ERROR_INVALID_STATEThe SRP server is enabled and the address mode cannot be changed.

◆ otSrpServerSetAnycastModeSequenceNumber()

otError otSrpServerSetAnycastModeSequenceNumber ( otInstance aInstance,
uint8_t  aSequenceNumber 
)

This function sets the sequence number used with anycast address mode.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[in]aSequenceNumberThe sequence number to use.
Return values
OT_ERROR_NONESuccessfully set the address mode.
OT_ERROR_INVALID_STATEThe SRP server is enabled and the sequence number cannot be changed.

◆ otSrpServerSetDomain()

otError otSrpServerSetDomain ( otInstance aInstance,
const char *  aDomain 
)

This function sets the domain on the SRP server.

A trailing dot will be appended to aDomain if it is not already there. This function should only be called before the SRP server is enabled.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[in]aDomainThe domain to be set. MUST NOT be NULL.
Return values
OT_ERROR_NONESuccessfully set the domain to aDomain.
OT_ERROR_INVALID_STATEThe SRP server is already enabled and the Domain cannot be changed.
OT_ERROR_INVALID_ARGSThe argument aDomain is not a valid DNS domain name.
OT_ERROR_NO_BUFSThere is no memory to store content of aDomain.

◆ otSrpServerSetEnabled()

void otSrpServerSetEnabled ( otInstance aInstance,
bool  aEnabled 
)

This function enables/disables the SRP server.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[in]aEnabledA boolean to enable/disable the SRP server.

◆ otSrpServerSetLeaseConfig()

otError otSrpServerSetLeaseConfig ( otInstance aInstance,
const otSrpServerLeaseConfig aLeaseConfig 
)

This function sets SRP server LEASE and KEY-LEASE configurations.

When a non-zero LEASE time is requested from a client, the granted value will be limited in range [aMinLease, aMaxLease]; and a non-zero KEY-LEASE will be granted in range [aMinKeyLease, aMaxKeyLease]. For zero LEASE or KEY-LEASE time, zero will be granted.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[in]aLeaseConfigA pointer to an otSrpServerLeaseConfig instance.
Return values
OT_ERROR_NONESuccessfully set the LEASE and KEY-LEASE ranges.
OT_ERROR_INVALID_ARGSThe LEASE or KEY-LEASE range is not valid.

◆ otSrpServerSetServiceUpdateHandler()

void otSrpServerSetServiceUpdateHandler ( otInstance aInstance,
otSrpServerServiceUpdateHandler  aServiceHandler,
void *  aContext 
)

This function sets the SRP service updates handler on SRP server.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[in]aServiceHandlerA pointer to a service handler. Use NULL to remove the handler.
[in]aContextA pointer to arbitrary context information. May be NULL if not used.

◆ otSrpServerSetTtlConfig()

otError otSrpServerSetTtlConfig ( otInstance aInstance,
const otSrpServerTtlConfig aTtlConfig 
)

This function sets SRP server TTL configuration.

The granted TTL will always be no greater than the max lease interval configured via otSrpServerSetLeaseConfig(), regardless of the minimum and maximum TTL configuration.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[in]aTtlConfigA pointer to an otSrpServerTtlConfig instance.
Return values
OT_ERROR_NONESuccessfully set the TTL configuration.
OT_ERROR_INVALID_ARGSThe TTL configuration is not valid.