src/app/server-cluster/ServerClusterContext.h

/*
 *    Copyright (c) 2025 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 <app/data-model-provider/Context.h>
#include <app/data-model-provider/Provider.h>
#include <app/persistence/AttributePersistenceProvider.h>
#include <lib/core/CHIPPersistentStorageDelegate.h>

namespace chip {
namespace app {

/// Represents a runtime context for server cluster interfaces to interact
/// with the outside world such as:
///   - notify of state changes to trigger attribute reports
///   - emit events
///   - potentially interact/review global metadata
///
/// Prefer using `attributeStorage` over calling the global GetAttributePersistenceProvider()
/// so that unit testing is easier and there is less coupling in code.
///
/// The context object is quite large in terms of exposed functionality and not all clusters use
/// all the information within, however a common context is used to minimize RAM overhead
/// for every cluster maintaining such a context.
struct ServerClusterContext
{
    DataModel::Provider & provider;                  /// underlying provider that the cluster operates in
    PersistentStorageDelegate & storage;             /// read/write persistent storage
    AttributePersistenceProvider & attributeStorage; /// read/write attribute data
    DataModel::InteractionModelContext & interactionContext;

    bool operator!=(const ServerClusterContext & other) const
    {
        return (&provider != &other.provider)                 //
            || (&storage != &other.storage)                   //
            || (&attributeStorage != &other.attributeStorage) //
            || (&interactionContext != &other.interactionContext);
    }
};

} // namespace app
} // namespace chip