Remove address argument on ExchangeManager::OnMessageReceived (#17583)

kghost · pull[bot] · commit 28f10b7d080d · 2023-10-11T21:09:46.000Z
diff --git a/src/messaging/ExchangeContext.cpp b/src/messaging/ExchangeContext.cpp
@@ -415,8 +415,7 @@ void ExchangeContext::NotifyResponseTimeout()
     MessageHandled();
 }
 
-CHIP_ERROR ExchangeContext::HandleMessage(uint32_t messageCounter, const PayloadHeader & payloadHeader,
-                                          const Transport::PeerAddress & peerAddress, MessageFlags msgFlags,
+CHIP_ERROR ExchangeContext::HandleMessage(uint32_t messageCounter, const PayloadHeader & payloadHeader, MessageFlags msgFlags,
                                           PacketBufferHandle && msgBuf)
 {
     // We hold a reference to the ExchangeContext here to
@@ -457,8 +456,7 @@ CHIP_ERROR ExchangeContext::HandleMessage(uint32_t messageCounter, const Payload
         MessageHandled();
     });
 
-    ReturnErrorOnFailure(
-        mDispatch.OnMessageReceived(messageCounter, payloadHeader, peerAddress, msgFlags, GetReliableMessageContext()));
+    ReturnErrorOnFailure(mDispatch.OnMessageReceived(messageCounter, payloadHeader, msgFlags, GetReliableMessageContext()));
 
     if (IsAckPending() && !mDelegate)
     {
diff --git a/src/messaging/ExchangeContext.h b/src/messaging/ExchangeContext.h
@@ -135,7 +135,6 @@ class DLL_EXPORT ExchangeContext : public ReliableMessageContext,
      *
      *  @param[in]    messageCounter  The message counter of the packet.
      *  @param[in]    payloadHeader   A reference to the PayloadHeader object.
-     *  @param[in]    peerAddress     The address of the sender
      *  @param[in]    msgFlags        The message flags corresponding to the received message
      *  @param[in]    msgBuf          A handle to the packet buffer holding the CHIP message.
      *
@@ -144,8 +143,7 @@ class DLL_EXPORT ExchangeContext : public ReliableMessageContext,
      *  @retval  #CHIP_NO_ERROR                             if the CHIP layer successfully delivered the message up to the
      *                                                       protocol layer.
      */
-    CHIP_ERROR HandleMessage(uint32_t messageCounter, const PayloadHeader & payloadHeader,
-                             const Transport::PeerAddress & peerAddress, MessageFlags msgFlags,
+    CHIP_ERROR HandleMessage(uint32_t messageCounter, const PayloadHeader & payloadHeader, MessageFlags msgFlags,
                              System::PacketBufferHandle && msgBuf);
 
     ExchangeDelegate * GetDelegate() const { return mDelegate; }
diff --git a/src/messaging/ExchangeMessageDispatch.cpp b/src/messaging/ExchangeMessageDispatch.cpp
@@ -114,8 +114,7 @@ CHIP_ERROR ExchangeMessageDispatch::SendMessage(SessionManager * sessionManager,
 }
 
 CHIP_ERROR ExchangeMessageDispatch::OnMessageReceived(uint32_t messageCounter, const PayloadHeader & payloadHeader,
-                                                      const Transport::PeerAddress & peerAddress, MessageFlags msgFlags,
-                                                      ReliableMessageContext * reliableMessageContext)
+                                                      MessageFlags msgFlags, ReliableMessageContext * reliableMessageContext)
 {
     ReturnErrorCodeIf(!MessagePermitted(payloadHeader.GetProtocolID().GetProtocolId(), payloadHeader.GetMessageType()),
                       CHIP_ERROR_INVALID_ARGUMENT);
diff --git a/src/messaging/ExchangeMessageDispatch.h b/src/messaging/ExchangeMessageDispatch.h
@@ -42,8 +42,7 @@ class ExchangeMessageDispatch
     CHIP_ERROR SendMessage(SessionManager * sessionManager, const SessionHandle & session, uint16_t exchangeId, bool isInitiator,
                            ReliableMessageContext * reliableMessageContext, bool isReliableTransmission, Protocols::Id protocol,
                            uint8_t type, System::PacketBufferHandle && message);
-    CHIP_ERROR OnMessageReceived(uint32_t messageCounter, const PayloadHeader & payloadHeader,
-                                 const Transport::PeerAddress & peerAddress, MessageFlags msgFlags,
+    CHIP_ERROR OnMessageReceived(uint32_t messageCounter, const PayloadHeader & payloadHeader, MessageFlags msgFlags,
                                  ReliableMessageContext * reliableMessageContext);
 
 protected:
diff --git a/src/messaging/ExchangeMgr.cpp b/src/messaging/ExchangeMgr.cpp
@@ -182,8 +182,8 @@ CHIP_ERROR ExchangeManager::UnregisterUMH(Protocols::Id protocolId, int16_t msgT
 }
 
 void ExchangeManager::OnMessageReceived(const PacketHeader & packetHeader, const PayloadHeader & payloadHeader,
-                                        const SessionHandle & session, const Transport::PeerAddress & source,
-                                        DuplicateMessage isDuplicate, System::PacketBufferHandle && msgBuf)
+                                        const SessionHandle & session, DuplicateMessage isDuplicate,
+                                        System::PacketBufferHandle && msgBuf)
 {
     UnsolicitedMessageHandlerSlot * matchingUMH = nullptr;
 
@@ -219,7 +219,7 @@ void ExchangeManager::OnMessageReceived(const PacketHeader & packetHeader, const
                               ChipLogValueExchange(ec), ec->GetDelegate());
 
                 // Matched ExchangeContext; send to message handler.
-                ec->HandleMessage(packetHeader.GetMessageCounter(), payloadHeader, source, msgFlags, std::move(msgBuf));
+                ec->HandleMessage(packetHeader.GetMessageCounter(), payloadHeader, msgFlags, std::move(msgBuf));
                 found = true;
                 return Loop::Break;
             }
@@ -317,7 +317,7 @@ void ExchangeManager::OnMessageReceived(const PacketHeader & packetHeader, const
             return;
         }
 
-        CHIP_ERROR err = ec->HandleMessage(packetHeader.GetMessageCounter(), payloadHeader, source, msgFlags, std::move(msgBuf));
+        CHIP_ERROR err = ec->HandleMessage(packetHeader.GetMessageCounter(), payloadHeader, msgFlags, std::move(msgBuf));
         if (err != CHIP_NO_ERROR)
         {
             // Using same error message for all errors to reduce code size.
diff --git a/src/messaging/ExchangeMgr.h b/src/messaging/ExchangeMgr.h
@@ -33,7 +33,6 @@
 #include <messaging/ReliableMessageMgr.h>
 #include <protocols/Protocols.h>
 #include <transport/SessionManager.h>
-#include <transport/TransportMgr.h>
 
 namespace chip {
 namespace Messaging {
@@ -240,8 +239,7 @@ class DLL_EXPORT ExchangeManager : public SessionMessageDelegate
     CHIP_ERROR UnregisterUMH(Protocols::Id protocolId, int16_t msgType);
 
     void OnMessageReceived(const PacketHeader & packetHeader, const PayloadHeader & payloadHeader, const SessionHandle & session,
-                           const Transport::PeerAddress & source, DuplicateMessage isDuplicate,
-                           System::PacketBufferHandle && msgBuf) override;
+                           DuplicateMessage isDuplicate, System::PacketBufferHandle && msgBuf) override;
 };
 
 } // namespace Messaging
diff --git a/src/transport/SessionManager.cpp b/src/transport/SessionManager.cpp
@@ -548,7 +548,7 @@ void SessionManager::UnauthenticatedMessageDispatch(const PacketHeader & packetH
     if (mCB != nullptr)
     {
         CHIP_TRACE_MESSAGE_RECEIVED(payloadHeader, packetHeader, unsecuredSession, peerAddress, msg->Start(), msg->TotalLength());
-        mCB->OnMessageReceived(packetHeader, payloadHeader, session, peerAddress, isDuplicate, std::move(msg));
+        mCB->OnMessageReceived(packetHeader, payloadHeader, session, isDuplicate, std::move(msg));
     }
 }
 
@@ -631,7 +631,7 @@ void SessionManager::SecureUnicastMessageDispatch(const PacketHeader & packetHea
     if (mCB != nullptr)
     {
         CHIP_TRACE_MESSAGE_RECEIVED(payloadHeader, packetHeader, secureSession, peerAddress, msg->Start(), msg->TotalLength());
-        mCB->OnMessageReceived(packetHeader, payloadHeader, session.Value(), peerAddress, isDuplicate, std::move(msg));
+        mCB->OnMessageReceived(packetHeader, payloadHeader, session.Value(), isDuplicate, std::move(msg));
     }
 }
 
@@ -763,7 +763,7 @@ void SessionManager::SecureGroupMessageDispatch(const PacketHeader & packetHeade
         Transport::IncomingGroupSession groupSession(groupContext.group_id, groupContext.fabric_index,
                                                      packetHeader.GetSourceNodeId().Value());
         CHIP_TRACE_MESSAGE_RECEIVED(payloadHeader, packetHeader, &groupSession, peerAddress, msg->Start(), msg->TotalLength());
-        mCB->OnMessageReceived(packetHeader, payloadHeader, SessionHandle(groupSession), peerAddress,
+        mCB->OnMessageReceived(packetHeader, payloadHeader, SessionHandle(groupSession),
                                SessionMessageDelegate::DuplicateMessage::No, std::move(msg));
     }
 }
diff --git a/src/transport/SessionMessageDelegate.h b/src/transport/SessionMessageDelegate.h
@@ -46,13 +46,12 @@ class DLL_EXPORT SessionMessageDelegate
      * @param packetHeader  The message header
      * @param payloadHeader The payload header
      * @param session       The handle to the secure session
-     * @param source        The sender's address
      * @param isDuplicate   The message is a duplicate of previously received message
      * @param msgBuf        The received message
      */
     virtual void OnMessageReceived(const PacketHeader & packetHeader, const PayloadHeader & payloadHeader,
-                                   const SessionHandle & session, const Transport::PeerAddress & source,
-                                   DuplicateMessage isDuplicate, System::PacketBufferHandle && msgBuf) = 0;
+                                   const SessionHandle & session, DuplicateMessage isDuplicate,
+                                   System::PacketBufferHandle && msgBuf) = 0;
 };
 
 } // namespace chip
