espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-07-28 14:47:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

[border-agent] smaller enhancements (#9432)

Browse Source 
This commit contains smaller changes in `BorderAgent` class:

- Define `kUdpPort` as a private constants in `BorderAgent` class.
- Add `SendMessage()` method to send message through `SecureAgent`.
- Add `LogError()` as a method so the correct log module is used.
- Remove unused `mMessageInfo` member variable.
- Harmonize log messages.
This commit is contained in:
Abtin Keshavarzian
2023-09-18 16:26:12 -07:00
committed by GitHub
parent 5f8f05cab5
commit 851e00ffdb
2 changed files with 50 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/core/meshcop/border_agent.cpp
+35 -17
View File
@@ -53,9 +53,8 @@ namespace MeshCoP {
RegisterLogModule("BorderAgent");
namespace {
constexpr uint16_t kBorderAgentUdpPort = OPENTHREAD_CONFIG_BORDER_AGENT_UDP_PORT; ///< UDP port of border agent service.
}
//----------------------------------------------------------------------------------------------------------------------
// `BorderAgent::ForwardContext`
void BorderAgent::ForwardContext::Init(Instance &aInstance,
const Coap::Message &aMessage,
@@ -90,6 +89,9 @@ Error BorderAgent::ForwardContext::ToHeader(Coap::Message &aMessage, uint8_t aCo
return aMessage.SetToken(mToken, mTokenLength);
}
//----------------------------------------------------------------------------------------------------------------------
// `BorderAgent`
Coap::Message::Code BorderAgent::CoapCodeFromError(Error aError)
{
Coap::Message::Code code;
@@ -119,7 +121,7 @@ void BorderAgent::SendErrorMessage(ForwardContext &aForwardContext, Error aError
VerifyOrExit((message = Get<Tmf::SecureAgent>().NewPriorityMessage()) != nullptr, error = kErrorNoBufs);
SuccessOrExit(error = aForwardContext.ToHeader(*message, CoapCodeFromError(aError)));
SuccessOrExit(error = Get<Tmf::SecureAgent>().SendMessage(*message, Get<Tmf::SecureAgent>().GetMessageInfo()));
SuccessOrExit(error = SendMessage(*message));
exit:
FreeMessageOnError(message, error);
@@ -149,13 +151,18 @@ void BorderAgent::SendErrorMessage(const Coap::Message &aRequest, bool aSeparate
SuccessOrExit(error = message->SetTokenFromMessage(aRequest));
SuccessOrExit(error = Get<Tmf::SecureAgent>().SendMessage(*message, Get<Tmf::SecureAgent>().GetMessageInfo()));
SuccessOrExit(error = SendMessage(*message));
exit:
FreeMessageOnError(message, error);
LogError("send error CoAP message", error);
}
Error BorderAgent::SendMessage(Coap::Message &aMessage)
{
return Get<Tmf::SecureAgent>().SendMessage(aMessage, Get<Tmf::SecureAgent>().GetMessageInfo());
}
void BorderAgent::HandleCoapResponse(void *aContext,
otMessage *aMessage,
const otMessageInfo *aMessageInfo,
@@ -192,7 +199,7 @@ void BorderAgent::HandleCoapResponse(ForwardContext &aForwardContext, const Coap
Get<ThreadNetif>().AddUnicastAddress(mCommissionerAloc);
IgnoreError(Get<Ip6::Udp>().AddReceiver(mUdpReceiver));
LogInfo("commissioner accepted: session ID=%d, ALOC=%s", sessionId,
LogInfo("Commissioner accepted - SessionId:%u ALOC:%s", sessionId,
mCommissionerAloc.GetAddress().ToString().AsCString());
}
}
@@ -222,10 +229,10 @@ exit:
BorderAgent::BorderAgent(Instance &aInstance)
: InstanceLocator(aInstance)
, mUdpReceiver(BorderAgent::HandleUdpReceive, this)
, mTimer(aInstance)
, mState(kStateStopped)
, mUdpProxyPort(0)
, mUdpReceiver(BorderAgent::HandleUdpReceive, this)
, mTimer(aInstance)
#if OPENTHREAD_CONFIG_BORDER_AGENT_ID_ENABLE
, mIdInitialized(false)
#endif
@@ -334,6 +341,11 @@ exit:
LogError("send proxy stream", error);
}
bool BorderAgent::HandleUdpReceive(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo)
{
return static_cast<BorderAgent *>(aContext)->HandleUdpReceive(AsCoreType(aMessage), AsCoreType(aMessageInfo));
}
bool BorderAgent::HandleUdpReceive(const Message &aMessage, const Ip6::MessageInfo &aMessageInfo)
{
Error error;
@@ -369,7 +381,7 @@ bool BorderAgent::HandleUdpReceive(const Message &aMessage, const Ip6::MessageIn
SuccessOrExit(error = Tlv::Append<Ip6AddressTlv>(*message, aMessageInfo.GetPeerAddr()));
SuccessOrExit(error = Get<Tmf::SecureAgent>().SendMessage(*message, Get<Tmf::SecureAgent>().GetMessageInfo()));
SuccessOrExit(error = SendMessage(*message));
LogInfo("Sent to commissioner on ProxyRx (c/ur)");
@@ -377,7 +389,7 @@ exit:
FreeMessageOnError(message, error);
if (error != kErrorDestinationAddressFiltered)
{
LogError("Notify commissioner on ProxyRx (c/ur)", error);
LogError("notify commissioner on ProxyRx (c/ur)", error);
}
return error != kErrorDestinationAddressFiltered;
@@ -410,8 +422,7 @@ Error BorderAgent::ForwardToCommissioner(Coap::Message &aForwardMessage, const M
SuccessOrExit(error = aForwardMessage.AppendBytesFromMessage(aMessage, aMessage.GetOffset(),
aMessage.GetLength() - aMessage.GetOffset()));
SuccessOrExit(error =
Get<Tmf::SecureAgent>().SendMessage(aForwardMessage, Get<Tmf::SecureAgent>().GetMessageInfo()));
SuccessOrExit(error = SendMessage(aForwardMessage));
LogInfo("Sent to commissioner");
@@ -603,7 +614,7 @@ void BorderAgent::Start(void)
VerifyOrExit(mState == kStateStopped, error = kErrorNone);
Get<KeyManager>().GetPskc(pskc);
SuccessOrExit(error = Get<Tmf::SecureAgent>().Start(kBorderAgentUdpPort));
SuccessOrExit(error = Get<Tmf::SecureAgent>().Start(kUdpPort));
SuccessOrExit(error = Get<Tmf::SecureAgent>().SetPsk(pskc.m8, Pskc::kSize));
pskc.Clear();
@@ -615,10 +626,7 @@ void BorderAgent::Start(void)
LogInfo("Border Agent start listening on port %u", GetUdpPort());
exit:
if (error != kErrorNone)
{
LogWarn("failed to start Border Agent on port %d: %s", kBorderAgentUdpPort, ErrorToString(error));
}
LogError("start agent", error);
}
void BorderAgent::HandleTimeout(void)
@@ -661,6 +669,16 @@ exit:
return;
}
#if OT_SHOULD_LOG_AT(OT_LOG_LEVEL_WARN)
void BorderAgent::LogError(const char *aActionText, Error aError)
{
if (aError != kErrorNone)
{
LogWarn("Failed to %s: %s", aActionText, ErrorToString(aError));
}
}
#endif
} // namespace MeshCoP
} // namespace ot
src/core/meshcop/border_agent.hpp
+15 -14
View File
@@ -156,6 +156,9 @@ public:
uint16_t GetUdpProxyPort(void) const { return mUdpProxyPort; }
private:
static constexpr uint16_t kUdpPort = OPENTHREAD_CONFIG_BORDER_AGENT_UDP_PORT;
static constexpr uint32_t kKeepAliveTimeout = 50 * 1000; // Timeout to reject a commissioner (in msec)
class ForwardContext : public InstanceLocatorInit
{
public:
@@ -176,6 +179,7 @@ private:
void HandleNotifierEvents(Events aEvents);
Coap::Message::Code CoapCodeFromError(Error aError);
Error SendMessage(Coap::Message &aMessage);
void SendErrorMessage(ForwardContext &aForwardContext, Error aError);
void SendErrorMessage(const Coap::Message &aRequest, bool aSeparate, Error aError);
@@ -191,27 +195,24 @@ private:
const otMessageInfo *aMessageInfo,
Error aResult);
void HandleCoapResponse(ForwardContext &aForwardContext, const Coap::Message *aResponse, Error aResult);
Error ForwardToLeader(const Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo, Uri aUri);
Error ForwardToCommissioner(Coap::Message &aForwardMessage, const Message &aMessage);
static bool HandleUdpReceive(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo)
{
return static_cast<BorderAgent *>(aContext)->HandleUdpReceive(AsCoreType(aMessage), AsCoreType(aMessageInfo));
}
bool HandleUdpReceive(const Message &aMessage, const Ip6::MessageInfo &aMessageInfo);
static bool HandleUdpReceive(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo);
bool HandleUdpReceive(const Message &aMessage, const Ip6::MessageInfo &aMessageInfo);
static constexpr uint32_t kKeepAliveTimeout = 50 * 1000; // Timeout to reject a commissioner.
#if OT_SHOULD_LOG_AT(OT_LOG_LEVEL_WARN)
void LogError(const char *aActionText, Error aError);
#else
void LogError(const char *, Error) {}
#endif
using TimeoutTimer = TimerMilliIn<BorderAgent, &BorderAgent::HandleTimeout>;
Ip6::MessageInfo mMessageInfo;
Ip6::Udp::Receiver mUdpReceiver; ///< The UDP receiver to receive packets from external commissioner
State mState;
uint16_t mUdpProxyPort;
Ip6::Udp::Receiver mUdpReceiver;
Ip6::Netif::UnicastAddress mCommissionerAloc;
TimeoutTimer mTimer;
State mState;
uint16_t mUdpProxyPort;
TimeoutTimer mTimer;
#if OPENTHREAD_CONFIG_BORDER_AGENT_ID_ENABLE
Id mId;
bool mIdInitialized;