blob: 35358fc2d2d8f55c8de762a83a979e5b34768656 [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 "AttributePathIB.h"
#include "StatusIB.h"
#include "StructBuilder.h"
#include "StructParser.h"
#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>
namespace chip {
namespace app {
namespace AttributeStatusIB {
enum class Tag : uint8_t
{
kPath = 0,
kErrorStatus = 1,
};
class Parser : public StructParser
{
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
/**
* @brief Get a TLVReader for the AttributePathIB. Next() must be called before accessing them.
*
* @param [in] apPath A pointer to apPath
*
* @return #CHIP_NO_ERROR on success
* #CHIP_ERROR_WRONG_TLV_TYPE if there is such element but it's not a Path
* #CHIP_END_OF_TLV if there is no such element
*/
CHIP_ERROR GetPath(AttributePathIB::Parser * const apPath) const;
/**
* @brief Get a TLVReader for the StatusIB. Next() must be called before accessing them.
*
* @param [in] apErrorStatus A pointer to apErrorStatus
*
* @return #CHIP_NO_ERROR on success
* # CHIP_ERROR_WRONG_TLV_TYPE if there is such element but it's not a structure
* #CHIP_END_OF_TLV if there is no such element
*/
CHIP_ERROR GetErrorStatus(StatusIB::Parser * const apErrorStatus) const;
};
class Builder : public StructBuilder
{
public:
/**
* @brief Initialize a AttributePathIB::Builder for writing into the TLV stream
*
* @return A reference to AttributePathIB::Builder
*/
AttributePathIB::Builder & CreatePath();
/**
* @brief Initialize a StatusIB::Builder for writing into the TLV stream
*
* @return A reference to StatusIB::Builder
*/
StatusIB::Builder & CreateErrorStatus();
/**
* @brief Mark the end of this AttributeStatusIB
*
* @return A reference to *this
*/
AttributeStatusIB::Builder & EndOfAttributeStatusIB();
private:
AttributePathIB::Builder mPath;
StatusIB::Builder mErrorStatus;
};
} // namespace AttributeStatusIB
} // namespace app
} // namespace chip