Enumerator
OT_NAT64_DROP_REASON_UNKNOWN	Packet drop for unknown reasons.
OT_NAT64_DROP_REASON_ILLEGAL_PACKET	Packet drop due to failed to parse the datagram.
OT_NAT64_DROP_REASON_UNSUPPORTED_PROTO	Packet drop due to unsupported IP protocol.
OT_NAT64_DROP_REASON_NO_MAPPING	Packet drop due to no mappings found or mapping pool exhausted.
OT_NAT64_DROP_REASON_COUNT

otNat64State#

otNat64State

States of NAT64.

Enumerator
OT_NAT64_STATE_DISABLED	NAT64 is disabled.
OT_NAT64_STATE_NOT_RUNNING	NAT64 is enabled, but one or more dependencies of NAT64 are not running.
OT_NAT64_STATE_IDLE	NAT64 is enabled, but this BR is not an active NAT64 BR.
OT_NAT64_STATE_ACTIVE	The BR is publishing a NAT64 prefix and/or translating packets.

Typedef Documentation#

otIp4Address#

typedef struct otIp4Address otIp4Address

Represents an IPv4 address.

otIp4Cidr#

typedef struct otIp4Cidr otIp4Cidr

otNat64Counters#

typedef struct otNat64Counters otNat64Counters

Represents the counters for NAT64.

otNat64ProtocolCounters#

typedef struct otNat64ProtocolCounters otNat64ProtocolCounters

Represents the counters for the protocols supported by NAT64.

otNat64DropReason#

typedef enum otNat64DropReason otNat64DropReason

Packet drop reasons.

otNat64ErrorCounters#

typedef struct otNat64ErrorCounters otNat64ErrorCounters

Represents the counters of dropped packets due to errors when handling NAT64 packets.

otNat64AddressMapping#

typedef struct otNat64AddressMapping otNat64AddressMapping

Represents an address mapping record for NAT64.

Note

The counters will be reset for each mapping session even for the same address pair. Applications can use mId to identify different sessions to calculate the packets correctly.

otNat64AddressMappingIterator#

typedef struct otNat64AddressMappingIterator otNat64AddressMappingIterator

Used to iterate through NAT64 address mappings.

The fields in this type are opaque (intended for use by OpenThread core only) and therefore should not be accessed or used by caller.

Before using an iterator, it MUST be initialized using otNat64AddressMappingIteratorInit().

otNat64ReceiveIp4Callback#

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

Pointer is called when an IPv4 datagram (translated by NAT64 translator) is received.

Parameters

Type	Direction	Argument Name	Description
	[in]	aMessage	A pointer to the message buffer containing the received IPv6 datagram. This function transfers the ownership of the `aMessage` to the receiver of the callback. The message should be freed by the receiver of the callback after it is processed.
	[in]	aContext	A pointer to application-specific context.

Variable Documentation#

OT_TOOL_PACKED_END#

OT_TOOL_PACKED_BEGIN struct otIp4Address OT_TOOL_PACKED_END

Function Documentation#

otNat64GetCounters#

void otNat64GetCounters (otInstance * aInstance, otNat64ProtocolCounters * aCounters)

Gets NAT64 translator counters.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	A pointer to an OpenThread instance.
otNat64ProtocolCounters *	[out]	aCounters	A pointer to an `otNat64Counters` where the counters of NAT64 translator will be placed.

The counter is counted since the instance initialized.

Available when OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE is enabled.

otNat64GetErrorCounters#

void otNat64GetErrorCounters (otInstance * aInstance, otNat64ErrorCounters * aCounters)

Gets the NAT64 translator error counters.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	A pointer to an OpenThread instance.
otNat64ErrorCounters *	[out]	aCounters	A pointer to an `otNat64Counters` where the counters of NAT64 translator will be placed.

The counters are initialized to zero when the OpenThread instance is initialized.

otNat64InitAddressMappingIterator#

void otNat64InitAddressMappingIterator (otInstance * aInstance, otNat64AddressMappingIterator * aIterator)

Initializes an otNat64AddressMappingIterator.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	The OpenThread instance.
otNat64AddressMappingIterator *	[out]	aIterator	A pointer to the iterator to initialize.

An iterator MUST be initialized before it is used.

An iterator can be initialized again to restart from the beginning of the mapping info.

otNat64GetNextAddressMapping#

otError otNat64GetNextAddressMapping (otInstance * aInstance, otNat64AddressMappingIterator * aIterator, otNat64AddressMapping * aMapping)

