IPv6#

@3#

@3

IPv6 Address origins.

@4#

@4

ECN statuses, represented as in the IP header.

@5#

@5

Internet Protocol Numbers.

otIp6InterfaceIdentifier#

typedef struct otIp6InterfaceIdentifier otIp6InterfaceIdentifier

This structure represents the Interface Identifier of an IPv6 address.

otIp6NetworkPrefix#

typedef struct otIp6NetworkPrefix otIp6NetworkPrefix

This structure represents the Network Prefix of an IPv6 address (most significant 64 bits of the address).

otIp6AddressComponents#

typedef struct otIp6AddressComponents otIp6AddressComponents

This structure represents the components of an IPv6 address.

otIp6Address#

typedef struct otIp6Address otIp6Address

This structure represents an IPv6 address.

otIp6Prefix#

typedef struct otIp6Prefix otIp6Prefix

This structure represents an IPv6 prefix.

otNetifAddress#

typedef struct otNetifAddress otNetifAddress

This structure represents an IPv6 network interface unicast address.

otNetifMulticastAddress#

typedef struct otNetifMulticastAddress otNetifMulticastAddress

This structure represents an IPv6 network interface multicast address.

otSockAddr#

typedef struct otSockAddr otSockAddr

This structure represents an IPv6 socket address.

otMessageInfo#

typedef struct otMessageInfo otMessageInfo

This structure represents the local and peer IPv6 socket addresses.

otIp6ReceiveCallback#

typedef void(* otIp6ReceiveCallback) (otMessage *aMessage, void *aContext) )(otMessage *aMessage, void *aContext)

This function pointer is called when an IPv6 datagram is received.

otIp6AddressInfo#

typedef struct otIp6AddressInfo otIp6AddressInfo

otIp6AddressCallback#

typedef void(* otIp6AddressCallback) (const otIp6AddressInfo *aAddressInfo, bool aIsAdded, void *aContext) )(const otIp6AddressInfo *aAddressInfo, bool aIsAdded, void *aContext)

This function pointer is called when an internal IPv6 address is added or removed.

otIp6SlaacPrefixFilter#

typedef bool(* otIp6SlaacPrefixFilter) (otInstance *aInstance, const otIp6Prefix *aPrefix) )(otInstance *aInstance, const otIp6Prefix *aPrefix)

This function pointer allows user to filter prefixes and not allow an SLAAC address based on a prefix 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.

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)

This function pointer is called with results of otIp6RegisterMulticastListeners.

See Also

• otIp6RegisterMulticastListeners

otPacketsAndBytes#

typedef struct otPacketsAndBytes otPacketsAndBytes

This structure represents the counters for packets and bytes.

otBorderRoutingCounters#

typedef struct otBorderRoutingCounters otBorderRoutingCounters

This structure represents the counters of packets forwarded via Border Routing.

OT_TOOL_PACKED_END#

OT_TOOL_PACKED_BEGIN struct otIp6Prefix OT_TOOL_PACKED_END

otIp6SetEnabled#

otError otIp6SetEnabled (otInstance * aInstance, bool aEnabled)

Brings the IPv6 interface up or down.

Call this to enable or disable IPv6 communication.

otIp6IsEnabled#

bool otIp6IsEnabled (otInstance * aInstance)

Indicates whether or not the IPv6 interface is up.

otIp6AddUnicastAddress#

otError otIp6AddUnicastAddress (otInstance * aInstance, const otNetifAddress * aAddress)

Adds a Network Interface Address to the Thread interface.

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.

otIp6RemoveUnicastAddress#

otError otIp6RemoveUnicastAddress (otInstance * aInstance, const otIp6Address * aAddress)

Removes a Network Interface Address from the Thread interface.

otIp6GetUnicastAddresses#

const otNetifAddress * otIp6GetUnicastAddresses (otInstance * aInstance)

Gets the list of IPv6 addresses assigned to the Thread interface.

Returns

• A pointer to the first Network Interface Address.

otIp6SubscribeMulticastAddress#

otError otIp6SubscribeMulticastAddress (otInstance * aInstance, const otIp6Address * aAddress)

Subscribes the Thread interface to a Network Interface Multicast 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.

otIp6UnsubscribeMulticastAddress#

otError otIp6UnsubscribeMulticastAddress (otInstance * aInstance, const otIp6Address * aAddress)

