ServiceSettings.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-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
 
#pragma once
 
#include <Inventor/sys/port.h>
#include <RemoteViz/Rendering/LibHelper.h>
#include <SoDeprecationRules.h>
 
#include <memory>
#include <string>
 
namespace RemoteViz
{
  namespace Rendering
  {
 
    class ServiceSettingsImpl;
    class Monitoring;
 
    class RENDERSERVICE_API ServiceSettings
    {
 
      friend class ServiceImpl;
    public:
      ServiceSettings();
 
      ServiceSettings(const ServiceSettings& obj);
 
      ServiceSettings& operator=(const ServiceSettings& obj);
 
      ~ServiceSettings();
 
 
      void setIP(const std::string& ip);
      const std::string& getIP() const;
 
 
      void setPort(unsigned short port);
      unsigned short getPort() const;
 
 
      enum RunMode
      {
        INVENTOR_SERVICE,
        INVENTOR_APPLICATION,
        INDEPENDENT_SERVICE
      };
      void setRunMode(ServiceSettings::RunMode runmode);
      ServiceSettings::RunMode getRunMode() const;
 
 
      std::string getHostname() const;
 
 
      enum Extensions 
      {
        VOLUMEVIZ = 0x1, // 2^0, bit 0
        VOLUMEVIZLDM = 0x2, // 2^1, bit 1
        MESHVIZ = 0x4, // 2^2, bit 2
        MESHVIZXLM = 0x8, // 2^3, bit 3SoDEPRECATED
        IMAGEVIZ = 0x10, // 2^4, bit 4
        HARDCOPY = 0x20, // 2^5, bit 5
        CATIA5READER = 0x40, // 2^6, bit 6
        CATIA6READER = 0x80, // 2^7, bit 7
        DWGREADER = 0x100, // 2^8, bit 8
        IGESREADER = 0x200, // 2^9, bit 9
        JTREADER = 0x400, // 2^10, bit 10
        PROEREADER = 0x800, // 2^11, bit 11
        SOLIDEDGEREADER = 0x1000, // 2^12, bit 12
        STEPREADER = 0x2000, // 2^13, bit 13
        SOLIDWORKSREADER = 0x4000, // 2^14, bit 14
        UGREADER = 0x8000, // 2^15, bit 15
        VDAREADER = 0x10000, // 2^16, bit 16
        XMTREADER = 0x20000 // 2^17, bit 17
      };
      void setUsedExtensions(unsigned int extensions);
      unsigned int getUsedExtensions() const;
 
 
      std::shared_ptr<Monitoring> getMonitoring() const;
 
 
      void enableSecureConnection(const std::string& publicCertificateFilePath, const std::string& privateKeyFilePath, unsigned int enabledSecurityProtocols = TLSv1_1 | TLSv1_2 | TLSv1_3);
      bool isSecureConnection() const;
 
      const std::string& getPublicCertificateFile() const;
 
      const std::string& getPrivateKeyFile() const;
 
 
      enum SecurityProtocols 
      {
        SSLv2 = 0x1, // 2^0, bit 0
        SSLv3 = 0x2, // 2^1, bit 1
        TLSv1 = 0x4, // 2^2, bit 2
        TLSv1_1 = 0x8, // 2^3, bit 3
        TLSv1_2 = 0x10, // 2^4, bit 4
        TLSv1_3 = 0x20 // 2^5, bit 5
      };
      unsigned int getEnabledSecurityProtocols() const;
 
    private:
      std::shared_ptr<ServiceSettingsImpl> getImpl() const;
    private:
      std::shared_ptr<ServiceSettingsImpl> pImpl;
 
    };
 
  }
}