Gets the next AddressMapping info (using an iterator).

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	A pointer to an OpenThread instance.
otNat64AddressMappingIterator *	[inout]	aIterator	A pointer to the iterator. On success the iterator will be updated to point to next NAT64 address mapping record. To get the first entry the iterator should be set to OT_NAT64_ADDRESS_MAPPING_ITERATOR_INIT.
otNat64AddressMapping *	[out]	aMapping	A pointer to an `otNat64AddressMapping` where information of next NAT64 address mapping record is placed (on success).

Available when OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE is enabled.

otNat64GetTranslatorState#

otNat64State otNat64GetTranslatorState (otInstance * aInstance)

Gets the state of NAT64 translator.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	A pointer to an OpenThread instance.

Available when OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE is enabled.

otNat64GetPrefixManagerState#

otNat64State otNat64GetPrefixManagerState (otInstance * aInstance)

Gets the state of NAT64 prefix manager.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	A pointer to an OpenThread instance.

Available when OPENTHREAD_CONFIG_NAT64_BORDER_ROUTING_ENABLE is enabled.

otNat64SetEnabled#

void otNat64SetEnabled (otInstance * aInstance, bool aEnabled)

Enable or disable NAT64 functions.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	A pointer to an OpenThread instance.
bool	[in]	aEnabled	A boolean to enable/disable the NAT64 functions

Note: This includes the NAT64 Translator (when OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE is enabled) and the NAT64 Prefix Manager (when OPENTHREAD_CONFIG_NAT64_BORDER_ROUTING_ENABLE is enabled).

When OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE is enabled, setting disabled to true resets the mapping table in the translator.

Available when OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE or OPENTHREAD_CONFIG_NAT64_BORDER_ROUTING_ENABLE is enabled.

See Also

otIp4NewMessage#

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

Allocate a new message buffer for sending an IPv4 message to the NAT64 translator.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	A pointer to an OpenThread instance.
const otMessageSettings *	[in]	aSettings	A pointer to the message settings or NULL to set default settings.

Message buffers allocated by this function will have 20 bytes (difference between the size of IPv6 headers and IPv4 header sizes) reserved.

Available when OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE is enabled.

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

otNat64Send

otNat64SetIp4Cidr#

otError otNat64SetIp4Cidr (otInstance * aInstance, const otIp4Cidr * aCidr)

Sets the CIDR used when setting the source address of the outgoing translated IPv4 packets.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	A pointer to an OpenThread instance.
const otIp4Cidr *	[in]	aCidr	A pointer to an otIp4Cidr for the IPv4 CIDR block for NAT64.

Is available only when OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE is enabled.

Note

A valid CIDR must have a non-zero prefix length. The actual addresses pool is limited by the size of the mapping pool and the number of addresses available in the CIDR block.
This function can be called at any time, but the NAT64 translator will be reset and all existing sessions will be expired when updating the configured CIDR.

See Also

otBorderRouterSend
otBorderRouterSetReceiveCallback

otNat64Send#

otError otNat64Send (otInstance * aInstance, otMessage * aMessage)

Translates an IPv4 datagram to an IPv6 datagram and sends via the Thread interface.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	A pointer to an OpenThread instance.
otMessage *	[in]	aMessage	A pointer to the message buffer containing the IPv4 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.

otNat64SetReceiveIp4Callback#

void otNat64SetReceiveIp4Callback (otInstance * aInstance, otNat64ReceiveIp4Callback aCallback, void * aContext)

Registers a callback to provide received IPv4 datagrams.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	A pointer to an OpenThread instance.
otNat64ReceiveIp4Callback	[in]	aCallback	A pointer to a function that is called when an IPv4 datagram is received or NULL to disable the callback.
void *	[in]	aContext	A pointer to application-specific context.

otNat64GetCidr#

otError otNat64GetCidr (otInstance * aInstance, otIp4Cidr * aCidr)

Gets the IPv4 CIDR configured in the NAT64 translator.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	A pointer to an OpenThread instance.
otIp4Cidr *	[out]	aCidr	A pointer to an otIp4Cidr. Where the CIDR will be filled.

Available when OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE is enabled.

otIp4IsAddressEqual#

bool otIp4IsAddressEqual (const otIp4Address * aFirst, const otIp4Address * aSecond)

Test if two IPv4 addresses are the same.

Parameters

Type	Direction	Argument Name	Description
const otIp4Address *	[in]	aFirst	A pointer to the first IPv4 address to compare.
const otIp4Address *	[in]	aSecond	A pointer to the second IPv4 address to compare.

otIp4ExtractFromIp6Address#

void otIp4ExtractFromIp6Address (uint8_t aPrefixLength, const otIp6Address * aIp6Address, otIp4Address * aIp4Address)

