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_SERVER_IPC_I_CONTROL_MODULE_SERVICE_H_
      21              : #define FIREBOLT_RIALTO_SERVER_IPC_I_CONTROL_MODULE_SERVICE_H_
      22              : 
      23              : #include "IControlService.h"
      24              : #include "IPlaybackService.h"
      25              : #include "controlmodule.pb.h"
      26              : #include <IIpcServer.h>
      27              : #include <memory>
      28              : 
      29              : namespace firebolt::rialto::server::ipc
      30              : {
      31              : class IControlModuleService;
      32              : 
      33              : /**
      34              :  * @brief IControlModuleService factory class, returns a concrete implementation of IControlModuleService
      35              :  */
      36              : class IControlModuleServiceFactory
      37              : {
      38              : public:
      39           11 :     IControlModuleServiceFactory() = default;
      40           11 :     virtual ~IControlModuleServiceFactory() = default;
      41              : 
      42              :     /**
      43              :      * @brief Create a IControlModuleServiceFactory instance.
      44              :      *
      45              :      * @retval the factory instance or null on error.
      46              :      */
      47              :     static std::shared_ptr<IControlModuleServiceFactory> createFactory();
      48              : 
      49              :     /**
      50              :      * @brief Creates a ControlModuleService object.
      51              :      *
      52              :      * @retval the control ipc instance or null on error.
      53              :      */
      54              :     virtual std::shared_ptr<IControlModuleService> create(service::IPlaybackService &playbackService,
      55              :                                                           service::IControlService &controlService) const = 0;
      56              : };
      57              : 
      58              : /**
      59              :  * @brief The definition of the IControlModuleService interface.
      60              :  */
      61              : class IControlModuleService : public ::firebolt::rialto::ControlModule,
      62              :                               public std::enable_shared_from_this<IControlModuleService>
      63              : {
      64              : public:
      65           23 :     IControlModuleService() = default;
      66           23 :     virtual ~IControlModuleService() = default;
      67              : 
      68              :     IControlModuleService(const IControlModuleService &) = delete;
      69              :     IControlModuleService(IControlModuleService &&) = delete;
      70              :     IControlModuleService &operator=(const IControlModuleService &) = delete;
      71              :     IControlModuleService &operator=(IControlModuleService &&) = delete;
      72              : 
      73              :     /**
      74              :      * @brief Connect to the ipc client.
      75              :      *
      76              :      * @param[in] ipcClient : The ipc client to connect to.
      77              :      */
      78              :     virtual void clientConnected(const std::shared_ptr<::firebolt::rialto::ipc::IClient> &ipcClient) = 0;
      79              : 
      80              :     /**
      81              :      * @brief Disconnect from the ipc client.
      82              :      *
      83              :      * @param[in] ipcClient : The ipc client to disconnect to.
      84              :      */
      85              :     virtual void clientDisconnected(const std::shared_ptr<::firebolt::rialto::ipc::IClient> &ipcClient) = 0;
      86              : };
      87              : 
      88              : } // namespace firebolt::rialto::server::ipc
      89              : 
      90              : #endif // FIREBOLT_RIALTO_SERVER_IPC_I_CONTROL_MODULE_SERVICE_H_