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 2022 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_H_
      21              : #define FIREBOLT_RIALTO_I_CONTROL_H_
      22              : 
      23              : /**
      24              :  * @file IControl.h
      25              :  *
      26              :  * The definition of the IControl interface.
      27              :  *
      28              :  * This interface defines the public API of Rialto for control of Rialto,
      29              :  * including the IPC connection and shared memory.
      30              :  */
      31              : 
      32              : #include <memory>
      33              : #include <stdint.h>
      34              : 
      35              : #include "ControlCommon.h"
      36              : #include "IControlClient.h"
      37              : 
      38              : namespace firebolt::rialto
      39              : {
      40              : class IControl;
      41              : 
      42              : /**
      43              :  * @brief IControl factory class, returns a concrete implementation of IControl
      44              :  */
      45              : class IControlFactory
      46              : {
      47              : public:
      48           11 :     IControlFactory() = default;
      49           11 :     virtual ~IControlFactory() = default;
      50              : 
      51              :     /**
      52              :      * @brief Creates a IControlFactory instance.
      53              :      *
      54              :      * @retval the factory instance or null on error.
      55              :      */
      56              :     static std::shared_ptr<IControlFactory> createFactory();
      57              : 
      58              :     /**
      59              :      * @brief IControl factory method, returns a concrete implementation of IControl
      60              :      *
      61              :      * @retval the new IControl instance or null on error.
      62              :      */
      63              :     virtual std::shared_ptr<IControl> createControl() const = 0;
      64              : };
      65              : 
      66              : /**
      67              :  * @brief The definition of the IControl interface.
      68              :  *
      69              :  * This interface defines the public API for control of the ipc and shared memory.
      70              :  *
      71              :  */
      72              : class IControl
      73              : {
      74              : public:
      75           21 :     IControl() = default;
      76           21 :     virtual ~IControl() = default;
      77              : 
      78              :     IControl(const IControl &) = delete;
      79              :     IControl &operator=(const IControl &) = delete;
      80              :     IControl(IControl &&) = delete;
      81              :     IControl &operator=(IControl &&) = delete;
      82              : 
      83              :     /**
      84              :      * @brief Register new IControlClient. This method will hold a shared_ptr
      85              :      *        to the client until the destruction of the IControl object.
      86              :      *        At destruction the client will be unregistered and the
      87              :      *        shared_ptr will be released.
      88              :      *
      89              :      * @param[in]  client   : Client object for callbacks
      90              :      * @param[out] appState : Current application state
      91              :      *
      92              :      * @retval true on success, false otherwise.
      93              :      */
      94              :     virtual bool registerClient(std::weak_ptr<IControlClient> client, ApplicationState &appState) = 0;
      95              : };
      96              : 
      97              : }; // namespace firebolt::rialto
      98              : 
      99              : #endif // FIREBOLT_RIALTO_I_CONTROL_H_