This module includes functions that control SRP client behavior. More...

Collaboration diagram for SRP:

Data Structures
struct	otSrpClientBuffersServiceEntry

struct	otSrpClientHostInfo

struct	otSrpClientService

struct	otSrpServerLeaseConfig

struct	otSrpServerLeaseInfo

struct	otSrpServerResponseCounters

struct	otSrpServerTtlConfig

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

typedef struct otSrpClientBuffersServiceEntry	otSrpClientBuffersServiceEntry

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

typedef struct otSrpClientHostInfo	otSrpClientHostInfo

typedef struct otSrpClientService	otSrpClientService

typedef enum otSrpServerAddressMode	otSrpServerAddressMode

typedef struct otSrpServerHost	otSrpServerHost

typedef struct otSrpServerLeaseConfig	otSrpServerLeaseConfig

typedef struct otSrpServerLeaseInfo	otSrpServerLeaseInfo

typedef struct otSrpServerResponseCounters	otSrpServerResponseCounters

typedef struct otSrpServerService	otSrpServerService

typedef uint8_t	otSrpServerServiceFlags

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

typedef uint32_t	otSrpServerServiceUpdateId

typedef struct otSrpServerTtlConfig	otSrpServerTtlConfig

Enumerations
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	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 }

enum	otSrpServerAddressMode { OT_SRP_SERVER_ADDRESS_MODE_UNICAST = 0, OT_SRP_SERVER_ADDRESS_MODE_ANYCAST = 1 }

enum	otSrpServerState { OT_SRP_SERVER_STATE_DISABLED = 0, OT_SRP_SERVER_STATE_RUNNING = 1, OT_SRP_SERVER_STATE_STOPPED = 2 }

Functions
otError	otSrpClientAddService (otInstance aInstance, otSrpClientService aService)

otSrpClientBuffersServiceEntry *	otSrpClientBuffersAllocateService (otInstance *aInstance)

void	otSrpClientBuffersFreeAllServices (otInstance *aInstance)

void	otSrpClientBuffersFreeService (otInstance aInstance, otSrpClientBuffersServiceEntry aService)

otIp6Address *	otSrpClientBuffersGetHostAddressesArray (otInstance aInstance, uint8_t aArrayLength)

char *	otSrpClientBuffersGetHostNameString (otInstance aInstance, uint16_t aSize)

char *	otSrpClientBuffersGetServiceEntryInstanceNameString (otSrpClientBuffersServiceEntry aEntry, uint16_t aSize)

char *	otSrpClientBuffersGetServiceEntryServiceNameString (otSrpClientBuffersServiceEntry aEntry, uint16_t aSize)

uint8_t *	otSrpClientBuffersGetServiceEntryTxtBuffer (otSrpClientBuffersServiceEntry aEntry, uint16_t aSize)

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

void	otSrpClientClearHostAndServices (otInstance *aInstance)

otError	otSrpClientClearService (otInstance aInstance, otSrpClientService aService)

void	otSrpClientDisableAutoStartMode (otInstance *aInstance)

otError	otSrpClientEnableAutoHostAddress (otInstance *aInstance)

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

const char *	otSrpClientGetDomainName (otInstance *aInstance)

const otSrpClientHostInfo *	otSrpClientGetHostInfo (otInstance *aInstance)

uint32_t	otSrpClientGetKeyLeaseInterval (otInstance *aInstance)

uint32_t	otSrpClientGetLeaseInterval (otInstance *aInstance)

const otSockAddr *	otSrpClientGetServerAddress (otInstance *aInstance)

const otSrpClientService *	otSrpClientGetServices (otInstance *aInstance)

uint32_t	otSrpClientGetTtl (otInstance *aInstance)

bool	otSrpClientIsAutoStartModeEnabled (otInstance *aInstance)

bool	otSrpClientIsRunning (otInstance *aInstance)

bool	otSrpClientIsServiceKeyRecordEnabled (otInstance *aInstance)

const char *	otSrpClientItemStateToString (otSrpClientItemState aItemState)

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

otError	otSrpClientRemoveService (otInstance aInstance, otSrpClientService aService)

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

