IPv6#
This module includes functions that control IPv6 communication.
Modules#
Enumerations#
IPv6 Address origins.
ECN statuses, represented as in the IP header.
Internet Protocol Numbers.
Typedefs#
Represents the Interface Identifier of an IPv6 address.
Represents the Network Prefix of an IPv6 address (most significant 64 bits of the address).
Represents the components of an IPv6 address.
Represents an IPv6 address.
Represents an IPv6 prefix.
Represents an IPv6 network interface unicast address.
Represents an IPv6 network interface multicast address.
Represents an IPv6 socket address.
Represents the local and peer IPv6 socket addresses.
Pointer is called when an IPv6 datagram is received.
Represents IPv6 address information.
Pointer is called when an internal IPv6 address is added or removed.
Pointer allows user to filter prefixes and not allow an SLAAC address based on a prefix to be added.
Pointer is called with results of otIp6RegisterMulticastListeners
.
Represents the counters for packets and bytes.
Represents the counters of packets forwarded via Border Routing.
Variables#
Functions#
Brings the IPv6 interface up or down.
Indicates whether or not the IPv6 interface is up.
Adds a Network Interface Address to the Thread interface.
Removes a Network Interface Address from the Thread interface.
Gets the list of IPv6 addresses assigned to the Thread interface.
Indicates whether or not a unicast IPv6 address is assigned to the Thread interface.
Subscribes the Thread interface to a Network Interface Multicast Address.
Unsubscribes the Thread interface to a Network Interface Multicast Address.
Gets the list of IPv6 multicast addresses subscribed to the Thread interface.
Checks if multicast promiscuous mode is enabled on the Thread interface.
Enables or disables multicast promiscuous mode on the Thread interface.
Allocate a new message buffer for sending an IPv6 message.
Allocate a new message buffer and write the IPv6 datagram to the message buffer for sending an IPv6 message.
Registers a callback to provide received IPv6 datagrams.
Registers a callback to notify internal IPv6 address changes.
Indicates whether or not Thread control traffic is filtered out when delivering IPv6 datagrams via the callback specified in otIp6SetReceiveCallback().
Sets whether or not Thread control traffic is filtered out when delivering IPv6 datagrams via the callback specified in otIp6SetReceiveCallback().
Adds a port to the allowed unsecured port list.
Removes a port from the allowed unsecure port list.
Removes all ports from the allowed unsecure port list.
Returns a pointer to the unsecure port list.
Test if two IPv6 addresses are the same.
Test if two IPv6 prefixes are the same.
Converts a human-readable IPv6 address string into a binary representation.
Converts a human-readable IPv6 prefix string into a binary representation.
Converts a given IPv6 address to a human-readable string.
Converts a given IPv6 socket address to a human-readable string.
Converts a given IPv6 prefix to a human-readable string.
Returns the prefix match length (bits) for two IPv6 addresses.
Gets a prefix with aLength
from aAddress
.
Indicates whether or not a given IPv6 address is the Unspecified Address.
Perform OpenThread source address selection.
Indicates whether the SLAAC module is enabled or not.
Enables/disables the SLAAC module.
Sets the SLAAC module filter handler.
Registers Multicast Listeners to Primary Backbone Router.
Sets the Mesh Local IID (for test purpose).
Converts a given IP protocol number to a human-readable string.
Gets the Border Routing counters.
Resets the Border Routing counters.
Macros#
Size of an IPv6 prefix (bytes)
Size of an IPv6 prefix (bits)
Size of an IPv6 Interface Identifier (bytes)
Size of an IPv6 address (bytes)
Size of an IPv6 address (bits)
Size of an IPv6 header (bytes)
Offset of the proto field in the IPv6 header (bytes)
Recommended size for string representation of an IPv6 address.
Recommended size for string representation of an IPv6 socket address.
Recommended size for string representation of an IPv6 prefix.
Max number of IPv6 addresses supported by Multicast Listener Registration.
Enumeration Documentation#
@2#
@2
IPv6 Address origins.
Enumerator | |
---|---|
OT_ADDRESS_ORIGIN_THREAD | Thread assigned address (ALOC, RLOC, MLEID, etc) |
OT_ADDRESS_ORIGIN_SLAAC | SLAAC assigned address. |
OT_ADDRESS_ORIGIN_DHCPV6 | DHCPv6 assigned address. |
OT_ADDRESS_ORIGIN_MANUAL | Manually assigned address. |
170
of file include/openthread/ip6.h
@3#
@3
ECN statuses, represented as in the IP header.
Enumerator | |
---|---|
OT_ECN_NOT_CAPABLE | Non-ECT. |
OT_ECN_CAPABLE_0 | ECT(0) |
OT_ECN_CAPABLE_1 | ECT(1) |
OT_ECN_MARKED | Congestion encountered (CE) |
221
of file include/openthread/ip6.h
@4#
@4
Internet Protocol Numbers.
Enumerator | |
---|---|
OT_IP6_PROTO_HOP_OPTS | IPv6 Hop-by-Hop Option. |
OT_IP6_PROTO_TCP | Transmission Control Protocol. |
OT_IP6_PROTO_UDP | User Datagram. |
OT_IP6_PROTO_IP6 | IPv6 encapsulation. |
OT_IP6_PROTO_ROUTING | Routing Header for IPv6. |
OT_IP6_PROTO_FRAGMENT | Fragment Header for IPv6. |
OT_IP6_PROTO_ICMP6 | ICMP for IPv6. |
OT_IP6_PROTO_NONE | No Next Header for IPv6. |
OT_IP6_PROTO_DST_OPTS | Destination Options for IPv6. |
252
of file include/openthread/ip6.h
Typedef Documentation#
otIp6InterfaceIdentifier#
typedef struct otIp6InterfaceIdentifier otIp6InterfaceIdentifier
Represents the Interface Identifier of an IPv6 address.
84
of file include/openthread/ip6.h
otIp6NetworkPrefix#
typedef struct otIp6NetworkPrefix otIp6NetworkPrefix
Represents the Network Prefix of an IPv6 address (most significant 64 bits of the address).
102
of file include/openthread/ip6.h
otIp6AddressComponents#
typedef struct otIp6AddressComponents otIp6AddressComponents
Represents the components of an IPv6 address.
121
of file include/openthread/ip6.h
otIp6Address#
typedef struct otIp6Address otIp6Address
Represents an IPv6 address.
145
of file include/openthread/ip6.h
otIp6Prefix#
typedef struct otIp6Prefix otIp6Prefix
Represents an IPv6 prefix.
164
of file include/openthread/ip6.h
otNetifAddress#
typedef struct otNetifAddress otNetifAddress
Represents an IPv6 network interface unicast address.
195
of file include/openthread/ip6.h
otNetifMulticastAddress#
typedef struct otNetifMulticastAddress otNetifMulticastAddress
Represents an IPv6 network interface multicast address.
205
of file include/openthread/ip6.h
otSockAddr#
typedef struct otSockAddr otSockAddr
Represents an IPv6 socket address.
215
of file include/openthread/ip6.h
otMessageInfo#
typedef struct otMessageInfo otMessageInfo
Represents the local and peer IPv6 socket addresses.
246
of file include/openthread/ip6.h
otIp6ReceiveCallback#
typedef void(* otIp6ReceiveCallback) (otMessage *aMessage, void *aContext) )(otMessage *aMessage, void *aContext)
Pointer is called when an IPv6 datagram is received.
[in] | aMessage | A pointer to the message buffer containing the received IPv6 datagram. This function transfers the ownership of the |
[in] | aContext | A pointer to application-specific context. |
452
of file include/openthread/ip6.h
otIp6AddressInfo#
typedef struct otIp6AddressInfo otIp6AddressInfo
Represents IPv6 address information.
482
of file include/openthread/ip6.h
otIp6AddressCallback#
typedef void(* otIp6AddressCallback) (const otIp6AddressInfo *aAddressInfo, bool aIsAdded, void *aContext) )(const otIp6AddressInfo *aAddressInfo, bool aIsAdded, void *aContext)
Pointer is called when an internal IPv6 address is added or removed.
[in] | aAddressInfo | A pointer to the IPv6 address information. |
[in] | aIsAdded | TRUE if the |
[in] | aContext | A pointer to application-specific context. |
492
of file include/openthread/ip6.h
otIp6SlaacPrefixFilter#
typedef bool(* otIp6SlaacPrefixFilter) (otInstance *aInstance, const otIp6Prefix *aPrefix) )(otInstance *aInstance, const otIp6Prefix *aPrefix)
Pointer allows user to filter prefixes and not allow an SLAAC address based on a prefix to be added.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aPrefix | A pointer to prefix for which SLAAC address is about to be added. |
otIp6SetSlaacPrefixFilter()
can be used to set the filter handler. The filter handler is invoked by SLAAC module when it is about to add a SLAAC address based on a prefix. Its boolean return value determines whether the address is filtered (not added) or not.
792
of file include/openthread/ip6.h
otIp6RegisterMulticastListenersCallback#
typedef void(* otIp6RegisterMulticastListenersCallback) (void *aContext, otError aError, uint8_t aMlrStatus, const otIp6Address *aFailedAddresses, uint8_t aFailedAddressNum) )(void *aContext, otError aError, uint8_t aMlrStatus, const otIp6Address *aFailedAddresses, uint8_t aFailedAddressNum)
Pointer is called with results of otIp6RegisterMulticastListeners
.
[in] | aContext | A pointer to the user context. |
[in] | aError | OT_ERROR_NONE when successfully sent MLR.req and received MLR.rsp, OT_ERROR_RESPONSE_TIMEOUT when failed to receive MLR.rsp, OT_ERROR_PARSE when failed to parse MLR.rsp. |
[in] | aMlrStatus | The Multicast Listener Registration status when |
[in] | aFailedAddresses | A pointer to the failed IPv6 addresses when |
[in] | aFailedAddressNum | The number of failed IPv6 addresses when |
See Also
826
of file include/openthread/ip6.h
otPacketsAndBytes#
typedef struct otPacketsAndBytes otPacketsAndBytes
Represents the counters for packets and bytes.
899
of file include/openthread/ip6.h
otBorderRoutingCounters#
typedef struct otBorderRoutingCounters otBorderRoutingCounters
Represents the counters of packets forwarded via Border Routing.
919
of file include/openthread/ip6.h
Variable Documentation#
OT_TOOL_PACKED_END#
OT_TOOL_PACKED_BEGIN struct otIp6Prefix OT_TOOL_PACKED_END
78
of file include/openthread/ip6.h
Function Documentation#
otIp6SetEnabled#
otError otIp6SetEnabled (otInstance * aInstance, bool aEnabled)
Brings the IPv6 interface up or down.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aEnabled | TRUE to enable IPv6, FALSE otherwise. |
Call this to enable or disable IPv6 communication.
278
of file include/openthread/ip6.h
otIp6IsEnabled#
bool otIp6IsEnabled (otInstance * aInstance)
Indicates whether or not the IPv6 interface is up.
[in] | aInstance | A pointer to an OpenThread instance. |
289
of file include/openthread/ip6.h
otIp6AddUnicastAddress#
otError otIp6AddUnicastAddress (otInstance * aInstance, const otNetifAddress * aAddress)
Adds a Network Interface Address to the Thread interface.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aAddress | A pointer to a Network Interface Address. |
The passed-in instance aAddress
is copied by the Thread interface. The Thread interface only supports a fixed number of externally added unicast addresses. See OPENTHREAD_CONFIG_IP6_MAX_EXT_UCAST_ADDRS
.
305
of file include/openthread/ip6.h
otIp6RemoveUnicastAddress#
otError otIp6RemoveUnicastAddress (otInstance * aInstance, const otIp6Address * aAddress)
Removes a Network Interface Address from the Thread interface.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aAddress | A pointer to an IP Address. |
318
of file include/openthread/ip6.h
otIp6GetUnicastAddresses#
const otNetifAddress * otIp6GetUnicastAddresses (otInstance * aInstance)
Gets the list of IPv6 addresses assigned to the Thread interface.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
A pointer to the first Network Interface Address.
328
of file include/openthread/ip6.h
otIp6HasUnicastAddress#
bool otIp6HasUnicastAddress (otInstance * aInstance, const otIp6Address * aAddress)
Indicates whether or not a unicast IPv6 address is assigned to the Thread interface.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aAddress | A pointer to the unicast address. |
340
of file include/openthread/ip6.h
otIp6SubscribeMulticastAddress#
otError otIp6SubscribeMulticastAddress (otInstance * aInstance, const otIp6Address * aAddress)
Subscribes the Thread interface to a Network Interface Multicast Address.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aAddress | A pointer to an IP Address. |
The passed in instance aAddress
will be copied by the Thread interface. The Thread interface only supports a fixed number of externally added multicast addresses. See OPENTHREAD_CONFIG_IP6_MAX_EXT_MCAST_ADDRS
.
359
of file include/openthread/ip6.h
otIp6UnsubscribeMulticastAddress#
otError otIp6UnsubscribeMulticastAddress (otInstance * aInstance, const otIp6Address * aAddress)
Unsubscribes the Thread interface to a Network Interface Multicast Address.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aAddress | A pointer to an IP Address. |
372
of file include/openthread/ip6.h
otIp6GetMulticastAddresses#
const otNetifMulticastAddress * otIp6GetMulticastAddresses (otInstance * aInstance)
Gets the list of IPv6 multicast addresses subscribed to the Thread interface.
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
A pointer to the first Network Interface Multicast Address.
382
of file include/openthread/ip6.h
otIp6IsMulticastPromiscuousEnabled#
bool otIp6IsMulticastPromiscuousEnabled (otInstance * aInstance)
Checks if multicast promiscuous mode is enabled on the Thread interface.
[in] | aInstance | A pointer to an OpenThread instance. |
See Also
392
of file include/openthread/ip6.h
otIp6SetMulticastPromiscuousEnabled#
void otIp6SetMulticastPromiscuousEnabled (otInstance * aInstance, bool aEnabled)
Enables or disables multicast promiscuous mode on the Thread interface.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aEnabled | TRUE to enable Multicast Promiscuous mode, FALSE otherwise. |
See Also
403
of file include/openthread/ip6.h
otIp6NewMessage#
otMessage * otIp6NewMessage (otInstance * aInstance, const otMessageSettings * aSettings)
Allocate a new message buffer for sending an IPv6 message.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aSettings | A pointer to the message settings or NULL to set default settings. |
Note
If
aSettings
is 'NULL', the link layer security is enabled and the message priority is set to OT_MESSAGE_PRIORITY_NORMAL by default.
Returns
A pointer to the message buffer or NULL if no message buffers are available or parameters are invalid.
See Also
419
of file include/openthread/ip6.h
otIp6NewMessageFromBuffer#
otMessage * otIp6NewMessageFromBuffer (otInstance * aInstance, const uint8_t * aData, uint16_t aDataLength, const otMessageSettings * aSettings)
Allocate a new message buffer and write the IPv6 datagram to the message buffer for sending an IPv6 message.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aData | A pointer to the IPv6 datagram buffer. |
[in] | aDataLength | The size of the IPv6 datagram buffer pointed by |
[in] | aSettings | A pointer to the message settings or NULL to set default settings. |
Note
If
aSettings
is NULL, the link layer security is enabled and the message priority is obtained from IPv6 message itself. IfaSettings
is not NULL, theaSetting->mPriority
is ignored and obtained from IPv6 message itself.
Returns
A pointer to the message or NULL if malformed IPv6 header or insufficient message buffers are available.
See Also
438
of file include/openthread/ip6.h
otIp6SetReceiveCallback#
void otIp6SetReceiveCallback (otInstance * aInstance, otIp6ReceiveCallback aCallback, void * aCallbackContext)
Registers a callback to provide received IPv6 datagrams.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aCallback | A pointer to a function that is called when an IPv6 datagram is received or NULL to disable the callback. |
[in] | aCallbackContext | A pointer to application-specific context. |
By default, this callback does not pass Thread control traffic. See otIp6SetReceiveFilterEnabled() to change the Thread control traffic filter setting.
See Also
469
of file include/openthread/ip6.h
otIp6SetAddressCallback#
void otIp6SetAddressCallback (otInstance * aInstance, otIp6AddressCallback aCallback, void * aCallbackContext)
Registers a callback to notify internal IPv6 address changes.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aCallback | A pointer to a function that is called when an internal IPv6 address is added or removed. NULL to disable the callback. |
[in] | aCallbackContext | A pointer to application-specific context. |
503
of file include/openthread/ip6.h
otIp6IsReceiveFilterEnabled#
bool otIp6IsReceiveFilterEnabled (otInstance * aInstance)
Indicates whether or not Thread control traffic is filtered out when delivering IPv6 datagrams via the callback specified in otIp6SetReceiveCallback().
[in] | aInstance | A pointer to an OpenThread instance. |
Returns
TRUE if Thread control traffic is filtered out, FALSE otherwise.
See Also
517
of file include/openthread/ip6.h
otIp6SetReceiveFilterEnabled#
void otIp6SetReceiveFilterEnabled (otInstance * aInstance, bool aEnabled)
Sets whether or not Thread control traffic is filtered out when delivering IPv6 datagrams via the callback specified in otIp6SetReceiveCallback().
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aEnabled | TRUE if Thread control traffic is filtered out, FALSE otherwise. |
See Also
otIsReceiveIp6FilterEnabled
530
of file include/openthread/ip6.h
otIp6Send#
otError otIp6Send (otInstance * aInstance, otMessage * aMessage)
Sends an IPv6 datagram via the Thread interface.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aMessage | A pointer to the message buffer containing the IPv6 datagram. |
The caller transfers ownership of aMessage
when making this call. OpenThread will free aMessage
when processing is complete, including when a value other than OT_ERROR_NONE
is returned.
552
of file include/openthread/ip6.h
otIp6AddUnsecurePort#
otError otIp6AddUnsecurePort (otInstance * aInstance, uint16_t aPort)
Adds a port to the allowed unsecured port list.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aPort | The port value. |
565
of file include/openthread/ip6.h
otIp6RemoveUnsecurePort#
otError otIp6RemoveUnsecurePort (otInstance * aInstance, uint16_t aPort)
Removes a port from the allowed unsecure port list.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aPort | The port value. |
Note
This function removes
aPort
by overwritingaPort
with the element afteraPort
in the internal port list. Be careful when calling otIp6GetUnsecurePorts() followed by otIp6RemoveUnsecurePort() to remove unsecure ports.
582
of file include/openthread/ip6.h
otIp6RemoveAllUnsecurePorts#
void otIp6RemoveAllUnsecurePorts (otInstance * aInstance)
Removes all ports from the allowed unsecure port list.
[in] | aInstance | A pointer to an OpenThread instance. |
590
of file include/openthread/ip6.h
otIp6GetUnsecurePorts#
const uint16_t * otIp6GetUnsecurePorts (otInstance * aInstance, uint8_t * aNumEntries)
Returns a pointer to the unsecure port list.
[in] | aInstance | A pointer to an OpenThread instance. |
[out] | aNumEntries | The number of entries in the list. |
Note
Port value 0 is used to indicate an invalid entry.
Returns
A pointer to the unsecure port list.
603
of file include/openthread/ip6.h
otIp6IsAddressEqual#
bool otIp6IsAddressEqual (const otIp6Address * aFirst, const otIp6Address * aSecond)
Test if two IPv6 addresses are the same.
[in] | aFirst | A pointer to the first IPv6 address to compare. |
[in] | aSecond | A pointer to the second IPv6 address to compare. |
615
of file include/openthread/ip6.h
otIp6ArePrefixesEqual#
bool otIp6ArePrefixesEqual (const otIp6Prefix * aFirst, const otIp6Prefix * aSecond)
Test if two IPv6 prefixes are the same.
[in] | aFirst | A pointer to the first IPv6 prefix to compare. |
[in] | aSecond | A pointer to the second IPv6 prefix to compare. |
627
of file include/openthread/ip6.h
otIp6AddressFromString#
otError otIp6AddressFromString (const char * aString, otIp6Address * aAddress)
Converts a human-readable IPv6 address string into a binary representation.
[in] | aString | A pointer to a NULL-terminated string. |
[out] | aAddress | A pointer to an IPv6 address. |
639
of file include/openthread/ip6.h
otIp6PrefixFromString#
otError otIp6PrefixFromString (const char * aString, otIp6Prefix * aPrefix)
Converts a human-readable IPv6 prefix string into a binary representation.
[in] | aString | A pointer to a NULL-terminated string. |
[out] | aPrefix | A pointer to an IPv6 prefix. |
The aString
parameter should be a string in the format "<address>/<plen>", where <address>
is an IPv6 address and <plen>
is a prefix length.
654
of file include/openthread/ip6.h
otIp6AddressToString#
void otIp6AddressToString (const otIp6Address * aAddress, char * aBuffer, uint16_t aSize)
Converts a given IPv6 address to a human-readable string.
[in] | aAddress | A pointer to an IPv6 address (MUST NOT be NULL). |
[out] | aBuffer | A pointer to a char array to output the string (MUST NOT be NULL). |
[in] | aSize | The size of |
The IPv6 address string is formatted as 16 hex values separated by ':' (i.e., "%x:%x:%x:...:%x").
If the resulting string does not fit in aBuffer
(within its aSize
characters), the string will be truncated but the outputted string is always null-terminated.
671
of file include/openthread/ip6.h
otIp6SockAddrToString#
void otIp6SockAddrToString (const otSockAddr * aSockAddr, char * aBuffer, uint16_t aSize)
Converts a given IPv6 socket address to a human-readable string.
[in] | aSockAddr | A pointer to an IPv6 socket address (MUST NOT be NULL). |
[out] | aBuffer | A pointer to a char array to output the string (MUST NOT be NULL). |
[in] | aSize | The size of |
The IPv6 socket address string is formatted as [address
]:port
where address
is shown as 16 hex values separated by :
and port
is the port number in decimal format, for example "[%x:%x:...:%x]:%u".
If the resulting string does not fit in aBuffer
(within its aSize
characters), the string will be truncated but the outputted string is always null-terminated.
690
of file include/openthread/ip6.h
otIp6PrefixToString#
void otIp6PrefixToString (const otIp6Prefix * aPrefix, char * aBuffer, uint16_t aSize)
Converts a given IPv6 prefix to a human-readable string.
[in] | aPrefix | A pointer to an IPv6 prefix (MUST NOT be NULL). |
[out] | aBuffer | A pointer to a char array to output the string (MUST NOT be NULL). |
[in] | aSize | The size of |
The IPv6 address string is formatted as "%x:%x:%x:...[::]/plen".
If the resulting string does not fit in aBuffer
(within its aSize
characters), the string will be truncated but the outputted string is always null-terminated.
707
of file include/openthread/ip6.h
otIp6PrefixMatch#
uint8_t otIp6PrefixMatch (const otIp6Address * aFirst, const otIp6Address * aSecond)
Returns the prefix match length (bits) for two IPv6 addresses.
[in] | aFirst | A pointer to the first IPv6 address. |
[in] | aSecond | A pointer to the second IPv6 address. |
Returns
The prefix match length in bits.
718
of file include/openthread/ip6.h
otIp6GetPrefix#
void otIp6GetPrefix (const otIp6Address * aAddress, uint8_t aLength, otIp6Prefix * aPrefix)
Gets a prefix with aLength
from aAddress
.
[in] | aAddress | A pointer to an IPv6 address. |
[in] | aLength | The length of prefix in bits. |
[out] | aPrefix | A pointer to output the IPv6 prefix. |
728
of file include/openthread/ip6.h
otIp6IsAddressUnspecified#
bool otIp6IsAddressUnspecified (const otIp6Address * aAddress)
Indicates whether or not a given IPv6 address is the Unspecified Address.
[in] | aAddress | A pointer to an IPv6 address. |
739
of file include/openthread/ip6.h
otIp6SelectSourceAddress#
otError otIp6SelectSourceAddress (otInstance * aInstance, otMessageInfo * aMessageInfo)
Perform OpenThread source address selection.
[in] | aInstance | A pointer to an OpenThread instance. |
[inout] | aMessageInfo | A pointer to the message information. |
751
of file include/openthread/ip6.h
otIp6IsSlaacEnabled#
bool otIp6IsSlaacEnabled (otInstance * aInstance)
Indicates whether the SLAAC module is enabled or not.
N/A | aInstance |
OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE
build-time feature must be enabled.
762
of file include/openthread/ip6.h
otIp6SetSlaacEnabled#
void otIp6SetSlaacEnabled (otInstance * aInstance, bool aEnabled)
Enables/disables the SLAAC module.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aEnabled | TRUE to enable, FALSE to disable. |
OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE
build-time feature must be enabled.
When SLAAC module is enabled, SLAAC addresses (based on on-mesh prefixes in Network Data) are added to the interface. When SLAAC module is disabled any previously added SLAAC address is removed.
776
of file include/openthread/ip6.h
otIp6SetSlaacPrefixFilter#
void otIp6SetSlaacPrefixFilter (otInstance * aInstance, otIp6SlaacPrefixFilter aFilter)
Sets the SLAAC module filter handler.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aFilter | A pointer to SLAAC prefix filter handler, or NULL to disable filtering. |
OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE
build-time feature must be enabled.
The filter handler is called by SLAAC module when it is about to add a SLAAC address based on a prefix to decide whether the address should be added or not.
A NULL filter handler disables filtering and allows all SLAAC addresses to be added.
If this function is not called, the default filter used by SLAAC module will be NULL (filtering is disabled).
810
of file include/openthread/ip6.h
otIp6RegisterMulticastListeners#
otError otIp6RegisterMulticastListeners (otInstance * aInstance, const otIp6Address * aAddresses, uint8_t aAddressNum, const uint32_t * aTimeout, otIp6RegisterMulticastListenersCallback aCallback, void * aContext)
Registers Multicast Listeners to Primary Backbone Router.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aAddresses | A Multicast Address Array to register. |
[in] | aAddressNum | The number of Multicast Address to register (0 if |
[in] | aTimeout | A pointer to the timeout value (in seconds) to be included in MLR.req. A timeout value of 0 removes the corresponding Multicast Listener. If NULL, MLR.req would have no Timeout Tlv by default. |
[in] | aCallback | A pointer to the callback function. |
[in] | aContext | A pointer to the user context. |
OPENTHREAD_CONFIG_TMF_PROXY_MLR_ENABLE
and OPENTHREAD_CONFIG_COMMISSIONER_ENABLE
must be enabled.
See Also
860
of file include/openthread/ip6.h
otIp6SetMeshLocalIid#
otError otIp6SetMeshLocalIid (otInstance * aInstance, const otIp6InterfaceIdentifier * aIid)
Sets the Mesh Local IID (for test purpose).
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aIid | A pointer to the Mesh Local IID to set. |
Requires OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
.
879
of file include/openthread/ip6.h
otIp6ProtoToString#
const char * otIp6ProtoToString (uint8_t aIpProto)
Converts a given IP protocol number to a human-readable string.
[in] | aIpProto | An IP protocol number ( |
Returns
A string representing
aIpProto
.
889
of file include/openthread/ip6.h
otIp6GetBorderRoutingCounters#
const otBorderRoutingCounters * otIp6GetBorderRoutingCounters (otInstance * aInstance)
Gets the Border Routing counters.
[in] | aInstance | A pointer to an OpenThread instance. |
OPENTHREAD_CONFIG_IP6_BR_COUNTERS_ENABLE
build-time feature must be enabled.
Returns
A pointer to the Border Routing counters.
931
of file include/openthread/ip6.h
otIp6ResetBorderRoutingCounters#
void otIp6ResetBorderRoutingCounters (otInstance * aInstance)
Resets the Border Routing counters.
[in] | aInstance | A pointer to an OpenThread instance. |
939
of file include/openthread/ip6.h
Macro Definition Documentation#
OT_IP6_PREFIX_SIZE#
#define OT_IP6_PREFIX_SIZEValue:
8
Size of an IPv6 prefix (bytes)
55
of file include/openthread/ip6.h
OT_IP6_PREFIX_BITSIZE#
#define OT_IP6_PREFIX_BITSIZEValue:
(OT_IP6_PREFIX_SIZE * 8)
Size of an IPv6 prefix (bits)
56
of file include/openthread/ip6.h
OT_IP6_IID_SIZE#
#define OT_IP6_IID_SIZEValue:
8
Size of an IPv6 Interface Identifier (bytes)
57
of file include/openthread/ip6.h
OT_IP6_ADDRESS_SIZE#
#define OT_IP6_ADDRESS_SIZEValue:
16
Size of an IPv6 address (bytes)
58
of file include/openthread/ip6.h
OT_IP6_ADDRESS_BITSIZE#
#define OT_IP6_ADDRESS_BITSIZEValue:
(OT_IP6_ADDRESS_SIZE * 8)
Size of an IPv6 address (bits)
59
of file include/openthread/ip6.h
OT_IP6_HEADER_SIZE#
#define OT_IP6_HEADER_SIZEValue:
40
Size of an IPv6 header (bytes)
60
of file include/openthread/ip6.h
OT_IP6_HEADER_PROTO_OFFSET#
#define OT_IP6_HEADER_PROTO_OFFSETValue:
6
Offset of the proto field in the IPv6 header (bytes)
61
of file include/openthread/ip6.h
OT_IP6_ADDRESS_STRING_SIZE#
#define OT_IP6_ADDRESS_STRING_SIZEValue:
40
Recommended size for string representation of an IPv6 address.
656
of file include/openthread/ip6.h
OT_IP6_SOCK_ADDR_STRING_SIZE#
#define OT_IP6_SOCK_ADDR_STRING_SIZEValue:
48
Recommended size for string representation of an IPv6 socket address.
673
of file include/openthread/ip6.h
OT_IP6_PREFIX_STRING_SIZE#
#define OT_IP6_PREFIX_STRING_SIZEValue:
45
Recommended size for string representation of an IPv6 prefix.
692
of file include/openthread/ip6.h
OT_IP6_MAX_MLR_ADDRESSES#
#define OT_IP6_MAX_MLR_ADDRESSESValue:
15
Max number of IPv6 addresses supported by Multicast Listener Registration.
832
of file include/openthread/ip6.h