Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
ServiceSettings.h
Go to the documentation of this file.
1/*=======================================================================
2 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
3 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
4 *** ***
5 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
6 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
7 *** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
8 *** ***
9 *** RESTRICTED RIGHTS LEGEND ***
10 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
11 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
12 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
13 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
14 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
15 *** ***
16 *** COPYRIGHT (C) 1996-2023 BY FEI S.A.S, ***
17 *** BORDEAUX, FRANCE ***
18 *** ALL RIGHTS RESERVED ***
19**=======================================================================*/
20
21#pragma once
22
23#include <Inventor/sys/port.h>
25#include <SoDeprecationRules.h>
26
27#include <memory>
28#include <string>
29
30namespace RemoteViz
31{
32 namespace Rendering
33 {
34
35 class ServiceSettingsImpl;
36 class Monitoring;
37
51 {
52
54 friend class ServiceImpl;
57 public:
62
67
72
77
79
87 void setIP(const std::string& ip);
93 const std::string& getIP() const;
95
97
104 void setPort(unsigned short port);
110 unsigned short getPort() const;
112
114
124 {
127 INDEPENDENT_SERVICE
128 };
142
144
149 std::string getHostname() const;
151
153
157 {
158 VOLUMEVIZ = 0x1, // 2^0, bit 0
159 VOLUMEVIZLDM = 0x2, // 2^1, bit 1
160 MESHVIZ = 0x4, // 2^2, bit 2
161 MESHVIZXLM = 0x8, // 2^3, bit 3SoDEPRECATED
163 IMAGEVIZ = 0x10, // 2^4, bit 4
164 HARDCOPY = 0x20, // 2^5, bit 5
165 CATIA5READER = 0x40, // 2^6, bit 6
166 CATIA6READER = 0x80, // 2^7, bit 7
167 DWGREADER = 0x100, // 2^8, bit 8
168 IGESREADER = 0x200, // 2^9, bit 9
169 JTREADER = 0x400, // 2^10, bit 10
170 PROEREADER = 0x800, // 2^11, bit 11
171 SOLIDEDGEREADER = 0x1000, // 2^12, bit 12
172 STEPREADER = 0x2000, // 2^13, bit 13
173 SOLIDWORKSREADER = 0x4000, // 2^14, bit 14
174 UGREADER = 0x8000, // 2^15, bit 15
175 VDAREADER = 0x10000, // 2^16, bit 16
176 XMTREADER = 0x20000 // 2^17, bit 17
177 };
220 void setUsedExtensions(unsigned int extensions);
228 unsigned int getUsedExtensions() const;
230
232
238 std::shared_ptr<Monitoring> getMonitoring() const;
240
242
262 void enableSecureConnection(const std::string& publicCertificateFilePath, const std::string& privateKeyFilePath, unsigned int enabledSecurityProtocols = TLSv1_1 | TLSv1_2 | TLSv1_3);
268 bool isSecureConnection() const;
270
276 const std::string& getPublicCertificateFile() const;
277
283 const std::string& getPrivateKeyFile() const;
284
286
290 {
291 SSLv2 = 0x1, // 2^0, bit 0
292 SSLv3 = 0x2, // 2^1, bit 1
293 TLSv1 = 0x4, // 2^2, bit 2
294 TLSv1_1 = 0x8, // 2^3, bit 3
295 TLSv1_2 = 0x10, // 2^4, bit 4
296 TLSv1_3 = 0x20 // 2^5, bit 5
297 };
304 unsigned int getEnabledSecurityProtocols() const;
306
307 private:
309 std::shared_ptr<ServiceSettingsImpl> getImpl() const;
312 private:
314 std::shared_ptr<ServiceSettingsImpl> pImpl;
315
316 };
317
318 }
319}
<a href="IconLegend.html"><img src="extRV.gif" alt="RemoteViz" border="0"></a>
RunMode
The run mode is used to change the behaviour of the RemoteViz execution in three environments.
void setRunMode(ServiceSettings::RunMode runmode)
Sets the run mode of the service.
unsigned short getPort() const
Gets the port of the service.
void setIP(const std::string &ip)
Sets the IP address.
const std::string & getPublicCertificateFile() const
Gets the public certificate authenticating the server to the clients.
std::shared_ptr< Monitoring > getMonitoring() const
Gets the monitoring object which allows to manage metrics listeners that monitor states and performan...
const std::string & getIP() const
Gets the IP address.
ServiceSettings::RunMode getRunMode() const
Gets the run mode of the service.
void setPort(unsigned short port)
Sets the port of the service.
ServiceSettings & operator=(const ServiceSettings &obj)
Copy assignment operator.
std::string getHostname() const
Gets the current host name.
unsigned int getEnabledSecurityProtocols() const
Gets the security procotols used in RemoteViz.
ServiceSettings(const ServiceSettings &obj)
Copy constructor.
Extensions
Each enumeration represents an Open Inventor extension.
unsigned int getUsedExtensions() const
Gets the used Open Inventor extensions.
bool isSecureConnection() const
Gets the SSL engine activation.
void enableSecureConnection(const std::string &publicCertificateFilePath, const std::string &privateKeyFilePath, unsigned int enabledSecurityProtocols=TLSv1_1|TLSv1_2|TLSv1_3)
Secures the connection between the server and the clients.
void setUsedExtensions(unsigned int extensions)
Sets the Open Inventor extensions used by a RemoteViz application.
SecurityProtocols
Each enumeration represents a security protocol.
const std::string & getPrivateKeyFile() const
Gets the private key used to sign the server key exchange between the client and the server.
#define RENDERSERVICE_API
Definition port.h:378