diff --git a/src/transport/tests/TestSessionManager.cpp b/src/transport/tests/TestSessionManager.cpp
@@ -70,8 +70,7 @@ class TestSessMgrCallback : public SessionMessageDelegate
 {
 public:
     void OnMessageReceived(const PacketHeader & header, const PayloadHeader & payloadHeader, const SessionHandle & session,
-                           const Transport::PeerAddress & source, DuplicateMessage isDuplicate,
-                           System::PacketBufferHandle && msgBuf) override
+                           DuplicateMessage isDuplicate, System::PacketBufferHandle && msgBuf) override
     {
         size_t data_len = msgBuf->DataLength();
 

Original file line number	Diff line number	Diff line change
`@@ -415,8 +415,7 @@ void ExchangeContext::NotifyResponseTimeout()`
`415`	`415`	`MessageHandled();`
`416`	`416`	`}`
`417`	`417`
`418`		`-CHIP_ERROR ExchangeContext::HandleMessage(uint32_t messageCounter, const PayloadHeader & payloadHeader,`
`419`		`- const Transport::PeerAddress & peerAddress, MessageFlags msgFlags,`
	`418`	`+CHIP_ERROR ExchangeContext::HandleMessage(uint32_t messageCounter, const PayloadHeader & payloadHeader, MessageFlags msgFlags,`
`420`	`419`	`PacketBufferHandle && msgBuf)`
`421`	`420`	`{`
`422`	`421`	`// We hold a reference to the ExchangeContext here to`
`@@ -457,8 +456,7 @@ CHIP_ERROR ExchangeContext::HandleMessage(uint32_t messageCounter, const Payload`
`457`	`456`	`MessageHandled();`
`458`	`457`	`});`
`459`	`458`
`460`		`- ReturnErrorOnFailure(`
`461`		`- mDispatch.OnMessageReceived(messageCounter, payloadHeader, peerAddress, msgFlags, GetReliableMessageContext()));`
	`459`	`+ ReturnErrorOnFailure(mDispatch.OnMessageReceived(messageCounter, payloadHeader, msgFlags, GetReliableMessageContext()));`
`462`	`460`
`463`	`461`	`if (IsAckPending() && !mDelegate)`
`464`	`462`	`{`
Original file line number	Diff line number	Diff line change
`@@ -114,8 +114,7 @@ CHIP_ERROR ExchangeMessageDispatch::SendMessage(SessionManager * sessionManager,`
`114`	`114`	`}`
`115`	`115`
`116`	`116`	`CHIP_ERROR ExchangeMessageDispatch::OnMessageReceived(uint32_t messageCounter, const PayloadHeader & payloadHeader,`
`117`		`- const Transport::PeerAddress & peerAddress, MessageFlags msgFlags,`
`118`		`- ReliableMessageContext * reliableMessageContext)`
	`117`	`+ MessageFlags msgFlags, ReliableMessageContext * reliableMessageContext)`
`119`	`118`	`{`
`120`	`119`	`ReturnErrorCodeIf(!MessagePermitted(payloadHeader.GetProtocolID().GetProtocolId(), payloadHeader.GetMessageType()),`
`121`	`120`	`CHIP_ERROR_INVALID_ARGUMENT);`
Original file line number	Diff line number	Diff line change
`@@ -182,8 +182,8 @@ CHIP_ERROR ExchangeManager::UnregisterUMH(Protocols::Id protocolId, int16_t msgT`
`182`	`182`	`}`
`183`	`183`
`184`	`184`	`void ExchangeManager::OnMessageReceived(const PacketHeader & packetHeader, const PayloadHeader & payloadHeader,`
`185`		`- const SessionHandle & session, const Transport::PeerAddress & source,`
`186`		`- DuplicateMessage isDuplicate, System::PacketBufferHandle && msgBuf)`
	`185`	`+ const SessionHandle & session, DuplicateMessage isDuplicate,`
	`186`	`+ System::PacketBufferHandle && msgBuf)`
`187`	`187`	`{`
`188`	`188`	`UnsolicitedMessageHandlerSlot * matchingUMH = nullptr;`
`189`	`189`
`@@ -219,7 +219,7 @@ void ExchangeManager::OnMessageReceived(const PacketHeader & packetHeader, const`
`219`	`219`	`ChipLogValueExchange(ec), ec->GetDelegate());`
`220`	`220`
`221`	`221`	`// Matched ExchangeContext; send to message handler.`
`222`		`- ec->HandleMessage(packetHeader.GetMessageCounter(), payloadHeader, source, msgFlags, std::move(msgBuf));`
	`222`	`+ ec->HandleMessage(packetHeader.GetMessageCounter(), payloadHeader, msgFlags, std::move(msgBuf));`
`223`	`223`	`found = true;`
`224`	`224`	`return Loop::Break;`
`225`	`225`	`}`
`@@ -317,7 +317,7 @@ void ExchangeManager::OnMessageReceived(const PacketHeader & packetHeader, const`
`317`	`317`	`return;`
`318`	`318`	`}`
`319`	`319`
`320`		`- CHIP_ERROR err = ec->HandleMessage(packetHeader.GetMessageCounter(), payloadHeader, source, msgFlags, std::move(msgBuf));`
	`320`	`+ CHIP_ERROR err = ec->HandleMessage(packetHeader.GetMessageCounter(), payloadHeader, msgFlags, std::move(msgBuf));`
`321`	`321`	`if (err != CHIP_NO_ERROR)`
`322`	`322`	`{`
`323`	`323`	`// Using same error message for all errors to reduce code size.`
Original file line number	Diff line number	Diff line change
`@@ -548,7 +548,7 @@ void SessionManager::UnauthenticatedMessageDispatch(const PacketHeader & packetH`
`548`	`548`	`if (mCB != nullptr)`
`549`	`549`	`{`
`550`	`550`	`CHIP_TRACE_MESSAGE_RECEIVED(payloadHeader, packetHeader, unsecuredSession, peerAddress, msg->Start(), msg->TotalLength());`
`551`		`- mCB->OnMessageReceived(packetHeader, payloadHeader, session, peerAddress, isDuplicate, std::move(msg));`
	`551`	`+ mCB->OnMessageReceived(packetHeader, payloadHeader, session, isDuplicate, std::move(msg));`
`552`	`552`	`}`
`553`	`553`	`}`
`554`	`554`
`@@ -631,7 +631,7 @@ void SessionManager::SecureUnicastMessageDispatch(const PacketHeader & packetHea`
`631`	`631`	`if (mCB != nullptr)`
`632`	`632`	`{`
`633`	`633`	`CHIP_TRACE_MESSAGE_RECEIVED(payloadHeader, packetHeader, secureSession, peerAddress, msg->Start(), msg->TotalLength());`
`634`		`- mCB->OnMessageReceived(packetHeader, payloadHeader, session.Value(), peerAddress, isDuplicate, std::move(msg));`
	`634`	`+ mCB->OnMessageReceived(packetHeader, payloadHeader, session.Value(), isDuplicate, std::move(msg));`
`635`	`635`	`}`
`636`	`636`	`}`
`637`	`637`
`@@ -763,7 +763,7 @@ void SessionManager::SecureGroupMessageDispatch(const PacketHeader & packetHeade`
`763`	`763`	`Transport::IncomingGroupSession groupSession(groupContext.group_id, groupContext.fabric_index,`
`764`	`764`	`packetHeader.GetSourceNodeId().Value());`
`765`	`765`	`CHIP_TRACE_MESSAGE_RECEIVED(payloadHeader, packetHeader, &groupSession, peerAddress, msg->Start(), msg->TotalLength());`
`766`		`- mCB->OnMessageReceived(packetHeader, payloadHeader, SessionHandle(groupSession), peerAddress,`
	`766`	`+ mCB->OnMessageReceived(packetHeader, payloadHeader, SessionHandle(groupSession),`
`767`	`767`	`SessionMessageDelegate::DuplicateMessage::No, std::move(msg));`
`768`	`768`	`}`
`769`	`769`	`}`
Original file line number	Diff line number	Diff line change
`@@ -70,8 +70,7 @@ class TestSessMgrCallback : public SessionMessageDelegate`
`70`	`70`	`{`
`71`	`71`	`public:`
`72`	`72`	`void OnMessageReceived(const PacketHeader & header, const PayloadHeader & payloadHeader, const SessionHandle & session,`
`73`		`- const Transport::PeerAddress & source, DuplicateMessage isDuplicate,`
`74`		`- System::PacketBufferHandle && msgBuf) override`
	`73`	`+ DuplicateMessage isDuplicate, System::PacketBufferHandle && msgBuf) override`
`75`	`74`	`{`
`76`	`75`	`size_t data_len = msgBuf->DataLength();`
`77`	`76`