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 RIALTO_SERVERMANAGER_COMMON_I_SESSION_SERVER_APP_H_
      21              : #define RIALTO_SERVERMANAGER_COMMON_I_SESSION_SERVER_APP_H_
      22              : 
      23              : #include "INamedSocket.h"
      24              : #include "SessionServerCommon.h"
      25              : #include <memory>
      26              : #include <string>
      27              : 
      28              : namespace rialto::servermanager::common
      29              : {
      30              : class ISessionServerApp
      31              : {
      32              : public:
      33           53 :     ISessionServerApp() = default;
      34           53 :     virtual ~ISessionServerApp() = default;
      35              : 
      36              :     ISessionServerApp(const ISessionServerApp &) = delete;
      37              :     ISessionServerApp &operator=(const ISessionServerApp &) = delete;
      38              :     ISessionServerApp(ISessionServerApp &&) = delete;
      39              :     ISessionServerApp &operator=(ISessionServerApp &&) = delete;
      40              : 
      41              :     virtual bool launch() = 0;
      42              :     virtual bool isPreloaded() const = 0;
      43              :     virtual bool configure(const std::string &appName, const firebolt::rialto::common::SessionServerState &initialState,
      44              :                            const firebolt::rialto::common::AppConfig &appConfig) = 0;
      45              :     virtual bool isConnected() const = 0;
      46              :     virtual std::string getSessionManagementSocketName() const = 0;
      47              :     virtual unsigned int getSessionManagementSocketPermissions() const = 0;
      48              :     virtual std::string getSessionManagementSocketOwner() const = 0;
      49              :     virtual std::string getSessionManagementSocketGroup() const = 0;
      50              :     virtual std::string getClientDisplayName() const = 0;
      51              :     virtual firebolt::rialto::common::SessionServerState getInitialState() const = 0;
      52              :     virtual int getServerId() const = 0;
      53              :     virtual const std::string &getAppName() const = 0;
      54              :     virtual int getAppManagementSocketName() const = 0;
      55              :     virtual int getMaxPlaybackSessions() const = 0;
      56              :     virtual int getMaxWebAudioPlayers() const = 0;
      57              :     virtual void cancelStartupTimer() = 0;
      58              :     virtual void kill() const = 0;
      59              :     virtual void setExpectedState(const firebolt::rialto::common::SessionServerState &state) = 0;
      60              :     virtual firebolt::rialto::common::SessionServerState getExpectedState() const = 0;
      61              :     virtual bool isNamedSocketInitialized() const = 0;
      62              :     virtual int getSessionManagementSocketFd() const = 0;
      63              :     virtual std::unique_ptr<firebolt::rialto::ipc::INamedSocket> &&releaseNamedSocket() = 0;
      64              : };
      65              : } // namespace rialto::servermanager::common
      66              : 
      67              : #endif // RIALTO_SERVERMANAGER_COMMON_I_SESSION_SERVER_APP_H_