ICMPv6
This module includes functions that control ICMPv6 communication.
Summary
Enumerations |
|
---|---|
otIcmp6Code{
|
enum ICMPv6 Message Codes. |
otIcmp6EchoMode{
|
enum ICMPv6 Echo Reply Modes. |
otIcmp6Type{
|
enum ICMPv6 Message Types. |
Typedefs |
|
---|---|
otIcmp6Code
|
typedefenum otIcmp6Code
ICMPv6 Message Codes. |
otIcmp6EchoMode
|
typedefenum otIcmp6EchoMode
ICMPv6 Echo Reply Modes. |
otIcmp6Handler
|
typedefstruct otIcmp6Handler
This structure implements ICMPv6 message handler. |
otIcmp6Header
|
typedefstruct otIcmp6Header
This type represents an ICMPv6 header. |
otIcmp6ReceiveCallback)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otIcmp6Header *aIcmpHeader)
|
typedefvoid(*
This callback allows OpenThread to inform the application of a received ICMPv6 message. |
otIcmp6Type
|
typedefenum otIcmp6Type
ICMPv6 Message Types. |
Variables |
|
---|---|
OT_TOOL_PACKED_END
|
Functions |
|
---|---|
otIcmp6GetEchoMode(otInstance *aInstance)
|
This function indicates whether or not ICMPv6 Echo processing is enabled.
|
otIcmp6RegisterHandler(otInstance *aInstance, otIcmp6Handler *aHandler)
|
This function registers a handler to provide received ICMPv6 messages.
|
otIcmp6SendEchoRequest(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, uint16_t aIdentifier)
|
This function sends an ICMPv6 Echo Request via the Thread interface.
|
otIcmp6SetEchoMode(otInstance *aInstance, otIcmp6EchoMode aMode)
|
void
This function sets whether or not ICMPv6 Echo processing is enabled.
|
Structs |
|
---|---|
otIcmp6Handler |
This structure implements ICMPv6 message handler. |
otIcmp6Header |
This structure represents an ICMPv6 header. |
Unions |
|
---|---|
otIcmp6Header:: |
Enumerations
otIcmp6Code
otIcmp6Code
otIcmp6EchoMode
otIcmp6EchoMode
ICMPv6 Echo Reply Modes.
otIcmp6Type
otIcmp6Type
Typedefs
otIcmp6Handler
struct otIcmp6Handler otIcmp6Handler
This structure implements ICMPv6 message handler.
otIcmp6ReceiveCallback
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.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
Variables
OT_TOOL_PACKED_END
OT_TOOL_PACKED_BEGIN struct otIcmp6Header OT_TOOL_PACKED_END
Functions
otIcmp6GetEchoMode
otIcmp6EchoMode otIcmp6GetEchoMode( otInstance *aInstance )
This function indicates whether or not ICMPv6 Echo processing is enabled.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
||||||||
Return Values |
|
otIcmp6RegisterHandler
otError otIcmp6RegisterHandler( otInstance *aInstance, otIcmp6Handler *aHandler )
This function registers a handler to provide received ICMPv6 messages.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otIcmp6SendEchoRequest
otError otIcmp6SendEchoRequest( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, uint16_t aIdentifier )
This function sends an ICMPv6 Echo Request via the Thread interface.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
otIcmp6SetEchoMode
void otIcmp6SetEchoMode( otInstance *aInstance, otIcmp6EchoMode aMode )
This function sets whether or not ICMPv6 Echo processing is enabled.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
Macros
OT_ICMP6_HEADER_DATA_SIZE
OT_ICMP6_HEADER_DATA_SIZE 4
Size of an message specific data of ICMPv6 Header.