Border Agent TXT Data Parser#

This module includes APIs for parsing the MeshCoP service TXT data of a Border Agent.

Modules#

otBorderAgentStateBitmap

otBorderAgentTxtDataInfo

Enumerations#

enum

otBorderAgentConnMode {

OT_BORDER_AGENT_CONN_MODE_DISABLED = 0

OT_BORDER_AGENT_CONN_MODE_PSKC = 1

OT_BORDER_AGENT_CONN_MODE_PSKD = 2

OT_BORDER_AGENT_CONN_MODE_VENDOR = 3

OT_BORDER_AGENT_CONN_MODE_X509 = 4

}

Represents the Connection Mode in a Border Agent State Bitmap.

enum

otBorderAgentThreadIfState {

OT_BORDER_AGENT_THREAD_IF_NOT_INITIALIZED = 0

OT_BORDER_AGENT_THREAD_IF_INITIALIZED = 1

OT_BORDER_AGENT_THREAD_IF_ACTIVE = 2

}

Represents the Thread Interface Status in a Border Agent State Bitmap.

enum

otBorderAgentAvailability {

OT_BORDER_AGENT_AVAILABILITY_INFREQUENT = 0

OT_BORDER_AGENT_AVAILABILITY_HIGH = 1

}

Represents the Availability Status in a Border Agent State Bitmap.

enum

otBorderAgentThreadRole {

OT_BORDER_AGENT_THREAD_ROLE_DISABLED_OR_DETACHED = 0

OT_BORDER_AGENT_THREAD_ROLE_CHILD = 1

OT_BORDER_AGENT_THREAD_ROLE_ROUTER = 2

OT_BORDER_AGENT_THREAD_ROLE_LEADER = 3

}

Represents the Thread Role in a Border Agent State Bitmap.

enum

otBorderAgentMultiAilState {

OT_BORDER_AGENT_MULTI_AIL_STATE_DISABLED = 0

OT_BORDER_AGENT_MULTI_AIL_STATE_NOT_DETECTED = 1

OT_BORDER_AGENT_MULTI_AIL_STATE_DETECTED = 2

}

Represents the Multi-AIL (Adjacent Infrastructure Link) detection state in a Border Agent State Bitmap.

Typedefs#

typedef enum otBorderAgentConnMode

otBorderAgentConnMode

Represents the Connection Mode in a Border Agent State Bitmap.

typedef enum otBorderAgentThreadIfState

otBorderAgentThreadIfState

Represents the Thread Interface Status in a Border Agent State Bitmap.

typedef enum otBorderAgentAvailability

otBorderAgentAvailability

Represents the Availability Status in a Border Agent State Bitmap.

typedef enum otBorderAgentThreadRole

otBorderAgentThreadRole

Represents the Thread Role in a Border Agent State Bitmap.

typedef enum otBorderAgentMultiAilState

otBorderAgentMultiAilState

Represents the Multi-AIL (Adjacent Infrastructure Link) detection state in a Border Agent State Bitmap.

typedef struct otBorderAgentStateBitmap

otBorderAgentStateBitmap

Represents Border Agent State Bitmap information.

typedef struct otBorderAgentTxtDataInfo

otBorderAgentTxtDataInfo

Represents parsed Border Agent TXT data.

Functions#

otError

otBorderAgentTxtDataParse(const uint8_t *aTxtData, uint16_t aTxtDataLength, otBorderAgentTxtDataInfo *aInfo)

Parses a Border Agent's MeshCoP service TXT data.

const char *

otBorderAgentConnModeToString(otBorderAgentConnMode aConnMode)

Converts a given Connection Mode in a Border Agent State Bitmap to a human-readable string.

const char *

otBorderAgentIfStateToString(otBorderAgentThreadIfState aIfState)

Converts a given Thread Interface State in a Border Agent State Bitmap to a human-readable string.

const char *

otBorderAgentAvailabilityToString(otBorderAgentAvailability aAvailability)

Converts a given Availability Status in a Border Agent State Bitmap to a human-readable string.

const char *

otBorderAgentThreadRoleToString(otBorderAgentThreadRole aRole)

