src/app/MessageDef/EventList.h

   1 /**
   2  *
   3  *    Copyright (c) 2020 Project CHIP Authors
   4  *    Copyright (c) 2016-2017 Nest Labs, Inc.
   5  *
   6  *    Licensed under the Apache License, Version 2.0 (the "License");
   7  *    you may not use this file except in compliance with the License.
   8  *    You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *    Unless required by applicable law or agreed to in writing, software
  13  *    distributed under the License is distributed on an "AS IS" BASIS,
  14  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *    See the License for the specific language governing permissions and
  16  *    limitations under the License.
  17  */
  18 /**
  19  *    @file
  20  *      This file defines EventList parser and builder in CHIP interaction model
  21  *
  22  */
  23
  24 #pragma once
  25
  26 #ifndef _CHIP_INTERACTION_MODEL_MESSAGE_DEF_EVENT_LIST_H
  27 #define _CHIP_INTERACTION_MODEL_MESSAGE_DEF_EVENT_LIST_H
  28
  29 #include "EventDataElement.h"
  30 #include "ListBuilder.h"
  31 #include "ListParser.h"
  32
  33 #include <core/CHIPCore.h>
  34 #include <core/CHIPTLV.h>
  35 #include <support/CodeUtils.h>
  36 #include <support/logging/CHIPLogging.h>
  37 #include <util/basic-types.h>
  38
  39 namespace chip {
  40 namespace app {
  41 namespace EventList {
  42 class Parser : public ListParser
  43 {
  44 public:
  45     /**
  46      *  @brief Roughly verify the message is correctly formed
  47      *   1) all mandatory tags are present
  48      *   2) all elements have expected data type
  49      *   3) any tag can only appear once
  50      *   4) At the top level of the structure, unknown tags are ignored for forward compatibility
  51      *  @note The main use of this function is to print out what we're
  52      *    receiving during protocol development and debugging.
  53      *    The encoding rule has changed in IM encoding spec so this
  54      *    check is only "roughly" conformant now.
  55      *
  56      *  @return #CHIP_NO_ERROR on success
  57      */
  58     CHIP_ERROR CheckSchemaValidity() const;
  59 };
  60
  61 class Builder : public ListBuilder
  62 {
  63 public:
  64     /**
  65      *  @brief Initialize a EventDataElement::Builder for writing into the TLV stream
  66      *
  67      *  @return A reference to EventDataElement::Builder
  68      */
  69     EventDataElement::Builder & CreateEventBuilder();
  70
  71     /**
  72      *  @brief Mark the end of this EventList
  73      *
  74      *  @return A reference to *this
  75      */
  76     EventList::Builder & EndOfEventList();
  77
  78 private:
  79     EventDataElement::Builder mEventDataElementBuilder;
  80 };
  81 }; // namespace EventList
  82
  83 }; // namespace app
  84 }; // namespace chip
  85
  86 #endif // _CHIP_INTERACTION_MODEL_MESSAGE_DEF_EVENT_LIST_H