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_CLIENT_I_CONTROL_IPC_H_
      21              : #define FIREBOLT_RIALTO_CLIENT_I_CONTROL_IPC_H_
      22              : 
      23              : #include "IControlClient.h"
      24              : #include <stdint.h>
      25              : 
      26              : #include <memory>
      27              : #include <string>
      28              : 
      29              : namespace firebolt::rialto::client
      30              : {
      31              : class IControlIpc;
      32              : 
      33              : /**
      34              :  * @brief IControlIpc factory class, returns a singlton of IControlIpc
      35              :  */
      36              : class IControlIpcFactory
      37              : {
      38              : public:
      39           20 :     IControlIpcFactory() = default;
      40           20 :     virtual ~IControlIpcFactory() = default;
      41              : 
      42              :     /**
      43              :      * @brief Create a IControlIpcFactory instance.
      44              :      *
      45              :      * @retval the factory instance or null on error.
      46              :      */
      47              :     static std::shared_ptr<IControlIpcFactory> createFactory();
      48              : 
      49              :     /**
      50              :      * @brief Gets the IControlIpc singleton object.
      51              :      *
      52              :      * @retval the rialto controller ipc instance or null on error.
      53              :      */
      54              :     virtual std::shared_ptr<IControlIpc> createControlIpc(IControlClient *controlClient) = 0;
      55              : };
      56              : 
      57              : /**
      58              :  * @brief The definition of the IControlIpc interface.
      59              :  *
      60              :  * This interface defines the rialto control ipc APIs that are used to communicate with the Rialto server.
      61              :  */
      62              : class IControlIpc
      63              : {
      64              : public:
      65           44 :     IControlIpc() = default;
      66           44 :     virtual ~IControlIpc() = default;
      67              : 
      68              :     IControlIpc(const IControlIpc &) = delete;
      69              :     IControlIpc &operator=(const IControlIpc &) = delete;
      70              :     IControlIpc(IControlIpc &&) = delete;
      71              :     IControlIpc &operator=(IControlIpc &&) = delete;
      72              : 
      73              :     /**
      74              :      * @brief Gets shared memory information to map.
      75              :      *
      76              :      * @param[in] fd    : The file descriptor of the shared memory region.
      77              :      * @param[in] size  : The size of the shared memory region.
      78              :      *
      79              :      * @retval true success, false otherwise.
      80              :      */
      81              :     virtual bool getSharedMemory(int32_t &fd, uint32_t &size) = 0;
      82              : 
      83              :     /**
      84              :      * @brief Register new client
      85              :      *
      86              :      * @retval true success, false otherwise.
      87              :      */
      88              :     virtual bool registerClient() = 0;
      89              : };
      90              : 
      91              : }; // namespace firebolt::rialto::client
      92              : 
      93              : #endif // FIREBOLT_RIALTO_CLIENT_I_CONTROL_IPC_H_