Line data    Source code

       1              : /*
       2              :  *   Copyright (c) 2023 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              :  */
      18              : 
      19              : #pragma once
      20              : 
      21              : #include <lib/core/CHIPError.h>
      22              : #include <lib/core/DataModelTypes.h>
      23              : #include <lib/core/NodeId.h>
      24              : #include <lib/support/Span.h>
      25              : 
      26              : namespace chip {
      27              : namespace bdx {
      28              : 
      29              : /**
      30              :  * A proxy object to control the state of a specific BDX transfer.
      31              :  */
      32              : 
      33              : class BDXTransferProxy
      34              : {
      35              : public:
      36            0 :     virtual ~BDXTransferProxy(){};
      37              : 
      38              :     virtual CHIP_ERROR Accept()                 = 0;
      39              :     virtual CHIP_ERROR Reject(CHIP_ERROR error) = 0;
      40              :     virtual CHIP_ERROR Continue()               = 0;
      41              : 
      42              :     virtual CharSpan GetFileDesignator() const = 0;
      43              :     virtual FabricIndex GetFabricIndex() const = 0;
      44              :     virtual NodeId GetPeerNodeId() const       = 0;
      45              : };
      46              : 
      47              : } // namespace bdx
      48              : } // namespace chip