blob: e89ec2b9f4a5c2d7fcfe81f03c6b382462e3a20c [file] [log] [blame]
/*
* Copyright (c) 2021 Project CHIP Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#pragma once
#include <transport/SessionHandle.h>
#include <transport/raw/MessageHeader.h>
namespace chip {
/**
* @brief
* This class provides a skeleton for the callback functions. The functions will be
* called by SecureSssionMgrBase object on specific events. If the user of SessionManager
* is interested in receiving these callbacks, they can specialize this class and handle
* each trigger in their implementation of this class.
*/
class DLL_EXPORT SessionMessageDelegate
{
public:
virtual ~SessionMessageDelegate() {}
enum class DuplicateMessage : uint8_t
{
Yes,
No,
};
/**
* @brief
* Called when a new message is received. The function must internally release the
* msgBuf after processing it.
*
* @param packetHeader The message header
* @param payloadHeader The payload header
* @param session The handle to the secure session
* @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, DuplicateMessage isDuplicate,
System::PacketBufferHandle && msgBuf) = 0;
};
} // namespace chip