Converts a given Thread Role in a Border Agent State Bitmap to a human-readable string.

const char *

otBorderAgentMultiAilStateToString(otBorderAgentMultiAilState aState)

Converts a given Multi-AIL State in a Border Agent State Bitmap to a human-readable string.

Macros#

#define

OT_BORDER_AGENT_RECORD_VERSION_SIZE (8)

Max size of Record Version string in otBorderAgentTxtDataInfo.

#define

OT_BORDER_AGENT_THREAD_VERSION_SIZE (16)

Max size of Thread Version string in otBorderAgentTxtDataInfo.

#define

OT_BORDER_AGENT_VENDOR_NAME_SIZE (32)

Max size of Vendor Name string in otBorderAgentTxtDataInfo.

#define

OT_BORDER_AGENT_MODEL_NAME_SIZE (32)

Max size of Model Name string in otBorderAgentTxtDataInfo.

#define

OT_BORDER_AGENT_VENDOR_OUI_SIZE (3)

Size of Vendor OUI (in bytes) in otBorderAgentTxtDataInfo.

Enumeration Documentation#

otBorderAgentConnMode#

otBorderAgentConnMode

Represents the Connection Mode in a Border Agent State Bitmap.

Enumerator
OT_BORDER_AGENT_CONN_MODE_DISABLED	DTLS connection not allowed.
OT_BORDER_AGENT_CONN_MODE_PSKC	DTLS connection with PSKc.
OT_BORDER_AGENT_CONN_MODE_PSKD	DTLS connection with PSKd.
OT_BORDER_AGENT_CONN_MODE_VENDOR	DTLS with vendor defined credential.
OT_BORDER_AGENT_CONN_MODE_X509	DTLS with X.509 certificate.

otBorderAgentThreadIfState#

otBorderAgentThreadIfState

Represents the Thread Interface Status in a Border Agent State Bitmap.

Enumerator
OT_BORDER_AGENT_THREAD_IF_NOT_INITIALIZED	Thread interface is not initialized.
OT_BORDER_AGENT_THREAD_IF_INITIALIZED	Thread interface is initialized but is not yet active.
OT_BORDER_AGENT_THREAD_IF_ACTIVE	Thread interface is initialized and active.

otBorderAgentAvailability#

otBorderAgentAvailability

Represents the Availability Status in a Border Agent State Bitmap.

Enumerator
OT_BORDER_AGENT_AVAILABILITY_INFREQUENT	Infrequent availability.
OT_BORDER_AGENT_AVAILABILITY_HIGH	High availability.

otBorderAgentThreadRole#

otBorderAgentThreadRole

Represents the Thread Role in a Border Agent State Bitmap.

Enumerator
OT_BORDER_AGENT_THREAD_ROLE_DISABLED_OR_DETACHED	Detached or disabled.
OT_BORDER_AGENT_THREAD_ROLE_CHILD	End device (child).
OT_BORDER_AGENT_THREAD_ROLE_ROUTER	Router.
OT_BORDER_AGENT_THREAD_ROLE_LEADER	Leader.

otBorderAgentMultiAilState#

otBorderAgentMultiAilState

Represents the Multi-AIL (Adjacent Infrastructure Link) detection state in a Border Agent State Bitmap.

Enumerator
OT_BORDER_AGENT_MULTI_AIL_STATE_DISABLED	Multi-AIL detection is disabled.
OT_BORDER_AGENT_MULTI_AIL_STATE_NOT_DETECTED	Multi-AIL detection is enabled, not detected.
OT_BORDER_AGENT_MULTI_AIL_STATE_DETECTED	Multi-AIL detection is enabled, detected.

Typedef Documentation#

otBorderAgentConnMode#

typedef enum otBorderAgentConnMode otBorderAgentConnMode

Represents the Connection Mode in a Border Agent State Bitmap.

otBorderAgentThreadIfState#

typedef enum otBorderAgentThreadIfState otBorderAgentThreadIfState

Represents the Thread Interface Status in a Border Agent State Bitmap.

otBorderAgentAvailability#

typedef enum otBorderAgentAvailability otBorderAgentAvailability

Represents the Availability Status in a Border Agent State Bitmap.

