Line data    Source code

       1             : /*
       2             :  *    Copyright (c) 2022 Project CHIP Authors
       3             :  *
       4             :  *    Licensed under the Apache License, Version 2.0 (the "License");
       5             :  *    you may not use this file except in compliance with the License.
       6             :  *    You may obtain a copy of the License at
       7             :  *
       8             :  *        http://www.apache.org/licenses/LICENSE-2.0
       9             :  *
      10             :  *    Unless required by applicable law or agreed to in writing, software
      11             :  *    distributed under the License is distributed on an "AS IS" BASIS,
      12             :  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      13             :  *    See the License for the specific language governing permissions and
      14             :  *    limitations under the License.
      15             :  */
      16             : 
      17             : #pragma once
      18             : 
      19             : #include <lib/core/DataModelTypes.h>
      20             : #include <lib/core/NodeId.h>
      21             : 
      22             : namespace chip {
      23             : 
      24             : /// The ScopedNodeId provides an identifier for an operational node on the network that is only valid for use within the current
      25             : /// Matter stack instance. It is not to be exchanged or directly used remotely over the network.
      26             : class ScopedNodeId
      27             : {
      28             : public:
      29         185 :     ScopedNodeId() : mNodeId(kUndefinedNodeId), mFabricIndex(kUndefinedFabricIndex) {}
      30       21940 :     ScopedNodeId(NodeId nodeId, FabricIndex fabricIndex) : mNodeId(nodeId), mFabricIndex(fabricIndex) {}
      31             : 
      32       28904 :     NodeId GetNodeId() const { return mNodeId; }
      33         216 :     FabricIndex GetFabricIndex() const { return mFabricIndex; }
      34             : 
      35             :     bool IsOperational() const { return mFabricIndex != kUndefinedFabricIndex && IsOperationalNodeId(mNodeId); }
      36         620 :     bool operator==(const ScopedNodeId & that) const { return (mNodeId == that.mNodeId) && (mFabricIndex == that.mFabricIndex); }
      37         342 :     bool operator!=(const ScopedNodeId & that) const { return !(*this == that); }
      38             : 
      39             : private:
      40             :     NodeId mNodeId;
      41             :     FabricIndex mFabricIndex;
      42             : };
      43             : 
      44             : } // namespace chip