Unsubscribes the Thread interface to a Network Interface Multicast Address.

otIp6GetMulticastAddresses#

const otNetifMulticastAddress * otIp6GetMulticastAddresses (otInstance * aInstance)

Gets the list of IPv6 multicast addresses subscribed to the Thread interface.

Returns

• A pointer to the first Network Interface Multicast Address.

otIp6IsMulticastPromiscuousEnabled#

bool otIp6IsMulticastPromiscuousEnabled (otInstance * aInstance)

Checks if multicast promiscuous mode is enabled on the Thread interface.

See Also

• otIp6SetMulticastPromiscuousEnabled

otIp6SetMulticastPromiscuousEnabled#

void otIp6SetMulticastPromiscuousEnabled (otInstance * aInstance, bool aEnabled)

Enables or disables multicast promiscuous mode on the Thread interface.

See Also

• otIp6IsMulticastPromiscuousEnabled

otIp6NewMessage#

otMessage * otIp6NewMessage (otInstance * aInstance, const otMessageSettings * aSettings)

Allocate a new message buffer for sending an IPv6 message.

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

• otMessageFree

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.

Note

• If aSettings is NULL, the link layer security is enabled and the message priority is obtained from IPv6 message itself. If aSettings is not NULL, the aSetting->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

• otMessageFree

otIp6SetReceiveCallback#

void otIp6SetReceiveCallback (otInstance * aInstance, otIp6ReceiveCallback aCallback, void * aCallbackContext)

This function registers a callback to provide received IPv6 datagrams.

By default, this callback does not pass Thread control traffic. See otIp6SetReceiveFilterEnabled() to change the Thread control traffic filter setting.

See Also

• otIp6IsReceiveFilterEnabled

• otIp6SetReceiveFilterEnabled

otIp6SetAddressCallback#

void otIp6SetAddressCallback (otInstance * aInstance, otIp6AddressCallback aCallback, void * aCallbackContext)

This function registers a callback to notify internal IPv6 address changes.

otIp6IsReceiveFilterEnabled#

bool otIp6IsReceiveFilterEnabled (otInstance * aInstance)

This function indicates whether or not Thread control traffic is filtered out when delivering IPv6 datagrams via the callback specified in otIp6SetReceiveCallback().

Returns

• TRUE if Thread control traffic is filtered out, FALSE otherwise.

See Also

• otIp6SetReceiveCallback

• otIp6SetReceiveFilterEnabled

otIp6SetReceiveFilterEnabled#

void otIp6SetReceiveFilterEnabled (otInstance * aInstance, bool aEnabled)

This function sets whether or not Thread control traffic is filtered out when delivering IPv6 datagrams via the callback specified in otIp6SetReceiveCallback().

See Also

• otIp6SetReceiveCallback

• otIsReceiveIp6FilterEnabled

otIp6Send#

otError otIp6Send (otInstance * aInstance, otMessage * aMessage)

This function sends an IPv6 datagram via the Thread interface.

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.

otIp6AddUnsecurePort#

otError otIp6AddUnsecurePort (otInstance * aInstance, uint16_t aPort)

This function adds a port to the allowed unsecured port list.

otIp6RemoveUnsecurePort#

otError otIp6RemoveUnsecurePort (otInstance * aInstance, uint16_t aPort)

This function removes a port from the allowed unsecure port list.

Note

• This function removes aPort by overwriting aPort with the element after aPort in the internal port list. Be careful when calling otIp6GetUnsecurePorts() followed by otIp6RemoveUnsecurePort() to remove unsecure ports.

otIp6RemoveAllUnsecurePorts#

void otIp6RemoveAllUnsecurePorts (otInstance * aInstance)

This function removes all ports from the allowed unsecure port list.

otIp6GetUnsecurePorts#

const uint16_t * otIp6GetUnsecurePorts (otInstance * aInstance, uint8_t * aNumEntries)

This function returns a pointer to the unsecure port list.

Note

• Port value 0 is used to indicate an invalid entry.

Returns

• A pointer to the unsecure port list.

otIp6IsAddressEqual#

bool otIp6IsAddressEqual (const otIp6Address * aFirst, const otIp6Address * aSecond)

Test if two IPv6 addresses are the same.

otIp6ArePrefixesEqual#

