Some conversions to use PacketBufferHandle (#3909)

Co-authored-by: Restyled.io <[email protected]>
project-chip · Nov 24, 2020 · f54b925 · f54b925
1 parent 0abf731
commit f54b925
Show file tree

Hide file tree

Showing 77 changed files with 531 additions and 654 deletions.
diff --git a/examples/all-clusters-app/esp32/main/EchoServer.cpp b/examples/all-clusters-app/esp32/main/EchoServer.cpp
@@ -123,14 +123,14 @@ class EchoServerCallback : public SecureSessionMgrDelegate
 {
 public:
     void OnMessageReceived(const PacketHeader & header, const PayloadHeader & payloadHeader,
-                           const Transport::PeerConnectionState * state, System::PacketBuffer * buffer,
+                           const Transport::PeerConnectionState * state, System::PacketBufferHandle buffer,
                            SecureSessionMgr * mgr) override
     {
         CHIP_ERROR err;
         const size_t data_len = buffer->DataLength();
 
         // as soon as a client connects, assume it is connected
-        VerifyOrExit(mgr != NULL && buffer != NULL, ESP_LOGE(TAG, "Received data but couldn't process it..."));
+        VerifyOrExit(mgr != NULL && !buffer.IsNull(), ESP_LOGE(TAG, "Received data but couldn't process it..."));
         VerifyOrExit(state->GetPeerNodeId() != kUndefinedNodeId, ESP_LOGE(TAG, "Unknown source for received message"));
 
         {
@@ -148,8 +148,7 @@ class EchoServerCallback : public SecureSessionMgrDelegate
         // port from data model processing.
         if (ContentMayBeADataModelMessage(buffer))
         {
-            HandleDataModelMessage(header, buffer, mgr);
-            buffer = NULL;
+            HandleDataModelMessage(header, std::move(buffer), mgr);
         }
         else
         {
@@ -160,8 +159,7 @@ class EchoServerCallback : public SecureSessionMgrDelegate
             ESP_LOGI(TAG, "Client sent: %s", logmsg);
 
             // Attempt to echo back
-            err    = mgr->SendMessage(header.GetSourceNodeId().Value(), buffer);
-            buffer = NULL;
+            err = mgr->SendMessage(header.GetSourceNodeId().Value(), buffer.Release_ForNow());
             if (err != CHIP_NO_ERROR)
             {
                 ESP_LOGE(TAG, "Unable to echo back to client: %s", ErrorStr(err));
@@ -172,13 +170,7 @@ class EchoServerCallback : public SecureSessionMgrDelegate
             }
         }
 
-    exit:
-
-        // SendTo calls Free on the buffer without an AddRef, if SendTo was not called, free the buffer.
-        if (buffer != NULL)
-        {
-            System::PacketBuffer::Free(buffer);
-        }
+    exit:;
     }
 
     void OnReceiveError(CHIP_ERROR error, const Transport::PeerAddress & source, SecureSessionMgr * mgr) override
@@ -201,7 +193,7 @@ class EchoServerCallback : public SecureSessionMgrDelegate
      * Echo messages should generally not have a first byte with those values, so we
      * can use that to try to distinguish between the two.
      */
-    bool ContentMayBeADataModelMessage(System::PacketBuffer * buffer)
+    bool ContentMayBeADataModelMessage(const System::PacketBufferHandle & buffer)
     {
         const size_t data_len      = buffer->DataLength();
         const uint8_t * data       = buffer->Start();

diff --git a/examples/chip-tool/commands/clusters/Commands.h b/examples/chip-tool/commands/clusters/Commands.h
diff --git a/examples/chip-tool/commands/common/EchoCommand.cpp b/examples/chip-tool/commands/common/EchoCommand.cpp
@@ -56,7 +56,7 @@ void EchoCommand::SendEcho() const
     }
 }
 
-void EchoCommand::ReceiveEcho(PacketBuffer * buffer) const
+void EchoCommand::ReceiveEcho(PacketBufferHandle buffer) const
 {
     // attempt to print the incoming message
     size_t data_len               = buffer->DataLength();

diff --git a/examples/chip-tool/commands/common/EchoCommand.h b/examples/chip-tool/commands/common/EchoCommand.h
@@ -30,12 +30,12 @@ class EchoCommand : public NetworkCommand
 
     /////////// IPCommand Interface /////////
     void OnConnect(ChipDeviceController * dc) override { mController = dc; }
-    void OnMessage(ChipDeviceController * dc, chip::System::PacketBuffer * buffer) override { ReceiveEcho(buffer); }
+    void OnMessage(ChipDeviceController * dc, chip::System::PacketBufferHandle buffer) override { ReceiveEcho(std::move(buffer)); }
     void OnError(ChipDeviceController * dc, CHIP_ERROR err) override { mController = nullptr; }
 
 private:
     void SendEcho(void) const;
-    void ReceiveEcho(chip::System::PacketBuffer * buffer) const;
+    void ReceiveEcho(chip::System::PacketBufferHandle buffer) const;
 
     ChipDeviceController * mController = nullptr;
 };
diff --git a/examples/chip-tool/commands/common/ModelCommand.cpp b/examples/chip-tool/commands/common/ModelCommand.cpp
@@ -58,9 +58,9 @@ void ModelCommand::OnError(ChipDeviceController * dc, CHIP_ERROR err)
     UpdateWaitForResponse(false);
 }
 
-void ModelCommand::OnMessage(ChipDeviceController * dc, PacketBuffer * buffer)
+void ModelCommand::OnMessage(ChipDeviceController * dc, PacketBufferHandle buffer)
 {
-    SetCommandExitStatus(ReceiveCommandResponse(dc, buffer));
+    SetCommandExitStatus(ReceiveCommandResponse(dc, std::move(buffer)));
     UpdateWaitForResponse(false);
 }
 
@@ -95,7 +95,7 @@ bool ModelCommand::SendCommand(ChipDeviceController * dc)
     ChipLogProgress(chipTool, "Endpoint id: '0x%02x', Cluster id: '0x%04x', Command id: '0x%02x'", mEndPointId, mClusterId,
                     mCommandId);
 
-    uint16_t dataLength = EncodeCommand(buffer.Get_ForNow(), bufferSize, mEndPointId);
+    uint16_t dataLength = EncodeCommand(buffer, bufferSize, mEndPointId);
     if (dataLength == 0)
     {
         ChipLogError(chipTool, "Error while encoding data for command: %s", GetName());
@@ -106,14 +106,14 @@ bool ModelCommand::SendCommand(ChipDeviceController * dc)
     ChipLogDetail(chipTool, "Encoded data of length %d", dataLength);
 
 #ifdef DEBUG
-    PrintBuffer(buffer.Get_ForNow());
+    PrintBuffer(buffer);
 #endif
 
     dc->SendMessage(NULL, buffer.Release_ForNow());
     return true;
 }
 
-bool ModelCommand::ReceiveCommandResponse(ChipDeviceController * dc, PacketBuffer * buffer) const
+bool ModelCommand::ReceiveCommandResponse(ChipDeviceController * dc, PacketBufferHandle buffer) const
 {
     EmberApsFrame frame;
     uint8_t * message;
@@ -126,7 +126,6 @@ bool ModelCommand::ReceiveCommandResponse(ChipDeviceController * dc, PacketBuffe
     if (extractApsFrame(buffer->Start(), buffer->DataLength(), &frame) == 0)
     {
         ChipLogError(chipTool, "APS frame processing failure!");
-        PacketBuffer::Free(buffer);
         ExitNow();
     }
     ChipLogDetail(chipTool, "APS frame processing success!");
@@ -171,7 +170,7 @@ void ModelCommand::WaitForResponse()
     }
 }
 
-void ModelCommand::PrintBuffer(PacketBuffer * buffer) const
+void ModelCommand::PrintBuffer(const PacketBufferHandle & buffer) const
 {
     const size_t data_len = buffer->DataLength();
 

diff --git a/examples/chip-tool/commands/common/ModelCommand.h b/examples/chip-tool/commands/common/ModelCommand.h
@@ -50,19 +50,19 @@ class ModelCommand : public NetworkCommand
     /////////// IPCommand Interface /////////
     void OnConnect(ChipDeviceController * dc) override;
     void OnError(ChipDeviceController * dc, CHIP_ERROR err) override;
-    void OnMessage(ChipDeviceController * dc, chip::System::PacketBuffer * buffer) override;
+    void OnMessage(ChipDeviceController * dc, chip::System::PacketBufferHandle buffer) override;
 
-    virtual uint16_t EncodeCommand(chip::System::PacketBuffer * buffer, uint16_t bufferSize, uint8_t endPointId) = 0;
+    virtual uint16_t EncodeCommand(const chip::System::PacketBufferHandle & buffer, uint16_t bufferSize, uint8_t endPointId) = 0;
     virtual bool HandleGlobalResponse(uint8_t commandId, uint8_t * message, uint16_t messageLen) const { return false; }
     virtual bool HandleSpecificResponse(uint8_t commandId, uint8_t * message, uint16_t messageLen) const { return false; }
 
 private:
     bool SendCommand(ChipDeviceController * dc);
-    bool ReceiveCommandResponse(ChipDeviceController * dc, chip::System::PacketBuffer * buffer) const;
+    bool ReceiveCommandResponse(ChipDeviceController * dc, chip::System::PacketBufferHandle buffer) const;
 
     void UpdateWaitForResponse(bool value);
     void WaitForResponse(void);
-    void PrintBuffer(chip::System::PacketBuffer * buffer) const;
+    void PrintBuffer(const chip::System::PacketBufferHandle & buffer) const;
 
     std::condition_variable cvWaitingForResponse;
     std::mutex cvWaitingForResponseMutex;

diff --git a/examples/chip-tool/commands/common/NetworkCommand.cpp b/examples/chip-tool/commands/common/NetworkCommand.cpp
@@ -38,14 +38,12 @@ static void onError(ChipDeviceController * dc, void * appReqState, CHIP_ERROR er
     command->OnError(dc, err);
 }
 
-static void onMessage(ChipDeviceController * dc, void * appReqState, PacketBuffer * buffer)
+static void onMessage(ChipDeviceController * dc, void * appReqState, PacketBufferHandle buffer)
 {
     ChipLogDetail(chipTool, "OnMessage: Received %zu bytes", buffer->DataLength());
 
     NetworkCommand * command = reinterpret_cast<NetworkCommand *>(dc->AppState);
-    command->OnMessage(dc, buffer);
-
-    PacketBuffer::Free(buffer);
+    command->OnMessage(dc, std::move(buffer));
 }
 
 CHIP_ERROR NetworkCommand::Run(ChipDeviceController * dc, NodeId remoteId)

diff --git a/examples/chip-tool/commands/common/NetworkCommand.h b/examples/chip-tool/commands/common/NetworkCommand.h
@@ -51,9 +51,9 @@ class NetworkCommand : public Command
 
     const char * GetNetworkName(void) const { return mName; }
 
-    virtual void OnConnect(ChipDeviceController * dc)                                      = 0;
-    virtual void OnError(ChipDeviceController * dc, CHIP_ERROR err)                        = 0;
-    virtual void OnMessage(ChipDeviceController * dc, chip::System::PacketBuffer * buffer) = 0;
+    virtual void OnConnect(ChipDeviceController * dc)                                          = 0;
+    virtual void OnError(ChipDeviceController * dc, CHIP_ERROR err)                            = 0;
+    virtual void OnMessage(ChipDeviceController * dc, chip::System::PacketBufferHandle buffer) = 0;
 
     CHIP_ERROR Run(ChipDeviceController * dc, NodeId remoteId) override;
 

diff --git a/examples/common/chip-app-server/DataModelHandler.cpp b/examples/common/chip-app-server/DataModelHandler.cpp
@@ -40,7 +40,7 @@ using namespace ::chip;
  * @param [in] buffer The buffer holding the message.  This function guarantees
  *                    that it will free the buffer before returning.
  */
-void HandleDataModelMessage(const PacketHeader & header, System::PacketBuffer * buffer, SecureSessionMgr * mgr)
+void HandleDataModelMessage(const PacketHeader & header, System::PacketBufferHandle buffer, SecureSessionMgr * mgr)
 {
     EmberApsFrame frame;
     bool ok = extractApsFrame(buffer->Start(), buffer->DataLength(), &frame) > 0;
@@ -51,7 +51,6 @@ void HandleDataModelMessage(const PacketHeader & header, System::PacketBuffer *
     else
     {
         ChipLogProgress(Zcl, "APS frame processing failure!");
-        System::PacketBuffer::Free(buffer);
         return;
     }
 
@@ -63,8 +62,6 @@ void HandleDataModelMessage(const PacketHeader & header, System::PacketBuffer *
                                header.GetSourceNodeId().Value(), // source identifier
                                NULL);
 
-    System::PacketBuffer::Free(buffer);
-
     if (ok)
     {
         ChipLogProgress(Zcl, "Data model processing success!");

diff --git a/examples/common/chip-app-server/RendezvousServer.cpp b/examples/common/chip-app-server/RendezvousServer.cpp
@@ -57,10 +57,8 @@ void RendezvousServer::OnRendezvousConnectionClosed()
 }
 
 void RendezvousServer::OnRendezvousMessageReceived(const PacketHeader & packetHeader, const PeerAddress & peerAddress,
-                                                   PacketBuffer * buffer)
-{
-    chip::System::PacketBuffer::Free(buffer);
-}
+                                                   System::PacketBufferHandle buffer)
+{}
 
 void RendezvousServer::OnRendezvousComplete()
 {

diff --git a/examples/common/chip-app-server/Server.cpp b/examples/common/chip-app-server/Server.cpp
@@ -46,14 +46,14 @@ class ServerCallback : public SecureSessionMgrDelegate
 {
 public:
     void OnMessageReceived(const PacketHeader & header, const PayloadHeader & payloadHeader,
-                           const Transport::PeerConnectionState * state, System::PacketBuffer * buffer,
+                           const Transport::PeerConnectionState * state, System::PacketBufferHandle buffer,
                            SecureSessionMgr * mgr) override
     {
         const size_t data_len = buffer->DataLength();
         char src_addr[PeerAddress::kMaxToStringSize];
 
         // as soon as a client connects, assume it is connected
-        VerifyOrExit(buffer != NULL, ChipLogProgress(AppServer, "Received data but couldn't process it..."));
+        VerifyOrExit(!buffer.IsNull(), ChipLogProgress(AppServer, "Received data but couldn't process it..."));
         VerifyOrExit(header.GetSourceNodeId().HasValue(), ChipLogProgress(AppServer, "Unknown source for received message"));
 
         VerifyOrExit(state->GetPeerNodeId() != kUndefinedNodeId, ChipLogProgress(AppServer, "Unknown source for received message"));
@@ -62,16 +62,9 @@ class ServerCallback : public SecureSessionMgrDelegate
 
         ChipLogProgress(AppServer, "Packet received from %s: %zu bytes", src_addr, static_cast<size_t>(data_len));
 
-        HandleDataModelMessage(header, buffer, mgr);
-        buffer = NULL;
+        HandleDataModelMessage(header, std::move(buffer), mgr);
 
-    exit:
-        // HandleDataModelMessage calls Free on the buffer without an AddRef, if HandleDataModelMessage was not called, free the
-        // buffer.
-        if (buffer != NULL)
-        {
-            System::PacketBuffer::Free(buffer);
-        }
+    exit:;
     }
 
     void OnNewConnection(const Transport::PeerConnectionState * state, SecureSessionMgr * mgr) override

diff --git a/examples/common/chip-app-server/include/DataModelHandler.h b/examples/common/chip-app-server/include/DataModelHandler.h
@@ -33,5 +33,6 @@
  * @param [in] buffer The buffer holding the message.  This function guarantees
  *                    that it will free the buffer before returning.
  */
-void HandleDataModelMessage(const chip::PacketHeader & header, chip::System::PacketBuffer * buffer, chip::SecureSessionMgr * mgr);
+void HandleDataModelMessage(const chip::PacketHeader & header, chip::System::PacketBufferHandle buffer,
+                            chip::SecureSessionMgr * mgr);
 void InitDataModelHandler();
diff --git a/examples/common/chip-app-server/include/RendezvousServer.h b/examples/common/chip-app-server/include/RendezvousServer.h
@@ -35,7 +35,7 @@ class RendezvousServer : public RendezvousSessionDelegate
     void OnRendezvousConnectionClosed() override;
     void OnRendezvousError(CHIP_ERROR err) override;
     void OnRendezvousMessageReceived(const PacketHeader & packetHeader, const Transport::PeerAddress & peerAddress,
-                                     System::PacketBuffer * buffer) override;
+                                     System::PacketBufferHandle buffer) override;
     void OnRendezvousComplete() override;
     void OnRendezvousStatusUpdate(Status status, CHIP_ERROR err) override;
     RendezvousSession * GetRendezvousSession() { return &mRendezvousSession; };

diff --git a/examples/temperature-measurement-app/esp32/main/ResponseServer.cpp b/examples/temperature-measurement-app/esp32/main/ResponseServer.cpp
@@ -62,14 +62,14 @@ class ResponseServerCallback : public SecureSessionMgrDelegate
 {
 public:
     void OnMessageReceived(const PacketHeader & header, const PayloadHeader & payloadHeader,
-                           const Transport::PeerConnectionState * state, System::PacketBuffer * buffer,
+                           const Transport::PeerConnectionState * state, System::PacketBufferHandle buffer,
                            SecureSessionMgr * mgr) override
     {
         CHIP_ERROR err;
         const size_t data_len = buffer->DataLength();
 
         // as soon as a client connects, assume it is connected
-        VerifyOrExit(mgr != nullptr && buffer != nullptr, ESP_LOGE(TAG, "Received data but couldn't process it..."));
+        VerifyOrExit(mgr != nullptr && !buffer.IsNull(), ESP_LOGE(TAG, "Received data but couldn't process it..."));
         VerifyOrExit(state->GetPeerNodeId() != kUndefinedNodeId, ESP_LOGE(TAG, "Unknown source for received message"));
 
         {
@@ -80,16 +80,9 @@ class ResponseServerCallback : public SecureSessionMgrDelegate
             ESP_LOGI(TAG, "Packet received from %s: %zu bytes", src_addr, static_cast<size_t>(data_len));
         }
 
-        HandleDataModelMessage(header, buffer, mgr);
-        buffer = nullptr;
+        HandleDataModelMessage(header, std::move(buffer), mgr);
 
-    exit:
-
-        // SendTo calls Free on the buffer without an AddRef, if SendTo was not called, free the buffer.
-        if (buffer != nullptr)
-        {
-            System::PacketBuffer::Free(buffer);
-        }
+    exit:;
     }
 
     void OnReceiveError(CHIP_ERROR error, const Transport::PeerAddress & source, SecureSessionMgr * mgr) override
@@ -111,7 +104,7 @@ class ResponseServerCallback : public SecureSessionMgrDelegate
      * Echo messages should generally not have a first byte with those values, so we
      * can use that to try to distinguish between the two.
      */
-    bool ContentMayBeADataModelMessage(System::PacketBuffer * buffer)
+    bool ContentMayBeADataModelMessage(const System::PacketBufferHandle & buffer)
     {
         const size_t data_len      = buffer->DataLength();
         const uint8_t * data       = buffer->Start();