ICMPv6

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

Classes
struct	otIcmp6Header
	This structure represents an ICMPv6 header. More...
struct	otIcmp6Handler
	This structure implements ICMPv6 message handler. More...

Macros
#define	OT_ICMP6_HEADER_DATA_SIZE   4
	Size of an message specific data of ICMPv6 Header.

Typedefs
typedef enum otIcmp6Type	otIcmp6Type
	ICMPv6 Message Types. More...
typedef enum otIcmp6Code	otIcmp6Code
	ICMPv6 Message Codes. More...
typedef struct otIcmp6Header	otIcmp6Header
	This type represents an ICMPv6 header.
typedef void(*	otIcmp6ReceiveCallback) (void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otIcmp6Header *aIcmpHeader)
	This callback allows OpenThread to inform the application of a received ICMPv6 message. More...
typedef struct otIcmp6Handler	otIcmp6Handler
	This structure implements ICMPv6 message handler.

Enumerations
enum	otIcmp6Type {   OT_ICMP6_TYPE_DST_UNREACH = 1,   OT_ICMP6_TYPE_ECHO_REQUEST = 128,   OT_ICMP6_TYPE_ECHO_REPLY = 129 }
	ICMPv6 Message Types. More...
enum	otIcmp6Code { OT_ICMP6_CODE_DST_UNREACH_NO_ROUTE = 0 }
	ICMPv6 Message Codes. More...

Functions
bool	otIcmp6IsEchoEnabled (otInstance *aInstance)
	This function indicates whether or not ICMPv6 Echo processing is enabled. More...
void	otIcmp6SetEchoEnabled (otInstance *aInstance, bool aEnabled)
	This function sets whether or not ICMPv6 Echo processing is enabled. More...
otError	otIcmp6RegisterHandler (otInstance *aInstance, otIcmp6Handler *aHandler)
	This function registers a handler to provide received ICMPv6 messages. More...
otError	otIcmp6SendEchoRequest (otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, uint16_t aIdentifier)
	This function sends an ICMPv6 Echo Request via the Thread interface. More...

Variables
OT_TOOL_PACKED_BEGIN struct otIcmp6Header	OT_TOOL_PACKED_END

Detailed Description

This module includes functions that control ICMPv6 communication.

Typedef Documentation

otIcmp6Code

typedef enum otIcmp6Code otIcmp6Code

ICMPv6 Message Codes.

otIcmp6ReceiveCallback

typedef void(* otIcmp6ReceiveCallback) (void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otIcmp6Header *aIcmpHeader)

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

Parameters

[in]	aContext	A pointer to arbitrary context information.
[in]	aMessage	A pointer to the received message.
[in]	aMessageInfo	A pointer to message information associated with aMessage.
[in]	aIcmpHeader	A pointer to the received ICMPv6 header.

otIcmp6Type

typedef enum otIcmp6Type otIcmp6Type

ICMPv6 Message Types.

Enumeration Type Documentation

otIcmp6Code

enum otIcmp6Code

ICMPv6 Message Codes.

Enumerator
OT_ICMP6_CODE_DST_UNREACH_NO_ROUTE	Destination Unreachable No Route.

otIcmp6Type

enum otIcmp6Type

ICMPv6 Message Types.

Enumerator
OT_ICMP6_TYPE_DST_UNREACH	Destination Unreachable.
OT_ICMP6_TYPE_ECHO_REQUEST	Echo Request.
OT_ICMP6_TYPE_ECHO_REPLY	Echo Reply.

Function Documentation

otIcmp6IsEchoEnabled()

bool otIcmp6IsEchoEnabled

(

otInstance *

aInstance

)

This function indicates whether or not ICMPv6 Echo processing is enabled.

Parameters

[in]

aInstance

A pointer to an OpenThread instance.

Return values

TRUE	ICMPv6 Echo processing is enabled.
FALSE	ICMPv6 Echo processing is disabled.

otIcmp6RegisterHandler()

otError otIcmp6RegisterHandler	(	otInstance *	aInstance,
		otIcmp6Handler *	aHandler
	)

This function registers a handler to provide received ICMPv6 messages.

Note

A handler structure aHandler has to be stored in persistent (static) memory. OpenThread does not make a copy of handler structure.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aHandler	A pointer to a handler conitaining callback that is called when an ICMPv6 message is received.

otIcmp6SendEchoRequest()

otError otIcmp6SendEchoRequest	(	otInstance *	aInstance,
		otMessage *	aMessage,
		const otMessageInfo *	aMessageInfo,
		uint16_t	aIdentifier
	)

This function sends an ICMPv6 Echo Request via the Thread interface.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aMessage	A pointer to the message buffer containing the ICMPv6 payload.
[in]	aMessageInfo	A reference to message information associated with aMessage.
[in]	aIdentifier	An identifier to aid in matching Echo Replies to this Echo Request. May be zero.

otIcmp6SetEchoEnabled()

void otIcmp6SetEchoEnabled	(	otInstance *	aInstance,
		bool	aEnabled
	)

This function sets whether or not ICMPv6 Echo processing is enabled.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aEnabled	TRUE to enable ICMPv6 Echo processing, FALSE otherwise.