Set aIp4Address by performing NAT64 address translation from aIp6Address as specified in RFC 6052.

Parameters

Type	Direction	Argument Name	Description
uint8_t	[in]	aPrefixLength	The prefix length to use for IPv4/IPv6 translation.
const otIp6Address *	[in]	aIp6Address	A pointer to an IPv6 address.
otIp4Address *	[out]	aIp4Address	A pointer to output the IPv4 address.

The NAT64 aPrefixLength MUST be one of the following values: 32, 40, 48, 56, 64, or 96, otherwise the behavior of this method is undefined.

otIp4FromIp4MappedIp6Address#

otError otIp4FromIp4MappedIp6Address (const otIp6Address * aIp6Address, otIp4Address * aIp4Address)

Extracts the IPv4 address from a given IPv4-mapped IPv6 address.

Parameters

Type	Direction	Argument Name	Description
const otIp6Address *	[in]	aIp6Address	An IPv6 address to extract IPv4 from.
otIp4Address *	[out]	aIp4Address	An IPv4 address to output the extracted address.

An IPv4-mapped IPv6 address consists of an 80-bit prefix of zeros, the next 16 bits set to ones, and the remaining, least-significant 32 bits contain the IPv4 address, e.g., ::ffff:192.0.2.128 representing 192.0.2.128.

otIp4ToIp4MappedIp6Address#

void otIp4ToIp4MappedIp6Address (const otIp4Address * aIp4Address, otIp6Address * aIp6Address)

Converts a given IP4 address to an IPv6 address following the IPv4-mapped IPv6 address format.

Parameters

Type	Direction	Argument Name	Description
const otIp4Address *	[in]	aIp4Address	An IPv4 address to convert.
otIp6Address *	[out]	aIp6Address	An IPv6 address to set.

otIp4AddressToString#

void otIp4AddressToString (const otIp4Address * aAddress, char * aBuffer, uint16_t aSize)

Converts the address to a string.

Parameters

Type	Direction	Argument Name	Description
const otIp4Address *	[in]	aAddress	A pointer to an IPv4 address (MUST NOT be NULL).
char *	[out]	aBuffer	A pointer to a char array to output the string (MUST NOT be `nullptr`).
uint16_t	[in]	aSize	The size of `aBuffer` (in bytes).

The string format uses quad-dotted notation of four bytes in the address (e.g., "127.0.0.1").

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.

otIp4CidrFromString#

otError otIp4CidrFromString (const char * aString, otIp4Cidr * aCidr)

Converts a human-readable IPv4 CIDR string into a binary representation.

Parameters

Type	Direction	Argument Name	Description
const char *	[in]	aString	A pointer to a NULL-terminated string.
otIp4Cidr *	[out]	aCidr	A pointer to an IPv4 CIDR.

otIp4CidrToString#

void otIp4CidrToString (const otIp4Cidr * aCidr, char * aBuffer, uint16_t aSize)

Converts the IPv4 CIDR to a string.

Parameters

Type	Direction	Argument Name	Description
const otIp4Cidr *	[in]	aCidr	A pointer to an IPv4 CIDR (MUST NOT be NULL).
char *	[out]	aBuffer	A pointer to a char array to output the string (MUST NOT be `nullptr`).
uint16_t	[in]	aSize	The size of `aBuffer` (in bytes).

The string format uses quad-dotted notation of four bytes in the address with the length of prefix (e.g., "127.0.0.1/32").

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.

otIp4AddressFromString#

otError otIp4AddressFromString (const char * aString, otIp4Address * aAddress)

Converts a human-readable IPv4 address string into a binary representation.

Parameters

Type	Direction	Argument Name	Description
const char *	[in]	aString	A pointer to a NULL-terminated string.
otIp4Address *	[out]	aAddress	A pointer to an IPv4 address.

otNat64SynthesizeIp6Address#

otError otNat64SynthesizeIp6Address (otInstance * aInstance, const otIp4Address * aIp4Address, otIp6Address * aIp6Address)

Sets the IPv6 address by performing NAT64 address translation from the preferred NAT64 prefix and the given IPv4 address as specified in RFC 6052.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	A pointer to an OpenThread instance.
const otIp4Address *	[in]	aIp4Address	A pointer to the IPv4 address to translate to IPv6.
otIp6Address *	[out]	aIp6Address	A pointer to the synthesized IPv6 address.

Returns

OT_ERROR_NONE Successfully synthesized the IPv6 address from NAT64 prefix and IPv4 address.
OT_ERROR_INVALID_STATE No valid NAT64 prefix in the network data.