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