0.01.00
icmp6.h File Reference

This file defines the top-level icmp6 functions for the OpenThread library. More...

Go to the source code of this file.

Classes

struct  otIcmp6Header
 This structure represents an ICMPv6 header. More...
 
union  otIcmp6Header::OT_TOOL_PACKED_FIELD
 
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 file defines the top-level icmp6 functions for the OpenThread library.