otError	otSrpClientSetDomainName (otInstance aInstance, const char aName)

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

otError	otSrpClientSetHostName (otInstance aInstance, const char aName)

void	otSrpClientSetKeyLeaseInterval (otInstance *aInstance, uint32_t aInterval)

void	otSrpClientSetLeaseInterval (otInstance *aInstance, uint32_t aInterval)

void	otSrpClientSetServiceKeyRecordEnabled (otInstance *aInstance, bool aEnabled)

void	otSrpClientSetTtl (otInstance *aInstance, uint32_t aTtl)

otError	otSrpClientStart (otInstance aInstance, const otSockAddr aServerSockAddr)

void	otSrpClientStop (otInstance *aInstance)

otSrpServerAddressMode	otSrpServerGetAddressMode (otInstance *aInstance)

uint8_t	otSrpServerGetAnycastModeSequenceNumber (otInstance *aInstance)

const char *	otSrpServerGetDomain (otInstance *aInstance)

void	otSrpServerGetLeaseConfig (otInstance aInstance, otSrpServerLeaseConfig aLeaseConfig)

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

uint16_t	otSrpServerGetPort (otInstance *aInstance)

const otSrpServerResponseCounters *	otSrpServerGetResponseCounters (otInstance *aInstance)

otSrpServerState	otSrpServerGetState (otInstance *aInstance)

void	otSrpServerGetTtlConfig (otInstance aInstance, otSrpServerTtlConfig aTtlConfig)

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

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

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

const char *	otSrpServerHostGetFullName (const otSrpServerHost *aHost)

void	otSrpServerHostGetLeaseInfo (const otSrpServerHost aHost, otSrpServerLeaseInfo aLeaseInfo)

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

bool	otSrpServerHostIsDeleted (const otSrpServerHost *aHost)

const char *	otSrpServerServiceGetFullName (const otSrpServerService *aService)

const otSrpServerHost *	otSrpServerServiceGetHost (const otSrpServerService *aService)

const char *	otSrpServerServiceGetInstanceName (const otSrpServerService *aService)

void	otSrpServerServiceGetLeaseInfo (const otSrpServerService aService, otSrpServerLeaseInfo aLeaseInfo)

uint16_t	otSrpServerServiceGetPort (const otSrpServerService *aService)

uint16_t	otSrpServerServiceGetPriority (const otSrpServerService *aService)

const char *	otSrpServerServiceGetServiceName (const otSrpServerService *aService)

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

uint32_t	otSrpServerServiceGetTtl (const otSrpServerService *aService)

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

uint16_t	otSrpServerServiceGetWeight (const otSrpServerService *aService)

bool	otSrpServerServiceIsDeleted (const otSrpServerService *aService)

bool	otSrpServerServiceIsSubType (const otSrpServerService *aService)

otError	otSrpServerSetAddressMode (otInstance *aInstance, otSrpServerAddressMode aMode)

otError	otSrpServerSetAnycastModeSequenceNumber (otInstance *aInstance, uint8_t aSequenceNumber)

otError	otSrpServerSetDomain (otInstance aInstance, const char aDomain)

void	otSrpServerSetEnabled (otInstance *aInstance, bool aEnabled)

otError	otSrpServerSetLeaseConfig (otInstance aInstance, const otSrpServerLeaseConfig aLeaseConfig)

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

otError	otSrpServerSetTtlConfig (otInstance aInstance, const otSrpServerTtlConfig aTtlConfig)

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

§ otSrpClientHostInfo

typedef struct otSrpClientHostInfo otSrpClientHostInfo

This structure represents an SRP client host info.

§ otSrpClientService

typedef struct otSrpClientService 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().

§ 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]	aError	The error (see above).
[in]	aHostInfo	A pointer to host info.
[in]	aServices	The head of linked-list containing all services (excluding the ones removed). NULL if the list is empty.
[in]	aRemovedServices	The head of linked-list containing all removed services. NULL if the list is empty.
[in]	aContext	A pointer to an arbitrary context (provided when callback was registered).

§ 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]	aServerSockAddr	A 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]	aContext	A pointer to an arbitrary context (provided when callback was registered).

§ otSrpClientBuffersServiceEntry

