espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-08 03:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ip6] style changes and renames (#10813)

Browse Source 
This commit contains minor enhancements to the `Ip6` class, including
variable and method renames (to use shorter names) and minor style
changes.
This commit is contained in:
Abtin Keshavarzian
2024-10-11 13:10:05 -07:00
committed by GitHub
parent d163dee2af
commit ad29f8e886
4 changed files with 38 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/core/api/ip6_api.cpp
+1 -1
View File
@@ -100,7 +100,7 @@ otError otIp6UnsubscribeMulticastAddress(otInstance *aInstance, const otIp6Addre
void otIp6SetReceiveCallback(otInstance *aInstance, otIp6ReceiveCallback aCallback, void *aCallbackContext)
{
AsCoreType(aInstance).Get<Ip6::Ip6>().SetReceiveDatagramCallback(aCallback, aCallbackContext);
AsCoreType(aInstance).Get<Ip6::Ip6>().SetReceiveCallback(aCallback, aCallbackContext);
}
void otIp6SetAddressCallback(otInstance *aInstance, otIp6AddressCallback aCallback, void *aCallbackContext)
src/core/api/nat64_api.cpp
+1 -1
View File
@@ -61,7 +61,7 @@ otError otNat64Send(otInstance *aInstance, otMessage *aMessage)
void otNat64SetReceiveIp4Callback(otInstance *aInstance, otNat64ReceiveIp4Callback aCallback, void *aContext)
{
AsCoreType(aInstance).Get<Ip6::Ip6>().SetNat64ReceiveIp4DatagramCallback(aCallback, aContext);
AsCoreType(aInstance).Get<Ip6::Ip6>().SetNat64ReceiveIp4Callback(aCallback, aContext);
}
void otNat64InitAddressMappingIterator(otInstance *aInstance, otNat64AddressMappingIterator *aIterator)
src/core/net/ip6.cpp
+9 -9
View File
@@ -49,7 +49,7 @@ RegisterLogModule("Ip6");
Ip6::Ip6(Instance &aInstance)
: InstanceLocator(aInstance)
, mIsReceiveIp6FilterEnabled(false)
, mReceiveFilterEnabled(false)
#if OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
, mTmfOriginFilterEnabled(true)
#endif
@@ -750,7 +750,7 @@ void Ip6::UpdateReassemblyList(void)
for (Message &message : mReassemblyList)
{
if (now - message.GetTimestamp() >= TimeMilli::SecToMsec(kIp6ReassemblyTimeout))
if (now - message.GetTimestamp() >= TimeMilli::SecToMsec(kReassemblyTimeout))
{
LogNote("Reassembly timeout.");
SendIcmpError(message, Icmp::Header::kTypeTimeExceeded, Icmp::Header::kCodeFragmReasTimeEx);
@@ -935,7 +935,7 @@ Error Ip6::PassToHost(OwnedPtr<Message> &aMessagePtr,
VerifyOrExit(aMessagePtr->IsLoopbackToHostAllowed());
VerifyOrExit(mReceiveIp6DatagramCallback.IsSet(), error = kErrorNoRoute);
VerifyOrExit(mReceiveCallback.IsSet(), error = kErrorNoRoute);
// Do not pass IPv6 packets that exceed kMinimalMtu.
VerifyOrExit(aMessagePtr->GetLength() <= kMinimalMtu, error = kErrorDrop);
@@ -954,7 +954,7 @@ Error Ip6::PassToHost(OwnedPtr<Message> &aMessagePtr,
VerifyOrExit(aReceive, error = kErrorDrop);
}
if (mIsReceiveIp6FilterEnabled && aReceive)
if (mReceiveFilterEnabled && aReceive)
{
switch (aIpProto)
{
@@ -1007,9 +1007,9 @@ Error Ip6::PassToHost(OwnedPtr<Message> &aMessagePtr,
ExitNow(error = kErrorDrop);
case Nat64::Translator::kForward:
VerifyOrExit(mReceiveIp4DatagramCallback.IsSet(), error = kErrorNoRoute);
VerifyOrExit(mIp4ReceiveCallback.IsSet(), error = kErrorNoRoute);
// Pass message to callback transferring its ownership.
mReceiveIp4DatagramCallback.Invoke(messagePtr.Release());
mIp4ReceiveCallback.Invoke(messagePtr.Release());
ExitNow();
}
#endif
@@ -1032,7 +1032,7 @@ Error Ip6::PassToHost(OwnedPtr<Message> &aMessagePtr,
#endif
// Pass message to callback transferring its ownership.
mReceiveIp6DatagramCallback.Invoke(messagePtr.Release());
mReceiveCallback.Invoke(messagePtr.Release());
exit:
return error;
@@ -1455,12 +1455,12 @@ exit:
if (counter)
{
counter->mPackets += 1;
counter->mPackets++;
counter->mBytes += aMessageLength;
}
if (internetCounter)
{
internetCounter->mPackets += 1;
internetCounter->mPackets++;
internetCounter->mBytes += aMessageLength;
}
}
src/core/net/ip6.hpp
+27 -47
View File
@@ -108,6 +108,8 @@ class Ip6 : public InstanceLocator, private NonCopyable
friend class Mpl;
public:
typedef otIp6ReceiveCallback ReceiveCallback; ///< IPv6 receive callback function pointer.
/**
* Initializes the object.
*
@@ -206,60 +208,46 @@ public:
Error HandleDatagram(OwnedPtr<Message> aMessagePtr, bool aIsReassembled = false);
/**
* Registers a callback to provide received raw IPv6 datagrams.
* Sets the callback to provide received raw IPv6 datagrams.
*
* By default, this callback does not pass Thread control traffic. See SetReceiveIp6FilterEnabled() to change
* By default, this callback does not pass Thread control traffic. See `SetReceiveIp6FilterEnabled()` to change
* the Thread control traffic filter setting.
*
* @param[in] aCallback A pointer to a function that is called when an IPv6 datagram is received
* or `nullptr` to disable the callback.
* @param[in] aCallbackContext A pointer to application-specific context.
*
* @sa IsReceiveIp6FilterEnabled
* @sa SetReceiveIp6FilterEnabled
* @param[in] aCallback The receive callback function. Can be `nullptr` to disable the callback.
* @param[in] aContext A pointer to application-specific context.
*/
void SetReceiveDatagramCallback(otIp6ReceiveCallback aCallback, void *aCallbackContext)
{
mReceiveIp6DatagramCallback.Set(aCallback, aCallbackContext);
}
void SetReceiveCallback(ReceiveCallback aCallback, void *aContext) { mReceiveCallback.Set(aCallback, aContext); }
#if OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE
typedef otNat64ReceiveIp4Callback Ip4ReceiveCallback; ///< NAT64 IPv4 receive callback function pointer.
/**
* Registers a callback to provide received translated IPv4 datagrams.
* Sets the callback to provide received translated IPv4 datagrams.
*
* @param[in] aCallback A pointer to a function that is called when a translated IPv4 datagram is received
* or `nullptr` to disable the callback.
* @param[in] aCallbackContext A pointer to application-specific context.
*
* @sa SetReceiveDatagramCallback
* @param[in] aCallback The NAT64 IPv4 callbac, used when translated IPv4 datagram is received.
* @param[in] aContext A pointer to application-specific context.
*/
void SetNat64ReceiveIp4DatagramCallback(otNat64ReceiveIp4Callback aCallback, void *aCallbackContext)
void SetNat64ReceiveIp4Callback(Ip4ReceiveCallback aCallback, void *aContext)
{
mReceiveIp4DatagramCallback.Set(aCallback, aCallbackContext);
mIp4ReceiveCallback.Set(aCallback, aContext);
}
#endif
/**
* Indicates whether or not Thread control traffic is filtered out when delivering IPv6 datagrams
* via the callback specified in SetReceiveIp6DatagramCallback().
* via the callback specified in `SetReceiveIp6Callback()`.
*
* @returns TRUE if Thread control traffic is filtered out, FALSE otherwise.
*
* @sa SetReceiveDatagramCallback
* @sa SetReceiveIp6FilterEnabled
*/
bool IsReceiveIp6FilterEnabled(void) const { return mIsReceiveIp6FilterEnabled; }
bool IsReceiveIp6FilterEnabled(void) const { return mReceiveFilterEnabled; }
/**
* Sets whether or not Thread control traffic is filtered out when delivering IPv6 datagrams
* via the callback specified in SetReceiveIp6DatagramCallback().
* via the callback specified in `SetReceiveIp6Callback()`.
*
* @param[in] aEnabled TRUE if Thread control traffic is filtered out, FALSE otherwise.
*
* @sa SetReceiveDatagramCallback
* @sa IsReceiveIp6FilterEnabled
*/
void SetReceiveIp6FilterEnabled(bool aEnabled) { mIsReceiveIp6FilterEnabled = aEnabled; }
void SetReceiveIp6FilterEnabled(bool aEnabled) { mReceiveFilterEnabled = aEnabled; }
/**
* Performs default source address selection.
@@ -349,8 +337,8 @@ public:
#endif
private:
static constexpr uint8_t kDefaultHopLimit = OPENTHREAD_CONFIG_IP6_HOP_LIMIT_DEFAULT;
static constexpr uint8_t kIp6ReassemblyTimeout = OPENTHREAD_CONFIG_IP6_REASSEMBLY_TIMEOUT;
static constexpr uint8_t kDefaultHopLimit = OPENTHREAD_CONFIG_IP6_HOP_LIMIT_DEFAULT;
static constexpr uint8_t kReassemblyTimeout = OPENTHREAD_CONFIG_IP6_REASSEMBLY_TIMEOUT;
static constexpr uint16_t kMinimalMtu = 1280;
@@ -396,33 +384,25 @@ private:
using SendQueueTask = TaskletIn<Ip6, &Ip6::HandleSendQueue>;
bool mIsReceiveIp6FilterEnabled;
bool mReceiveFilterEnabled;
#if OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
bool mTmfOriginFilterEnabled : 1;
bool mTmfOriginFilterEnabled;
#endif
Callback<otIp6ReceiveCallback> mReceiveIp6DatagramCallback;
Callback<ReceiveCallback> mReceiveCallback;
#if OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE
Callback<otNat64ReceiveIp4Callback> mReceiveIp4DatagramCallback;
Callback<Ip4ReceiveCallback> mIp4ReceiveCallback;
#endif
PriorityQueue mSendQueue;
SendQueueTask mSendQueueTask;
Icmp mIcmp;
Udp mUdp;
Mpl mMpl;
Icmp mIcmp;
Udp mUdp;
Mpl mMpl;
#if OPENTHREAD_CONFIG_TCP_ENABLE
Tcp mTcp;
#endif
#if OPENTHREAD_CONFIG_IP6_FRAGMENTATION_ENABLE
MessageQueue mReassemblyList;
#endif
#if OPENTHREAD_CONFIG_IP6_BR_COUNTERS_ENABLE
BrCounters mBrCounters;
#endif