From 25f9a24bce30d05d3d2678f1590019ea5a27f117 Mon Sep 17 00:00:00 2001 From: Pankaj Garg Date: Tue, 1 Jun 2021 15:46:40 -0700 Subject: [PATCH] add documentation to the function --- src/protocols/secure_channel/CASESession.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/protocols/secure_channel/CASESession.h b/src/protocols/secure_channel/CASESession.h index faf5e01927493a..15aea89280ebfb 100644 --- a/src/protocols/secure_channel/CASESession.h +++ b/src/protocols/secure_channel/CASESession.h @@ -224,6 +224,10 @@ class DLL_EXPORT CASESession : public Messaging::ExchangeDelegate, public Pairin CHIP_ERROR ComputeIPK(const uint16_t sessionID, uint8_t * ipk, size_t ipkLen); void SendErrorMsg(SigmaErrorType errorCode); + + // This function always returns an error. The error value corresponds to the error in the received message. + // The returned error value helps top level message receiver/dispatcher to close the exchange context + // in a more seemless manner. CHIP_ERROR HandleErrorMsg(const System::PacketBufferHandle & msg); void CloseExchange();