Line data    Source code

       1              : /*
       2              :  *    Copyright (c) 2024 Project CHIP Authors
       3              :  *    All rights reserved.
       4              :  *
       5              :  *    Licensed under the Apache License, Version 2.0 (the "License");
       6              :  *    you may not use this file except in compliance with the License.
       7              :  *    You may obtain a copy of the License at
       8              :  *
       9              :  *        http://www.apache.org/licenses/LICENSE-2.0
      10              :  *
      11              :  *    Unless required by applicable law or agreed to in writing, software
      12              :  *    distributed under the License is distributed on an "AS IS" BASIS,
      13              :  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      14              :  *    See the License for the specific language governing permissions and
      15              :  *    limitations under the License.
      16              :  */
      17              : #pragma once
      18              : 
      19              : #include <messaging/ExchangeContext.h>
      20              : 
      21              : namespace chip {
      22              : namespace app {
      23              : namespace DataModel {
      24              : 
      25              : // Context for a currently executing action
      26              : class ActionContext
      27              : {
      28              : public:
      29           60 :     virtual ~ActionContext() = default;
      30              : 
      31              :     /// Valid ONLY during synchronous handling of an action.
      32              :     ///
      33              :     /// Used sparingly, however some operations will require these. An example
      34              :     /// usage is "Operational Credentials aborting communications on removed fabrics"
      35              :     ///
      36              :     /// Callers MUST check for null here (e.g. unit tests mocks may set this to
      37              :     /// nullptr due to object complexity)
      38              :     virtual Messaging::ExchangeContext * CurrentExchange() = 0;
      39              : };
      40              : 
      41              : } // namespace DataModel
      42              : } // namespace app
      43              : } // namespace chip