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              : #include <lib/core/Optional.h>
      24              : 
      25              : namespace chip {
      26              : namespace app {
      27              : 
      28              : /**
      29              :  *   Interface that EventManagement can use to notify when events are generated and may need reporting.
      30              :  *
      31              :  */
      32              : class EventReporter
      33              : {
      34              : public:
      35           81 :     virtual ~EventReporter() = default;
      36              : 
      37              :     /**
      38              :      *  Notify that an event was generated.
      39              :      *
      40              :      * @param[in] aPath           The path that identifies the kind of event that was generated.
      41              :      * @param[in] aBytesConsumed  The number of bytes needed to store the event in EventManagement.
      42              :      */
      43              :     virtual CHIP_ERROR NewEventGenerated(ConcreteEventPath & aPath, uint32_t aBytesConsumed) = 0;
      44              : 
      45              :     /**
      46              :      * Schedule event delivery to happen immediately and run reporting to get
      47              :      * those reports into messages and on the wire.  This can be done either for
      48              :      * a specific fabric, identified by the provided FabricIndex, or across all
      49              :      * fabrics if no FabricIndex is provided.
      50              :      */
      51              :     virtual void ScheduleUrgentEventDeliverySync(Optional<FabricIndex> fabricIndex = NullOptional) = 0;
      52              : };
      53              : 
      54              : } // namespace app
      55              : } // namespace chip