TREL - Thread Stack#

otTrelPeer#

typedef struct otTrelPeer otTrelPeer

This struct represents a TREL peer.

otTrelPeerIterator#

typedef uint16_t otTrelPeerIterator

This type represents an iterator for iterating over TREL peer table entries.

otTrelSetEnabled#

void otTrelSetEnabled (otInstance * aInstance, bool aEnable)

Enables or disables TREL operation.

When aEnable is true, this function initiates an ongoing DNS-SD browse on the service name "_trel._udp" within the local browsing domain to discover other devices supporting TREL. Device also registers a new service to be advertised using DNS-SD, with the service name is "_trel._udp" indicating its support for TREL. Device is then ready to receive TREL messages from peers.

When aEnable is false, this function stops the DNS-SD browse on the service name "_trel._udp", stops advertising TREL DNS-SD service, and clears the TREL peer table.

Note

• By default the OpenThread stack enables the TREL operation on start.

otTrelIsEnabled#

bool otTrelIsEnabled (otInstance * aInstance)

This function indicates whether the TREL operation is enabled.

otTrelInitPeerIterator#

void otTrelInitPeerIterator (otInstance * aInstance, otTrelPeerIterator * aIterator)

This function initializes a peer table iterator.

otTrelGetNextPeer#

const otTrelPeer * otTrelGetNextPeer (otInstance * aInstance, otTrelPeerIterator * aIterator)

This function iterates over the peer table entries and get the next entry from the table.

Returns

• A pointer to the next otTrelPeer entry or NULL if no more entries in the table.

otTrelSetFilterEnabled#

void otTrelSetFilterEnabled (otInstance * aInstance, bool aEnable)

This function sets the filter mode (enables/disables filtering).

When filter mode is enabled, any rx and tx traffic through TREL interface is silently dropped. This is mainly intended for use during testing.

Unlike otTrel{Enable/Disable}() which fully starts/stops the TREL operation, when filter mode is enabled the TREL interface continues to be enabled.

otTrelIsFilterEnabled#

bool otTrelIsFilterEnabled (otInstance * aInstance)

This function indicates whether or not the filter mode is enabled.