blob: fc3865d5ccdaf8894aeb3de6289628b5760cd3d7 [file] [log] [blame]
/*
*
* Copyright (c) 2020-2021 Project CHIP Authors
* All rights reserved.
*
* 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.
*/
/**
* @file
* This file implements an object for a CHIP Echo unsolicited
* responder (server).
*
*/
#include "Echo.h"
namespace chip {
namespace Protocols {
namespace Echo {
CHIP_ERROR EchoServer::Init(Messaging::ExchangeManager * exchangeMgr)
{
// Error if already initialized.
VerifyOrReturnError(mExchangeMgr == nullptr, CHIP_ERROR_INCORRECT_STATE);
mExchangeMgr = exchangeMgr;
OnEchoRequestReceived = nullptr;
// Register to receive unsolicited Echo Request messages from the exchange manager.
mExchangeMgr->RegisterUnsolicitedMessageHandlerForType(MsgType::EchoRequest, this);
return CHIP_NO_ERROR;
}
void EchoServer::Shutdown()
{
if (mExchangeMgr != nullptr)
{
mExchangeMgr->UnregisterUnsolicitedMessageHandlerForType(MsgType::EchoRequest);
mExchangeMgr = nullptr;
}
}
CHIP_ERROR EchoServer::OnUnsolicitedMessageReceived(const PayloadHeader & payloadHeader, ExchangeDelegate *& newDelegate)
{
// Handle messages by myself
newDelegate = this;
return CHIP_NO_ERROR;
}
CHIP_ERROR EchoServer::OnMessageReceived(Messaging::ExchangeContext * ec, const PayloadHeader & payloadHeader,
System::PacketBufferHandle && payload)
{
// NOTE: we already know this is an Echo Request message because we explicitly registered with the
// Exchange Manager for unsolicited Echo Requests.
// Call the registered OnEchoRequestReceived handler, if any.
if (OnEchoRequestReceived != nullptr)
{
OnEchoRequestReceived(ec, payload.Retain());
}
System::PacketBufferHandle response;
// Since we are re-using the inbound EchoRequest buffer to send the EchoResponse, if necessary,
// adjust the position of the payload within the buffer to ensure there is enough room for the
// outgoing network headers. This is necessary because in some network stack configurations,
// the incoming header size may be smaller than the outgoing size.
if (payload->EnsureReservedSize(CHIP_SYSTEM_CONFIG_HEADER_RESERVE_SIZE) && MessagePacketBuffer::HasFooterSpace(payload))
{
response = std::move(payload);
}
else
{
response = MessagePacketBuffer::NewWithData(payload->Start(), payload->DataLength());
VerifyOrReturnError(!response.IsNull(), CHIP_ERROR_NO_MEMORY);
}
// Send an Echo Response back to the sender.
return ec->SendMessage(MsgType::EchoResponse, std::move(response));
}
} // namespace Echo
} // namespace Protocols
} // namespace chip