blob: ddc971a1e7de86aab4c6d13df29f5540ae960d80 [file] [log] [blame]
* Copyright (c) 2020-2021 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
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
#pragma once
#include <app/CASEClientPool.h>
#include <app/OperationalSessionSetup.h>
#include <app/OperationalSessionSetupPool.h>
#include <lib/core/CHIPConfig.h>
#include <lib/core/CHIPCore.h>
#include <lib/support/Pool.h>
#include <platform/CHIPDeviceLayer.h>
#include <transport/SessionDelegate.h>
#include <transport/SessionUpdateDelegate.h>
#include <lib/dnssd/ResolverProxy.h>
namespace chip {
class OperationalSessionSetupPoolDelegate;
struct CASESessionManagerConfig
DeviceProxyInitParams sessionInitParams;
OperationalSessionSetupPoolDelegate * sessionSetupPool = nullptr;
* This class provides the following
* 1. Manage a pool of operational device proxy objects for peer nodes that have active message exchange with the local node.
* 2. The pool contains atmost one device proxy object for a given peer node.
* 3. API to lookup an existing proxy object, or allocate a new one by triggering session establishment with the peer node.
* 4. During session establishment, trigger node ID resolution (if needed), and update the DNS-SD cache (if resolution is
* successful)
class CASESessionManager : public OperationalSessionReleaseDelegate, public SessionUpdateDelegate
CASESessionManager() = default;
virtual ~CASESessionManager()
if (mConfig.sessionInitParams.Validate() == CHIP_NO_ERROR)
CHIP_ERROR Init(chip::System::Layer * systemLayer, const CASESessionManagerConfig & params);
void Shutdown() {}
* Find an existing session for the given node ID, or trigger a new session
* request.
* The caller can optionally provide `onConnection` and `onFailure` callback
* objects. If provided, these will be used to inform the caller about
* successful or failed connection establishment.
* If the connection is already established, the `onConnection` callback
* will be immediately called, before FindOrEstablishSession returns.
* The `onFailure` callback may be called before the FindOrEstablishSession
* call returns, for error cases that are detected synchronously.
void FindOrEstablishSession(const ScopedNodeId & peerId, Callback::Callback<OnDeviceConnected> * onConnection,
Callback::Callback<OnDeviceConnectionFailure> * onFailure);
void ReleaseSessionsForFabric(FabricIndex fabricIndex);
void ReleaseAllSessions();
* This API returns the address for the given node ID.
* If the CASESessionManager is configured with a DNS-SD cache, the cache is looked up
* for the node ID.
* If the DNS-SD cache is not available, the CASESessionManager looks up the list for
* an ongoing session with the peer node. If the session doesn't exist, the API will return
CHIP_ERROR GetPeerAddress(const ScopedNodeId & peerId, Transport::PeerAddress & addr);
//////////// OperationalSessionReleaseDelegate Implementation ///////////////
void ReleaseSession(OperationalSessionSetup * device) override;
//////////// SessionUpdateDelegate Implementation ///////////////
void UpdatePeerAddress(ScopedNodeId peerId) override;
OperationalSessionSetup * FindExistingSessionSetup(const ScopedNodeId & peerId, bool forAddressUpdate = false) const;
Optional<SessionHandle> FindExistingSession(const ScopedNodeId & peerId) const;
CASESessionManagerConfig mConfig;
} // namespace chip