typedef struct otSrpClientBuffersServiceEntry otSrpClientBuffersServiceEntry

This struct represents a SRP client service pool entry.

§ otSrpServerHost

typedef struct otSrpServerHost otSrpServerHost

This opaque type represents a SRP service host.

§ otSrpServerService

typedef struct otSrpServerService otSrpServerService

This opaque type represents a SRP service.

§ otSrpServerServiceUpdateId

typedef uint32_t otSrpServerServiceUpdateId

The ID of a SRP service update transaction on the SRP Server.

§ 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_*.

§ otSrpServerAddressMode

typedef enum otSrpServerAddressMode 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.

§ otSrpServerTtlConfig

typedef struct otSrpServerTtlConfig otSrpServerTtlConfig

This structure includes SRP server TTL configurations.

§ otSrpServerLeaseConfig

typedef struct otSrpServerLeaseConfig otSrpServerLeaseConfig

This structure includes SRP server LEASE and KEY-LEASE configurations.

§ otSrpServerLeaseInfo

typedef struct otSrpServerLeaseInfo otSrpServerLeaseInfo

This structure includes SRP server lease information of a host/service.

§ otSrpServerResponseCounters

typedef struct otSrpServerResponseCounters otSrpServerResponseCounters

This structure includes the statistics of SRP server responses.

§ 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]	aId	The service update transaction ID. This ID must be passed back with `otSrpServerHandleServiceUpdateResult`.
[in]	aHost	A 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: 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). 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]	aTimeout	The maximum time in milliseconds for the handler to process the service event.
[in]	aContext	A pointer to application-specific context.

See also: otSrpServerSetServiceUpdateHandler; otSrpServerHandleServiceUpdateResult

Enumeration Type Documentation

§ otSrpClientItemState

enum 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.

§ 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.

§ otSrpServerState

enum 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.

§ otSrpServerAddressMode

enum 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.

Function Documentation

§ 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:

The SRP client is started - otSrpClientStart() is called.
Host name is set - otSrpClientSetHostName() is called.
At least one host IPv6 address is set - otSrpClientSetHostName() is called.
At least one service is added - otSrpClientAddService() is called.

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]	aInstance	A pointer to the OpenThread instance.
[in]	aServerSockAddr	The socket address (IPv6 address and port number) of the SRP server.

Return values

OT_ERROR_NONE	SRP client operation started successfully or it is already running with same server socket address and callback.
OT_ERROR_BUSY	SRP client is busy running with a different socket address.
OT_ERROR_FAILED	Failed 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] aInstance A pointer to the OpenThread instance.

§ otSrpClientIsRunning()

bool otSrpClientIsRunning ( otInstance * aInstance )

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

Parameters

[in] aInstance A pointer to the OpenThread instance.

Returns: TRUE if the SRP client is running, FALSE otherwise.

§ 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] aInstance A pointer to the OpenThread instance.

Returns: A pointer to the SRP server's socket address (is always non-NULL).

§ 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]	aInstance	A pointer to the OpenThread instance.
[in]	aCallback	The callback to notify of events and changes. Can be NULL if not needed.
[in]	aContext	An arbitrary context used with `aCallback`.

Referenced by NcpBase::NcpBase().

§ 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]	aInstance	A pointer to the OpenThread instance.
[in]	aCallback	A callback to notify when client is auto-started/stopped. Can be NULL if not needed.
[in]	aContext	A context to be passed when invoking `aCallback`.

§ 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] aInstance A pointer to the OpenThread instance.

§ 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] aInstance A pointer to the OpenThread instance.

Returns: TRUE if the auto-start mode is enabled, FALSE otherwise.

§ 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] aInstance A pointer to the OpenThread instance.

Returns: The TTL (in seconds).

§ 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]	aInstance	A pointer to the OpenThread instance.
[in]	aTtl	The TTL (in seconds). If value is zero or greater than lease interval, the TTL is set to the lease interval.

§ 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] aInstance A pointer to the OpenThread instance.

Returns: The lease interval (in seconds).

§ 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]	aInstance	A pointer to the OpenThread instance.
[in]	aInterval	The lease interval (in seconds). If zero, the default value specified by `OPENTHREAD_CONFIG_SRP_CLIENT_DEFAULT_LEASE` would be used.

