Line data    Source code

       1              : /*
       2              :  * If not stated otherwise in this file or this component's LICENSE file the
       3              :  * following copyright and licenses apply:
       4              :  *
       5              :  * Copyright 2023 Sky UK
       6              :  *
       7              :  * Licensed under the Apache License, Version 2.0 (the "License");
       8              :  * you may not use this file except in compliance with the License.
       9              :  * You may obtain a copy of the License at
      10              :  *
      11              :  * http://www.apache.org/licenses/LICENSE-2.0
      12              :  *
      13              :  * Unless required by applicable law or agreed to in writing, software
      14              :  * distributed under the License is distributed on an "AS IS" BASIS,
      15              :  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      16              :  * See the License for the specific language governing permissions and
      17              :  * limitations under the License.
      18              :  */
      19              : 
      20              : #ifndef FIREBOLT_RIALTO_I_CONTROL_CLIENT_H_
      21              : #define FIREBOLT_RIALTO_I_CONTROL_CLIENT_H_
      22              : 
      23              : /**
      24              :  * @file IControlClient.h
      25              :  *
      26              :  * The definition of the IControlClient interface.
      27              :  *
      28              :  * This file comprises the definition of the IControlClient abstract
      29              :  * class. This is the API by which a IControl implementation will
      30              :  * pass notifications to its client.
      31              :  */
      32              : 
      33              : #include "ControlCommon.h"
      34              : 
      35              : namespace firebolt::rialto
      36              : {
      37              : /**
      38              :  * @brief The Rialto control client interface.
      39              :  *
      40              :  * This is The Rialto control client abstract base class. It should be
      41              :  * implemented by any object that wishes to be notified by changes in the
      42              :  * state of the rialto server.
      43              :  */
      44              : class IControlClient
      45              : {
      46              : public:
      47              :     /**
      48              :      * @brief Virtual destructor
      49              :      */
      50          248 :     virtual ~IControlClient() = default;
      51              : 
      52              :     /**
      53              :      * @brief Notifies the client that rialto server reached new application state
      54              :      *
      55              :      * @param[in] state: The new application state.
      56              :      */
      57              :     virtual void notifyApplicationState(ApplicationState state) = 0;
      58              : };
      59              : } // namespace firebolt::rialto
      60              : 
      61              : #endif // FIREBOLT_RIALTO_I_CONTROL_CLIENT_H_