src/app/MessageDef/InvokeResponseMessage.h

/**
 *
 *    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 <app/AppConfig.h>
#include <app/util/basic-types.h>
#include <lib/core/CHIPCore.h>
#include <lib/core/TLV.h>
#include <lib/support/CodeUtils.h>
#include <lib/support/logging/CHIPLogging.h>

#include "InvokeResponseIBs.h"
#include "MessageBuilder.h"
#include "MessageParser.h"

namespace chip {
namespace app {
namespace InvokeResponseMessage {
enum class Tag : uint8_t
{
    kSuppressResponse    = 0,
    kInvokeResponses     = 1,
    kMoreChunkedMessages = 2,
};

class Parser : public MessageParser
{
public:
#if CHIP_CONFIG_IM_PRETTY_PRINT
    CHIP_ERROR PrettyPrint() const;
#endif // CHIP_CONFIG_IM_PRETTY_PRINT

    /**
     *  @brief Get SuppressResponse. Next() must be called before accessing them.
     *
     *  @return #CHIP_NO_ERROR on success
     *          #CHIP_END_OF_TLV if there is no such element
     */
    CHIP_ERROR GetSuppressResponse(bool * const apSuppressResponse) const;

    /**
     *  @brief Get a parser for a InvokeResponse.
     *
     *  @param [in] apInvokeResponses    A pointer to the invoke response list parser.
     *
     *  @return #CHIP_NO_ERROR on success
     *          #CHIP_END_OF_TLV if there is no such element
     */
    CHIP_ERROR GetInvokeResponses(InvokeResponseIBs::Parser * const apInvokeResponses) const;

    /**
     *  @brief Get MoreChunkedMessages boolean
     *
     *  @param [out] apMoreChunkedMessages    A pointer to bool for storing more chunked messages value.
     *
     *  @return #CHIP_NO_ERROR on success
     *          #CHIP_END_OF_TLV if there is no such element
     */
    CHIP_ERROR GetMoreChunkedMessages(bool * const apMoreChunkedMessages) const;
};

class Builder : public MessageBuilder
{
public:
    /**
     *  @brief Performs underlying StructBuilder::Init, but reserves memory need in
     *  EndOfInvokeResponseMessage() with underlying TLVWriter.
     */
    CHIP_ERROR InitWithEndBufferReserved(TLV::TLVWriter * const apWriter);

    /**
     *  @brief This is set to 'true' by the subscriber to indicate preservation of previous subscriptions. If omitted, it implies
     * 'false' as a value.
     */
    InvokeResponseMessage::Builder & SuppressResponse(const bool aSuppressResponse);

    /**
     *  @brief Initialize a InvokeResponseIBs::Builder for writing into the TLV stream
     *
     *  @return A reference to InvokeResponseIBs::Builder
     */
    InvokeResponseIBs::Builder & CreateInvokeResponses(const bool aReserveEndBuffer = false);

    /**
     *  @brief Get reference to InvokeResponseIBs::Builder
     *
     *  @return A reference to InvokeResponseIBs::Builder
     */
    InvokeResponseIBs::Builder & GetInvokeResponses() { return mInvokeResponses; }

    /**
     *  @brief Set True if the set of InvokeResponseIB have to be sent across multiple packets in a single transaction
     *  @param [in] aMoreChunkedMessages  true if more chunked messages are needed
     *  @return A reference to *this
     */
    InvokeResponseMessage::Builder & MoreChunkedMessages(const bool aMoreChunkedMessages);

    /**
     *  @brief Reserved space in TLVWriter for MoreChunkedMessages
     *  @return CHIP_NO_ERROR upon successfully reserving space for MoreChunkedMessages
     *  @return other CHIP error see TLVWriter::ReserveBuffer for more details.
     */
    CHIP_ERROR ReserveSpaceForMoreChunkedMessages();

    /**
     *  @brief Mark the end of this InvokeResponseMessage
     *
     *  @return The builder's final status.
     */
    CHIP_ERROR EndOfInvokeResponseMessage();

    /**
     *  @brief Get number of bytes required in the buffer by MoreChunkedMessages
     *
     *  @return Expected number of bytes required in the buffer by MoreChunkedMessages()
     */
    uint32_t GetSizeForMoreChunkResponses();

    /**
     *  @brief Get number of bytes required in the buffer by EndOfInvokeResponseMessage()
     *
     *  @return Expected number of bytes required in the buffer by EndOfInvokeResponseMessage()
     */
    uint32_t GetSizeToEndInvokeResponseMessage();

private:
    InvokeResponseIBs::Builder mInvokeResponses;
    bool mIsEndBufferReserved              = false;
    bool mIsMoreChunkMessageBufferReserved = false;
};
} // namespace InvokeResponseMessage
} // namespace app
} // namespace chip