ot::TmfProxy Class Reference

Public Member Functions
	TmfProxy (const Ip6::Address &aMeshLocal16, Coap::Coap &aCoap)
	This constructor initializes the TMF proxy. More...
otError	Start (otTmfProxyStreamHandler aStreamHandler, void *aContext)
	This method enables the TMF proxy service. More...
otError	Stop (void)
	This method disables the TMF proxy service. More...
otError	Send (Message &aMessage, uint16_t aLocator, uint16_t aPort)
	This method sends the message into the thread network. More...
bool	IsEnabled (void) const
	This method indicates whether or not the TMF proxy service is enabled. More...

Constructor & Destructor Documentation

TmfProxy()

ot::TmfProxy::TmfProxy	(	const Ip6::Address &	aMeshLocal16,
		Coap::Coap &	aCoap
	)

This constructor initializes the TMF proxy.

Parameters

[in]	aMeshLocal16	A reference to the Mesh Local Routing Locator.
[in]	aCoap	A reference to the Management CoAP Service.

Member Function Documentation

IsEnabled()

bool ot::TmfProxy::IsEnabled

(

void

)

const

This method indicates whether or not the TMF proxy service is enabled.

Return values

TRUE	If the service is enabled.
FALSE	If the service is disabled.

Send()

otError ot::TmfProxy::Send	(	Message &	aMessage,
		uint16_t	aLocator,
		uint16_t	aPort
	)

This method sends the message into the thread network.

Parameters

[in]	aMessage	A reference to the message to send.
[in]	aLocator	The destination's RLOC16 or ALOC16.
[in]	aPort	The destination port.

Return values

OT_ERROR_NONE	Successfully send the message.
OT_ERROR_INVALID_STATE	Border agent proxy is not started.

Warning

No matter the call success or fail, the message is freed.

Start()

otError ot::TmfProxy::Start	(	otTmfProxyStreamHandler	aStreamHandler,
		void *	aContext
	)

This method enables the TMF proxy service.

Return values

OT_ERROR_NONE	Successfully started the service.
OT_ERROR_ALREADY	The service already started.

Stop()

otError ot::TmfProxy::Stop

(

void

)

This method disables the TMF proxy service.

Return values

OT_ERROR_NONE	Successfully stopped the TMF proxy service.
OT_ERROR_ALREADY	The service already stopped.

---

The documentation for this class was generated from the following file:

• src/core/thread/tmf_proxy.hpp