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