§ 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] aInstance A pointer to the OpenThread instance.

Returns: The key lease interval (in seconds).

§ 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]	aInstance	A pointer to the OpenThread instance.
[in]	aInterval	The key lease interval (in seconds). If zero, the default value specified by `OPENTHREAD_CONFIG_SRP_CLIENT_DEFAULT_KEY_LEASE` would be used.

§ otSrpClientGetHostInfo()

const otSrpClientHostInfo* otSrpClientGetHostInfo ( otInstance * aInstance )

This function gets the host info.

Parameters

[in] aInstance A pointer to the OpenThread instance.

Returns: A pointer to host info structure.

§ 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]	aInstance	A pointer to the OpenThread instance.
[in]	aName	A 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_NONE	The host name label was set successfully.
OT_ERROR_INVALID_ARGS	The `aName` is NULL.
OT_ERROR_INVALID_STATE	The host name is already set and registered with the server.

§ otSrpClientEnableAutoHostAddress()

otError otSrpClientEnableAutoHostAddress ( otInstance * aInstance )

This function enables auto host address mode.

When enabled host IPv6 addresses are automatically set by SRP client using all the unicast addresses on Thread netif excluding all link-local and mesh-local addresses. If there is no valid address, then Mesh Local EID address is added. The SRP client will automatically re-register when/if addresses on Thread netif are updated (new addresses are added or existing addresses are removed).

The auto host address mode can be enabled before start or during operation of SRP client except when the host info is being removed (client is busy handling a remove request from an call to otSrpClientRemoveHostAndServices() and host info still being in either STATE_TO_REMOVE or STATE_REMOVING states).

After auto host address mode is enabled, it can be disabled by a call to otSrpClientSetHostAddresses() which then explicitly sets the host addresses.

Return values

OT_ERROR_NONE	Successfully enabled auto host address mode.
OT_ERROR_INVALID_STATE	Host is being removed and therefore cannot enable auto host address mode.

§ 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.

Calling this function disables auto host address mode if it was previously enabled from a successful call to otSrpClientEnableAutoHostAddress().

Parameters

[in]	aInstance	A pointer to the OpenThread instance.
[in]	aIp6Addresses	A pointer to the an array containing the host IPv6 addresses.
[in]	aNumAddresses	The number of addresses in the `aIp6Addresses` array.

Return values

OT_ERROR_NONE	The host IPv6 address list change started successfully. The `otSrpClientCallback` will be called to report the status of registering addresses with server.
OT_ERROR_INVALID_ARGS	The address list is invalid (e.g., must contain at least one address).
OT_ERROR_INVALID_STATE	Host is being removed and therefore cannot change host address.

§ 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

