otNat64InitAddressMappingIterator

Function otNat64InitAddressMappingIterator 

Source
pub unsafe extern "C" fn otNat64InitAddressMappingIterator(
    aInstance: *mut otInstance,
    aIterator: *mut otNat64AddressMappingIterator,
)
Expand description

Initializes an otNat64AddressMappingIterator.

Available when OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE is enabled.

An iterator MUST be initialized before it is used. An iterator can be initialized again to restart from the beginning of the mapping info list.

The iterator initialization time is used to report the mRemainingTimeMs in the otNat64AddressMapping retrieved when calling otNat64GetNextAddressMapping() to iterate over the list. This ensures that all entry mRemainingTimeMs values are consistent and are from the same time origin, regardless of how or when otNat64GetNextAddressMapping() is called.

@param[in] aInstance A pointer to the OpenThread instance. @param[out] aIterator A pointer to the iterator to initialize.