blob: e81be842b1b5306f2bc38db802e9e8ae5f11e10e [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 <app/AppBuildConfig.h>
#include <app/util/basic-types.h>
#include <lib/core/CHIPCore.h>
#include <lib/core/CHIPTLV.h>
#include <lib/support/CodeUtils.h>
#include <lib/support/logging/CHIPLogging.h>
#include "ArrayBuilder.h"
#include "ArrayParser.h"
#include "CommandDataIB.h"
namespace chip {
namespace app {
namespace InvokeRequests {
class Parser : public ArrayParser
{
public:
#if CHIP_CONFIG_IM_ENABLE_SCHEMA_CHECK
/**
* @brief Roughly verify the message is correctly formed
* 1) all mandatory tags are present
* 2) all elements have expected data type
* 3) any tag can only appear once
* 4) At the top level of the structure, unknown tags are ignored for forward compatibility
* @note The main use of this function is to print out what we're
* receiving during protocol development and debugging.
* The encoding rule has changed in IM encoding spec so this
* check is only "roughly" conformant now.
*
* @return #CHIP_NO_ERROR on success
*/
CHIP_ERROR CheckSchemaValidity() const;
#endif
};
class Builder : public ArrayBuilder
{
public:
/**
* @brief Initialize a CommandDataIB::Builder for writing into the TLV stream
*
* @return A reference to CommandDataIB::Builder
*/
CommandDataIB::Builder & CreateCommandData();
/**
* @return A reference to CommandDataIB::Builder
*/
CommandDataIB::Builder & GetCommandData() { return mCommandData; };
/**
* @brief Mark the end of this InvokeRequests
*
* @return A reference to *this
*/
InvokeRequests::Builder & EndOfInvokeRequests();
private:
CommandDataIB::Builder mCommandData;
};
} // namespace InvokeRequests
} // namespace app
} // namespace chip