It is removed explicitly by a call to otSrpClientRemoveService() or removed along with other services by a call to otSrpClientRemoveHostAndServices() and only after theotSrpClientCallback` is called indicating the service was removed. Or,
A call to otSrpClientClearHostAndServices() which removes the host and all related services immediately.

Parameters

[in]	aInstance	A pointer to the OpenThread instance.
[in]	aService	A pointer to a `otSrpClientService` instance to add.

Return values

OT_ERROR_NONE	The addition of service started successfully. The `otSrpClientCallback` will be called to report the status.
OT_ERROR_ALREADY	A service with the same service and instance names is already in the list.
OT_ERROR_INVALID_ARGS	The service structure is invalid (e.g., bad service name or `otDnsTxtEntry`).

§ 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]	aInstance	A pointer to the OpenThread instance.
[in]	aService	A pointer to a `otSrpClientService` instance to remove.

Return values

OT_ERROR_NONE	The removal of service started successfully. The `otSrpClientCallback` will be called to report the status.
OT_ERROR_NOT_FOUND	The service could not be found in the list.

§ 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]	aInstance	A pointer to the OpenThread instance.
[in]	aService	A pointer to a `otSrpClientService` instance to delete.

Return values

OT_ERROR_NONE	The `aService` is deleted successfully. It can be reclaimed and re-used immediately.
OT_ERROR_NOT_FOUND	The service could not be found in the list.

§ otSrpClientGetServices()

const otSrpClientService* otSrpClientGetServices ( otInstance * aInstance )

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

Parameters

[in] aInstance A pointer to the OpenThread instance.

Returns: A pointer to the head of linked-list of all services or NULL if the list is empty.

§ 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]	aInstance	A pointer to the OpenThread instance.
[in]	aRemoveKeyLease	A boolean indicating whether or not the host key lease should also be removed.
[in]	aSendUnregToServer	A boolean indicating whether to send update to server when host info is not registered.

Return values

OT_ERROR_NONE	The removal of host info and services started successfully. The `otSrpClientCallback` will be called to report the status.
OT_ERROR_ALREADY	The host info is already removed.

§ 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] aInstance A pointer to the OpenThread instance.

§ 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] aInstance A pointer to the OpenThread instance.

Returns: The domain name string.

§ 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]	aInstance	A pointer to the OpenThread instance.
[in]	aName	A pointer to the domain name string. If NULL sets it to default "default.service.arpa".

Return values

OT_ERROR_NONE	The domain name label was set successfully.
OT_ERROR_INVALID_STATE	The host info is already registered with server.

§ otSrpClientItemStateToString()

const char* otSrpClientItemStateToString ( otSrpClientItemState aItemState )

This function converts a otSrpClientItemState to a string.

Parameters

[in] aItemState An item state.

Returns: A string representation of aItemState.

§ 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]	aInstance	A pointer to the OpenThread instance.
[in]	aEnabled	TRUE to enable, FALSE to disable the "service key record inclusion" mode.

§ 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] aInstance A pointer to the OpenThread instance.

Returns: TRUE if "service key record inclusion" mode is enabled, FALSE otherwise.

§ otSrpClientBuffersGetHostNameString()

char* otSrpClientBuffersGetHostNameString	(	otInstance *	aInstance,
		uint16_t *	aSize
	)

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

Parameters

[in]	aInstance	A pointer to the OpenThread instance.
[out]	aSize	Pointer 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.

§ 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]	aInstance	A pointer to the OpenThread instance.
[out]	aArrayLength	Pointer 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).

§ 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:

mService.mName will point to an allocated string buffer which can be retrieved using the function otSrpClientBuffersGetServiceEntryServiceNameString().
mService.mInstanceName will point to an allocated string buffer which can be retrieved using the function otSrpClientBuffersGetServiceEntryInstanceNameString().
mService.mSubTypeLabels points to an array that is returned from otSrpClientBuffersGetSubTypeLabelsArray().
mService.mTxtEntries will point to mTxtEntry.
mService.mNumTxtEntries will be set to one.
Other mService fields (port, priority, weight) are set to zero.
mTxtEntry.mKey is set to NULL (value is treated as already encoded).
mTxtEntry.mValue will point to an allocated buffer which can be retrieved using the function otSrpClientBuffersGetServiceEntryTxtBuffer().
mTxtEntry.mValueLength is set to zero.
All related data/string buffers and arrays are cleared to all zero.

Parameters

[in] aInstance A pointer to the OpenThread instance.

Returns: A pointer to the newly allocated service entry or NULL if not more entry available in the pool.

§ 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]	aInstance	A pointer to the OpenThread instance.
[in]	aService	A pointer to the service entry to free (MUST NOT be NULL).

§ otSrpClientBuffersFreeAllServices()

void otSrpClientBuffersFreeAllServices ( otInstance * aInstance )

This function frees all previously allocated service entries.

Parameters

[in] aInstance A pointer to the OpenThread instance.

§ otSrpClientBuffersGetServiceEntryServiceNameString()

char* otSrpClientBuffersGetServiceEntryServiceNameString	(	otSrpClientBuffersServiceEntry *	aEntry,
		uint16_t *	aSize
	)

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

Parameters

[in]	aEntry	A pointer to a previously allocated service entry (MUST NOT be NULL).
[out]	aSize	A 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.

§ otSrpClientBuffersGetServiceEntryInstanceNameString()

char* otSrpClientBuffersGetServiceEntryInstanceNameString	(	otSrpClientBuffersServiceEntry *	aEntry,
		uint16_t *	aSize
	)

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

Parameters

[in]	aEntry	A pointer to a previously allocated service entry (MUST NOT be NULL).
[out]	aSize	A 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]	aEntry	A pointer to a previously allocated service entry (MUST NOT be NULL).
[out]	aSize	A 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]	aEntry	A pointer to a previously allocated service entry (MUST NOT be NULL).
[out]	aArrayLength	A pointer to a variable to return the array length (MUST NOT be NULL).

Returns: A pointer to the array.

§ 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] aInstance A pointer to an OpenThread instance.

Returns: A pointer to the dot-joined domain string.

§ 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]	aInstance	A pointer to an OpenThread instance.
[in]	aDomain	The domain to be set. MUST NOT be NULL.

Return values

OT_ERROR_NONE	Successfully set the domain to `aDomain`.
OT_ERROR_INVALID_STATE	The SRP server is already enabled and the Domain cannot be changed.
OT_ERROR_INVALID_ARGS	The argument `aDomain` is not a valid DNS domain name.
OT_ERROR_NO_BUFS	There is no memory to store content of `aDomain`.

§ otSrpServerGetState()

otSrpServerState otSrpServerGetState ( otInstance * aInstance )

This function returns the state of the SRP server.

Parameters

[in] aInstance A pointer to an OpenThread instance.

Returns: The current state of the SRP server.

§ otSrpServerGetPort()

uint16_t otSrpServerGetPort ( otInstance * aInstance )

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

Parameters

[in] aInstance A pointer to an OpenThread instance.

Returns: The port of the SRP server. It returns 0 if the server is not running.

§ otSrpServerGetAddressMode()

otSrpServerAddressMode otSrpServerGetAddressMode ( otInstance * aInstance )

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

Parameters

[in] aInstance A pointer to an OpenThread instance.

Returns: The SRP server's address mode.

§ otSrpServerSetAddressMode()

otError otSrpServerSetAddressMode	(	otInstance *	aInstance,
		otSrpServerAddressMode	aMode
	)

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

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aMode	The address mode to use.

Return values

OT_ERROR_NONE	Successfully set the address mode.
OT_ERROR_INVALID_STATE	The SRP server is enabled and the address mode cannot be changed.

§ 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] aInstance A pointer to an OpenThread instance.

Returns: The anycast sequence number.

§ otSrpServerSetAnycastModeSequenceNumber()

otError otSrpServerSetAnycastModeSequenceNumber	(	otInstance *	aInstance,
		uint8_t	aSequenceNumber
	)

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

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aSequenceNumber	The sequence number to use.

Return values

OT_ERROR_NONE	Successfully set the address mode.
OT_ERROR_INVALID_STATE	The SRP server is enabled and the sequence number cannot be changed.

§ otSrpServerSetEnabled()

void otSrpServerSetEnabled	(	otInstance *	aInstance,
		bool	aEnabled
	)

This function enables/disables the SRP server.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aEnabled	A boolean to enable/disable the SRP server.

§ otSrpServerGetTtlConfig()

void otSrpServerGetTtlConfig	(	otInstance *	aInstance,
		otSrpServerTtlConfig *	aTtlConfig
	)

This function returns SRP server TTL configuration.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[out]	aTtlConfig	A pointer to an `otSrpServerTtlConfig` instance.

§ 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]	aInstance	A pointer to an OpenThread instance.
[in]	aTtlConfig	A pointer to an `otSrpServerTtlConfig` instance.

Return values

OT_ERROR_NONE	Successfully set the TTL configuration.
OT_ERROR_INVALID_ARGS	The TTL configuration is not valid.

§ otSrpServerGetLeaseConfig()

void otSrpServerGetLeaseConfig	(	otInstance *	aInstance,
		otSrpServerLeaseConfig *	aLeaseConfig
	)

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

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[out]	aLeaseConfig	A pointer to an `otSrpServerLeaseConfig` instance.

§ 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]	aInstance	A pointer to an OpenThread instance.
[in]	aLeaseConfig	A pointer to an `otSrpServerLeaseConfig` instance.

Return values

OT_ERROR_NONE	Successfully set the LEASE and KEY-LEASE ranges.
OT_ERROR_INVALID_ARGS	The 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]	aInstance	A pointer to an OpenThread instance.
[in]	aServiceHandler	A pointer to a service handler. Use NULL to remove the handler.
[in]	aContext	A pointer to arbitrary context information. May be NULL if not used.

§ 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]	aInstance	A pointer to an OpenThread instance.
[in]	aId	The service update transaction ID. This should be the same ID provided via `otSrpServerServiceUpdateHandler`.
[in]	aError	An error to be returned to the SRP server. Use OT_ERROR_DUPLICATED to represent DNS name conflicts.

§ otSrpServerGetNextHost()

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

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

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aHost	A 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.

§ otSrpServerGetResponseCounters()

const otSrpServerResponseCounters* otSrpServerGetResponseCounters ( otInstance * aInstance )

This function returns the response counters of the SRP server.

Parameters

[in] aInstance A pointer to an OpenThread instance.

Returns: A pointer to the response counters of the SRP server.

§ 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] aHost A pointer to the SRP service host.

Returns: TRUE if the host has been deleted, FALSE if not.

§ otSrpServerHostGetFullName()

const char* otSrpServerHostGetFullName ( const otSrpServerHost * aHost )

This function returns the full name of the host.

Parameters

[in] aHost A pointer to the SRP service host.

Returns: A pointer to the null-terminated host name string.

§ otSrpServerHostGetAddresses()

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

This function returns the addresses of given host.

Parameters

[in]	aHost	A pointer to the SRP service host.
[out]	aAddressesNum	A pointer to where we should output the number of the addresses to.

Returns: A pointer to the array of IPv6 Address.

§ otSrpServerHostGetLeaseInfo()

void otSrpServerHostGetLeaseInfo	(	const otSrpServerHost *	aHost,
		otSrpServerLeaseInfo *	aLeaseInfo
	)

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

Parameters

[in]	aHost	A pointer to the SRP server host.
[out]	aLeaseInfo	A 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]	aHost	A pointer to the SRP service host.
[in]	aService	A 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.

§ 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]	aHost	A pointer to the SRP service host (MUST NOT be NULL).
[in]	aPrevService	A pointer to the previous service or NULL to start from the beginning of the list.
[in]	aFlags	Flags indicating which services to include (base/sub-type, active/deleted).
[in]	aServiceName	The service name to match. Set to NULL to accept any name.
[in]	aInstanceName	The 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.

§ 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] aService A 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] aService A pointer to the SRP service.

Returns: TRUE if the service is a sub-type, 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] aService A pointer to the SRP service.

Returns: A pointer to the null-terminated service instance name string.

§ otSrpServerServiceGetInstanceName()

const char* otSrpServerServiceGetInstanceName ( const otSrpServerService * aService )

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

Parameters

[in] aService A pointer to the SRP service.

Returns: A pointer to the null-terminated service instance name string.

§ otSrpServerServiceGetServiceName()

const char* otSrpServerServiceGetServiceName ( const otSrpServerService * aService )

This function returns the full service name of the service.

Parameters

[in] aService A 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]	aService	A pointer to the SRP service.
[out]	aLabel	A pointer to a buffer to copy the sub-type label name into.
[in]	aMaxSize	Maximum size of `aLabel` buffer.

Return values

OT_ERROR_NONE	`aLabel` was updated successfully.
OT_ERROR_NO_BUFS	The 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_ARGS	SRP service is not a sub-type.

§ otSrpServerServiceGetPort()

uint16_t otSrpServerServiceGetPort ( const otSrpServerService * aService )

This function returns the port of the service instance.

Parameters

[in] aService A pointer to the SRP service.

Returns: The port of the service.

§ otSrpServerServiceGetWeight()

uint16_t otSrpServerServiceGetWeight ( const otSrpServerService * aService )

This function returns the weight of the service instance.

Parameters

[in] aService A pointer to the SRP service.

Returns: The weight of the service.

§ otSrpServerServiceGetPriority()

uint16_t otSrpServerServiceGetPriority ( const otSrpServerService * aService )

This function returns the priority of the service instance.

Parameters

[in] aService A pointer to the SRP service.

Returns: The priority of the service.

§ otSrpServerServiceGetTtl()

uint32_t otSrpServerServiceGetTtl ( const otSrpServerService * aService )

This function returns the TTL of the service instance.

Parameters

[in] aService A 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]	aService	A pointer to the SRP service.
[out]	aDataLength	A 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).

§ otSrpServerServiceGetHost()

const otSrpServerHost* otSrpServerServiceGetHost ( const otSrpServerService * aService )

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

Parameters

[in] aService A pointer to the SRP service.

Returns: A pointer to the host instance.

§ otSrpServerServiceGetLeaseInfo()

void otSrpServerServiceGetLeaseInfo	(	const otSrpServerService *	aService,
		otSrpServerLeaseInfo *	aLeaseInfo
	)

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

Parameters

[in]	aService	A pointer to the SRP server service.
[out]	aLeaseInfo	A pointer to where to output the LEASE and KEY-LEASE information.

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

§ otSrpClientHostInfo

§ otSrpClientService

§ otSrpClientCallback

§ otSrpClientAutoStartCallback

§ otSrpClientBuffersServiceEntry

§ otSrpServerHost

§ otSrpServerService

§ otSrpServerServiceUpdateId

§ otSrpServerServiceFlags

§ otSrpServerAddressMode

§ otSrpServerTtlConfig

§ otSrpServerLeaseConfig

§ otSrpServerLeaseInfo

§ otSrpServerResponseCounters

§ otSrpServerServiceUpdateHandler

Enumeration Type Documentation

§ otSrpClientItemState

§ anonymous enum

§ anonymous enum

§ otSrpServerState

§ otSrpServerAddressMode

Function Documentation

§ otSrpClientStart()

§ otSrpClientStop()

§ otSrpClientIsRunning()

§ otSrpClientGetServerAddress()

§ otSrpClientSetCallback()

§ otSrpClientEnableAutoStartMode()

§ otSrpClientDisableAutoStartMode()

§ otSrpClientIsAutoStartModeEnabled()

§ otSrpClientGetTtl()

§ otSrpClientSetTtl()

§ otSrpClientGetLeaseInterval()

§ otSrpClientSetLeaseInterval()

§ otSrpClientGetKeyLeaseInterval()

§ otSrpClientSetKeyLeaseInterval()

§ otSrpClientGetHostInfo()

§ otSrpClientSetHostName()

§ otSrpClientEnableAutoHostAddress()

§ otSrpClientSetHostAddresses()

§ otSrpClientAddService()

§ otSrpClientRemoveService()

§ otSrpClientClearService()

§ otSrpClientGetServices()

§ otSrpClientRemoveHostAndServices()

§ otSrpClientClearHostAndServices()

§ otSrpClientGetDomainName()

§ otSrpClientSetDomainName()

§ otSrpClientItemStateToString()

§ otSrpClientSetServiceKeyRecordEnabled()

§ otSrpClientIsServiceKeyRecordEnabled()

§ otSrpClientBuffersGetHostNameString()

§ otSrpClientBuffersGetHostAddressesArray()

§ otSrpClientBuffersAllocateService()

§ otSrpClientBuffersFreeService()

§ otSrpClientBuffersFreeAllServices()

§ otSrpClientBuffersGetServiceEntryServiceNameString()

§ otSrpClientBuffersGetServiceEntryInstanceNameString()

§ otSrpClientBuffersGetServiceEntryTxtBuffer()

§ otSrpClientBuffersGetSubTypeLabelsArray()

§ otSrpServerGetDomain()

§ otSrpServerSetDomain()

§ otSrpServerGetState()

§ otSrpServerGetPort()

§ otSrpServerGetAddressMode()

§ otSrpServerSetAddressMode()

§ otSrpServerGetAnycastModeSequenceNumber()

§ otSrpServerSetAnycastModeSequenceNumber()

§ otSrpServerSetEnabled()

§ otSrpServerGetTtlConfig()

§ otSrpServerSetTtlConfig()

§ otSrpServerGetLeaseConfig()

§ otSrpServerSetLeaseConfig()

§ otSrpServerSetServiceUpdateHandler()