bool otIp6ArePrefixesEqual (const otIp6Prefix * aFirst, const otIp6Prefix * aSecond)

Test if two IPv6 prefixes are the same.

otIp6AddressFromString#

otError otIp6AddressFromString (const char * aString, otIp6Address * aAddress)

This function converts a human-readable IPv6 address string into a binary representation.

otIp6PrefixFromString#

otError otIp6PrefixFromString (const char * aString, otIp6Prefix * aPrefix)

This function converts a human-readable IPv6 prefix string into a binary representation.

The aString parameter should be a string in the format "<address>/<plen>", where <address> is an IPv6 address and <plen> is a prefix length.

otIp6AddressToString#

void otIp6AddressToString (const otIp6Address * aAddress, char * aBuffer, uint16_t aSize)

This function converts a given IPv6 address to a human-readable string.

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.

otIp6SockAddrToString#

void otIp6SockAddrToString (const otSockAddr * aSockAddr, char * aBuffer, uint16_t aSize)

This function converts a given IPv6 socket address to a human-readable string.

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.

otIp6PrefixToString#

void otIp6PrefixToString (const otIp6Prefix * aPrefix, char * aBuffer, uint16_t aSize)

This function converts a given IPv6 prefix to a human-readable string.

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.

otIp6PrefixMatch#

uint8_t otIp6PrefixMatch (const otIp6Address * aFirst, const otIp6Address * aSecond)

This function returns the prefix match length (bits) for two IPv6 addresses.

Returns

• The prefix match length in bits.

otIp6GetPrefix#

void otIp6GetPrefix (const otIp6Address * aAddress, uint8_t aLength, otIp6Prefix * aPrefix)

This method gets a prefix with aLength from aAddress.

otIp6IsAddressUnspecified#

bool otIp6IsAddressUnspecified (const otIp6Address * aAddress)

This function indicates whether or not a given IPv6 address is the Unspecified Address.

otIp6SelectSourceAddress#

otError otIp6SelectSourceAddress (otInstance * aInstance, otMessageInfo * aMessageInfo)

This function perform OpenThread source address selection.

otIp6IsSlaacEnabled#

bool otIp6IsSlaacEnabled (otInstance * aInstance)

This function indicates whether the SLAAC module is enabled or not.

This function requires the build-time feature OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE to be enabled.

otIp6SetSlaacEnabled#

void otIp6SetSlaacEnabled (otInstance * aInstance, bool aEnabled)

This function enables/disables the SLAAC module.

This function requires the build-time feature OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE to 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.

otIp6SetSlaacPrefixFilter#

void otIp6SetSlaacPrefixFilter (otInstance * aInstance, otIp6SlaacPrefixFilter aFilter)

This function sets the SLAAC module filter handler.

This function requires the build-time feature OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE to 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).

otIp6RegisterMulticastListeners#

otError otIp6RegisterMulticastListeners (otInstance * aInstance, const otIp6Address * aAddresses, uint8_t aAddressNum, const uint32_t * aTimeout, otIp6RegisterMulticastListenersCallback aCallback, void * aContext)

This function registers Multicast Listeners to Primary Backbone Router.

Note: only available when both OPENTHREAD_CONFIG_TMF_PROXY_MLR_ENABLE and OPENTHREAD_CONFIG_COMMISSIONER_ENABLE are enabled)

See Also

• otIp6RegisterMulticastListenersCallback

otIp6SetMeshLocalIid#

otError otIp6SetMeshLocalIid (otInstance * aInstance, const otIp6InterfaceIdentifier * aIid)

This function sets the Mesh Local IID (for test purpose).

Only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

otIp6ProtoToString#

const char * otIp6ProtoToString (uint8_t aIpProto)

This function converts a given IP protocol number to a human-readable string.

Returns

• A string representing aIpProto.

otIp6GetBorderRoutingCounters#

const otBorderRoutingCounters * otIp6GetBorderRoutingCounters (otInstance * aInstance)

Gets the Border Routing counters.

This function requires the build-time feature OPENTHREAD_CONFIG_IP6_BR_COUNTERS_ENABLE to be enabled.

Returns

• A pointer to the Border Routing counters.

otIp6ResetBorderRoutingCounters#

void otIp6ResetBorderRoutingCounters (otInstance * aInstance)

Resets the Border Routing counters.