otBorderAgentThreadRole#

typedef enum otBorderAgentThreadRole otBorderAgentThreadRole

Represents the Thread Role in a Border Agent State Bitmap.

otBorderAgentMultiAilState#

typedef enum otBorderAgentMultiAilState otBorderAgentMultiAilState

Represents the Multi-AIL (Adjacent Infrastructure Link) detection state in a Border Agent State Bitmap.

otBorderAgentStateBitmap#

typedef struct otBorderAgentStateBitmap otBorderAgentStateBitmap

Represents Border Agent State Bitmap information.

otBorderAgentTxtDataInfo#

typedef struct otBorderAgentTxtDataInfo otBorderAgentTxtDataInfo

Represents parsed Border Agent TXT data.

The boolean flags indicate whether a specific field is present in the parsed TXT data.

Function Documentation#

otBorderAgentTxtDataParse#

otError otBorderAgentTxtDataParse (const uint8_t * aTxtData, uint16_t aTxtDataLength, otBorderAgentTxtDataInfo * aInfo)

Parses a Border Agent's MeshCoP service TXT data.

Parameters

Type	Direction	Argument Name	Description
const uint8_t *	[in]	aTxtData	A pointer to the buffer containing the TXT data.
uint16_t	[in]	aTxtDataLength	The length of the TXT data in bytes.
otBorderAgentTxtDataInfo *	[out]	aInfo	A pointer to a structure to output the parsed information.

Requires OPENTHREAD_CONFIG_BORDER_AGENT_TXT_DATA_PARSER_ENABLE.

otBorderAgentConnModeToString#

const char * otBorderAgentConnModeToString (otBorderAgentConnMode aConnMode)

Converts a given Connection Mode in a Border Agent State Bitmap to a human-readable string.

Parameters

Type	Direction	Argument Name	Description
otBorderAgentConnMode	[in]	aConnMode	The Connection Mode to convert.

Requires OPENTHREAD_CONFIG_BORDER_AGENT_TXT_DATA_PARSER_ENABLE.

Returns

The string representation of aConnMode.

otBorderAgentIfStateToString#

const char * otBorderAgentIfStateToString (otBorderAgentThreadIfState aIfState)

Converts a given Thread Interface State in a Border Agent State Bitmap to a human-readable string.

Parameters

Type	Direction	Argument Name	Description
otBorderAgentThreadIfState	[in]	aIfState	The Thread Interface State to convert.

Requires OPENTHREAD_CONFIG_BORDER_AGENT_TXT_DATA_PARSER_ENABLE.

Returns

The string representation of aIfState.

otBorderAgentAvailabilityToString#

const char * otBorderAgentAvailabilityToString (otBorderAgentAvailability aAvailability)

Converts a given Availability Status in a Border Agent State Bitmap to a human-readable string.

Parameters

Type	Direction	Argument Name	Description
otBorderAgentAvailability	[in]	aAvailability	The Availability Status to convert.

Requires OPENTHREAD_CONFIG_BORDER_AGENT_TXT_DATA_PARSER_ENABLE.

Returns

The string representation of aAvailability.

otBorderAgentThreadRoleToString#

const char * otBorderAgentThreadRoleToString (otBorderAgentThreadRole aRole)

Converts a given Thread Role in a Border Agent State Bitmap to a human-readable string.

Parameters

Type	Direction	Argument Name	Description
otBorderAgentThreadRole	[in]	aRole	The Thread Role to convert.

Requires OPENTHREAD_CONFIG_BORDER_AGENT_TXT_DATA_PARSER_ENABLE.

Returns

The string representation of aRole.

otBorderAgentMultiAilStateToString#

const char * otBorderAgentMultiAilStateToString (otBorderAgentMultiAilState aState)

Converts a given Multi-AIL State in a Border Agent State Bitmap to a human-readable string.

Parameters

Type	Direction	Argument Name	Description
otBorderAgentMultiAilState	[in]	aState	The Multi-AIL State to convert.

Requires OPENTHREAD_CONFIG_BORDER_AGENT_TXT_DATA_PARSER_ENABLE.

Returns

The string representation of aState.