otSrpClientService

#include <srp_client.h>

This structure represents an SRP client service.

Summary

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

Public attributes
mData	uint32_t Internal data (used by OT core).
mInstanceName	const char * The service instance name label (not the full name).
mName	const char * The service name labels (e.g., "_chip._udp", not the full domain name).
mNext	struct otSrpClientService * Pointer to next entry in a linked-list (managed by OT core).
mNumTxtEntries	uint8_t Number of entries in the mTxtEntries array.
mPort	uint16_t The service port number.
mPriority	uint16_t The service priority.
mState	otSrpClientItemState
mSubTypeLabels	const char *const * Array of service sub-type labels (must end with NULL or can be NULL).
mTxtEntries	const otDnsTxtEntry * Array of TXT entries (number of entries is given by mNumTxtEntries).
mWeight	uint16_t The service weight.

Public attributes

mData

uint32_t otSrpClientService::mData

Internal data (used by OT core).

mInstanceName

const char * otSrpClientService::mInstanceName

The service instance name label (not the full name).

mName

const char * otSrpClientService::mName

The service name labels (e.g., "_chip._udp", not the full domain name).

mNext

struct otSrpClientService * otSrpClientService::mNext

Pointer to next entry in a linked-list (managed by OT core).

mNumTxtEntries

uint8_t otSrpClientService::mNumTxtEntries

Number of entries in the mTxtEntries array.

mPort

uint16_t otSrpClientService::mPort

The service port number.

mPriority

uint16_t otSrpClientService::mPriority

The service priority.

mState

otSrpClientItemState otSrpClientService::mState

Note: The following fields are used/managed by OT core only. Their values do not matter and are ignored when an instance of otSrpClientService is passed in otSrpClientAddService() or otSrpClientRemoveService(). The user should not modify these fields.Service state (managed by OT core).

mSubTypeLabels

const char *const * otSrpClientService::mSubTypeLabels

Array of service sub-type labels (must end with NULL or can be NULL).

mTxtEntries

const otDnsTxtEntry * otSrpClientService::mTxtEntries

Array of TXT entries (number of entries is given by mNumTxtEntries).

mWeight

uint16_t otSrpClientService::mWeight

The service weight.

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.