UDP

This module includes functions that control UDP communication. More...

Data Structures
struct	otUdpSocket

Typedefs
typedef void(*	otUdpReceive )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)
typedef struct otUdpSocket	otUdpSocket

Functions
otMessage *	otUdpNewMessage (otInstance *aInstance, bool aLinkSecurityEnabled)
otError	otUdpOpen (otInstance *aInstance, otUdpSocket *aSocket, otUdpReceive aCallback, void *aContext)
otError	otUdpClose (otUdpSocket *aSocket)
otError	otUdpBind (otUdpSocket *aSocket, otSockAddr *aSockName)
otError	otUdpConnect (otUdpSocket *aSocket, otSockAddr *aSockName)
otError	otUdpSend (otUdpSocket *aSocket, otMessage *aMessage, const otMessageInfo *aMessageInfo)

Detailed Description

This module includes functions that control UDP communication.

Typedef Documentation

typedef void(* otUdpReceive)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)

This callback allows OpenThread to inform the application of a received UDP message.

typedef struct otUdpSocket otUdpSocket

This structure represents a UDP socket.

Function Documentation

otError otUdpBind	(	otUdpSocket *	aSocket,
		otSockAddr *	aSockName
	)

Bind a UDP/IPv6 socket.

Parameters

[in]	aSocket	A pointer to a UDP socket structure.
[in]	aSockName	A pointer to an IPv6 socket address structure.

Return values

OT_ERROR_NONE

Bind operation was successful.

See Also

otUdpNewMessage

otUdpOpen

otUdpConnect

otUdpClose

otUdpSend

otError otUdpClose

(

otUdpSocket *

aSocket

)

Close a UDP/IPv6 socket.

Parameters

[in]

aSocket

A pointer to a UDP socket structure.

Return values

OT_ERROR_NONE

Successfully closed the socket.

See Also

otUdpNewMessage

otUdpOpen

otUdpBind

otUdpConnect

otUdpSend

otError otUdpConnect	(	otUdpSocket *	aSocket,
		otSockAddr *	aSockName
	)

Connect a UDP/IPv6 socket.

Parameters

[in]	aSocket	A pointer to a UDP socket structure.
[in]	aSockName	A pointer to an IPv6 socket address structure.

Return values

OT_ERROR_NONE

Connect operation was successful.

See Also

otUdpNewMessage

otUdpOpen

otUdpBind

otUdpClose

otUdpSend

otMessage* otUdpNewMessage	(	otInstance *	aInstance,
		bool	aLinkSecurityEnabled
	)

Allocate a new message buffer for sending a UDP message.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aLinkSecurityEnabled	TRUE if the message should be secured at Layer 2.

Returns

A pointer to the message buffer or NULL if no message buffers are available.

See Also

otFreeMessage

otError otUdpOpen	(	otInstance *	aInstance,
		otUdpSocket *	aSocket,
		otUdpReceive	aCallback,
		void *	aContext
	)

Open a UDP/IPv6 socket.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aSocket	A pointer to a UDP socket structure.
[in]	aCallback	A pointer to the application callback function.
[in]	aContext	A pointer to application-specific context.

Return values

OT_ERROR_NONE	Successfully opened the socket.
OT_ERROR_INVALID_ARGS	Given socket structure was already opened.

See Also

otUdpNewMessage

otUdpClose

otUdpBind

otUdpConnect

otUdpSend

otError otUdpSend	(	otUdpSocket *	aSocket,
		otMessage *	aMessage,
		const otMessageInfo *	aMessageInfo
	)

Send a UDP/IPv6 message.

Parameters

[in]	aSocket	A pointer to a UDP socket structure.
[in]	aMessage	A pointer to a message buffer.
[in]	aMessageInfo	A pointer to a message info structure.

See Also

otUdpNewMessage

otUdpOpen

otUdpClose

otUdpBind

otUdpConnect

otUdpSend