RemoteViz/Rendering/Client.h

Go to the documentation of this file.

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2021 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/

#pragma once

#include <Inventor/sys/port.h>
#include <RemoteViz/Rendering/LibHelper.h>

#include <string>
#include <memory>
#include <vector>

namespace RemoteViz
{
  namespace Rendering
  {

    class ClientImpl;
    class Connection;
    class ClientSettings;
    struct ClientParameters;

    class RENDERSERVICE_API Client {

      friend class ServiceImpl;
      friend class ConnectionImpl;
    public:

      bool isConnected() const;
      const std::string& getId() const;
      std::shared_ptr<Connection> getConnection(const std::string& id) const;
      std::shared_ptr<Connection> getConnection(unsigned int index) const;
      unsigned int getNumConnections() const;
      const std::string& getApplicationName() const;
      const std::string& getEnvironment() const;
      bool isImageStreamingSupported() const;
      bool isVideoStreamingSupported() const;
      bool sendMessage(const std::string& message, std::vector<std::shared_ptr<Connection>> excludedConnections = {}) const;
      bool sendMessage(const std::vector<unsigned char>& buffer, std::vector<std::shared_ptr<Connection>> excludedConnections = {}) const;
      void disconnect();
      std::shared_ptr<ClientSettings> getSettings() const;

    private:
      std::shared_ptr<ClientImpl> getImpl() const;
    private:
      std::shared_ptr<ClientImpl> pImpl;

      Client(const std::string &id, const ClientParameters& clientParameters);

      Client(const Client&) = delete;
      Client& operator= (const Client&) = delete;

      static std::shared_ptr<Client> createInstance(const std::string &id, const ClientParameters& clientParameters);

    };

  }
}

---

Open Inventor Toolkit reference manual, generated on 15 Mar 2023
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/