Line data    Source code

       1              : /*
       2              :  *
       3              :  *    Copyright (c) 2020 Project CHIP Authors
       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              :  * @file
      20              :  *   This file defines the API for application specific callbacks.
      21              :  */
      22              : 
      23              : #pragma once
      24              : 
      25              : #include <lib/core/CHIPError.h>
      26              : 
      27              : class AppDelegate
      28              : {
      29              : public:
      30            2 :     virtual ~AppDelegate() {}
      31              :     /**
      32              :      * This is called when the PBKDFParamRequest is received and indicates the start of the session establishment process
      33              :      */
      34            1 :     virtual void OnCommissioningSessionEstablishmentStarted() {}
      35              : 
      36              :     /**
      37              :      * This is called when the commissioning session has been established
      38              :      */
      39            0 :     virtual void OnCommissioningSessionStarted() {}
      40              : 
      41              :     /**
      42              :      * This is called when the PASE establishment failed (such as, when an invalid passcode is provided) or PASE was established
      43              :      * fine but then the fail-safe expired (including being expired by the commissioner)
      44              :      *
      45              :      * @param err CHIP_ERROR indicating the error that occurred during session establishment or the error accompanying the fail-safe
      46              :      * timeout.
      47              :      */
      48            0 :     virtual void OnCommissioningSessionEstablishmentError(CHIP_ERROR err) {}
      49              : 
      50              :     /**
      51              :      * This is called when the PASE establishment failed or PASE was established fine but then the fail-safe expired (including
      52              :      * being expired by the commissioner) AND the commissioning window is closed. The window may be closed because the commissioning
      53              :      * attempts limit was reached or advertising/listening for PASE failed.
      54              :      */
      55            0 :     virtual void OnCommissioningSessionStopped() {}
      56              : 
      57              :     /*
      58              :      * This is called any time a basic or enhanced commissioning window is opened.
      59              :      *
      60              :      * The type of the window can be retrieved by calling
      61              :      * CommissioningWindowManager::CommissioningWindowStatusForCluster(), but
      62              :      * being careful about how to handle the None status when a window is in
      63              :      * fact open.
      64              :      */
      65            0 :     virtual void OnCommissioningWindowOpened() {}
      66              : 
      67              :     /*
      68              :      * This is called any time a basic or enhanced commissioning window is closed.
      69              :      */
      70            0 :     virtual void OnCommissioningWindowClosed() {}
      71              : };