blob: 71c9c5e7710877035109f34277df1902d36ddf9f [file] [log] [blame]
/*
* Copyright (c) 2024 Project CHIP Authors
* All rights reserved.
*
* 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 <messaging/ExchangeContext.h>
namespace chip {
namespace app {
namespace DataModel {
// Context for a currently executing action
class ActionContext
{
public:
virtual ~ActionContext() = default;
/// Valid ONLY during synchronous handling of an action.
///
/// Used sparingly, however some operations will require these. An example
/// usage is "Operational Credentials aborting communications on removed fabrics"
///
/// Callers MUST check for null here (e.g. unit tests mocks may set this to
/// nullptr due to object complexity)
virtual Messaging::ExchangeContext * CurrentExchange() = 0;
};
} // namespace DataModel
} // namespace app
} // namespace chip