TREL - Thread Stack#

otTrelPeer#

typedef struct otTrelPeer otTrelPeer

Represents a TREL peer.

otTrelPeerIterator#

typedef const void* otTrelPeerIterator

Represents an iterator for iterating over TREL peer table entries.

otTrelCounters#

typedef otPlatTrelCounters otTrelCounters

Represents a group of TREL related counters.

otTrelStateChangeCallback#

typedef void(* otTrelStateChangeCallback) (void *aContext) )(void *aContext)

Callback function pointer to signal state changes to the TREL.

This callback is invoked whenever the otTrelGetEnabled() or otTrelGetUdpPort() gets changed.

Any OpenThread API, including otTrel APIs, can be safely called from this callback.

otTrelSetEnabled#

void otTrelSetEnabled (otInstance * aInstance, bool aEnable)

Sets the user's preference to enable or disable the TREL operation.

The TREL interface's operational state is determined by two factors: the user's preference (set by this function) and the OpenThread stack's internal state. The TREL interface is enabled only when both the user and the OpenThread stack have it enabled. Otherwise, it is disabled.

Upon OpenThread initialization, the user's preference is set to enabled by default. This allows the stack to control the TREL interface state automatically (e.g., enabling it when radio links are enabled and disabling it when radio links are disabled).

If the user explicitly disables the TREL operation by calling this function with aEnable as false, it will remain disabled until the user explicitly re-enables it by calling this function with aEnable as true. This ensures the user's 'disable' request persists across other OpenThread stack state changes (which may trigger disabling/enabling of all radio links, including the TREL link).

otTrelIsEnabled#

bool otTrelIsEnabled (otInstance * aInstance)

Indicates whether the TREL operation is enabled.

The TREL operation is enabled if and only if it is enabled by both the user (see otTrelSetEnabled()) and the OpenThread stack.

otTrelInitPeerIterator#

void otTrelInitPeerIterator (otInstance * aInstance, otTrelPeerIterator * aIterator)

Initializes a peer table iterator.

otTrelGetNextPeer#

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

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.

otTrelGetNumberOfPeers#

uint16_t otTrelGetNumberOfPeers (otInstance * aInstance)

Returns the number of TREL peers.

Returns

• The number of TREL peers.

otTrelSetFilterEnabled#

void otTrelSetFilterEnabled (otInstance * aInstance, bool aEnable)

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)

Indicates whether or not the filter mode is enabled.

otTrelGetCounters#

const otTrelCounters * otTrelGetCounters (otInstance * aInstance)

Gets the TREL counters.

Returns

• A pointer to the TREL counters.

otTrelResetCounters#

void otTrelResetCounters (otInstance * aInstance)

Resets the TREL counters.

otTrelGetUdpPort#

uint16_t otTrelGetUdpPort (otInstance * aInstance)

Gets the UDP port of the TREL interface.

Returns

• UDP port of the TREL interface.

otTrelSetStateChangeCallback#

void otTrelSetStateChangeCallback (otInstance * aInstance, otTrelStateChangeCallback aCallback, void * aContext)