Line data    Source code

       1              : /*
       2              :  *
       3              :  *    Copyright (c) 2024 Project CHIP Authors
       4              :  *    All rights reserved.
       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              : #pragma once
      20              : 
      21              : #include <app/ConcreteEventPath.h>
      22              : #include <lib/core/CHIPError.h>
      23              : 
      24              : namespace chip {
      25              : namespace app {
      26              : 
      27              : /**
      28              :  *   Interface that EventManagement can use to notify when events are generated and may need reporting.
      29              :  *
      30              :  */
      31              : class EventReporter
      32              : {
      33              : public:
      34           61 :     virtual ~EventReporter() = default;
      35              : 
      36              :     /**
      37              :      *  Notify that an event was generated.
      38              :      *
      39              :      * @param[in] aPath           The path that identifies the kind of event that was generated.
      40              :      * @param[in] aBytesConsumed  The number of bytes needed to store the event in EventManagement.
      41              :      */
      42              :     CHIP_ERROR virtual NewEventGenerated(ConcreteEventPath & aPath, uint32_t aBytesConsumed) = 0;
      43              : };
      44              : 
      45              : } // namespace app
      46              : } // namespace chip