OpenFin C++ Adapter 1.1.0

Loading...
Searching...
No Matches
OpenFinAdapterApi::RuntimeOptions Class Reference

The options required for initialising the runtime. More...

#include <OpenFinAdapter.h>

Public Types

enum  PortDiscoveryMode { None , WindowClass }
 Enum of the port discovery mode to use. More...
 
enum class  RuntimeConnectOptions : uint16_t { None = 0x0000 , NonPersistent = 0x0001 }
 Advanced settings to configure how the adapter manages and connects to a runtime instance. More...
 

Public Member Functions

 RuntimeOptions (const string &uuid, const string &licenseKey, const string &version, const string &host, int32_t port, PortDiscoveryMode portDiscoveryMode, const string &arguments, const RvmOptions &rvmOptions, const string &securityRealm, const RuntimeConnectOptions runtimeConnectOptions=RuntimeConnectOptions::None)
 Constructs a new instance of the RuntimeOptions.
 
 RuntimeOptions (const string &uuid, const string &licenseKey, const string &version)
 Constructs a new instance of the RuntimeOptions.
 

Public Attributes

string uuid
 Connection UUID.
 
string license_key
 The per-customer or per-contract licensing identifier for the RVM.
 
string version
 Requested Runtime Version to connect to.
 
string host
 Requested Runtime defaults to 127.0.0.1.
 
int32_t port
 Requested Runtime port number; only used when PortDiscovery is disabled.
 
PortDiscoveryMode portDiscoveryMode
 Determines Port discovery methods to be used. Defaults to all available.
 
string arguments
 Arguments to be passed to the Runtime.
 
RvmOptionsrvmOptions
 The RVM Options to be used.
 
string securityRealm
 Security Realm.
 
RuntimeConnectOptions runtimeConnectOptions
 Advanced settings to configure how the adapter manages and connects to a runtime instance.
 

Detailed Description

The options required for initialising the runtime.

Member Enumeration Documentation

◆ PortDiscoveryMode

Enum of the port discovery mode to use.

Enumerator
None 

No port discovery. The provided port will be used.

WindowClass 

Port discovery enabled using the Window class method.

◆ RuntimeConnectOptions

Advanced settings to configure how the adapter manages and connects to a runtime instance.

Enumerator
None 

No advanced options.

NonPersistent 

Automatically disconnects when the last application closes.

Constructor & Destructor Documentation

◆ RuntimeOptions() [1/2]

OpenFinAdapterApi::RuntimeOptions::RuntimeOptions ( const string & uuid,
const string & licenseKey,
const string & version,
const string & host,
int32_t port,
PortDiscoveryMode portDiscoveryMode,
const string & arguments,
const RvmOptions & rvmOptions,
const string & securityRealm,
const RuntimeConnectOptions runtimeConnectOptions = RuntimeConnectOptions::None )

Constructs a new instance of the RuntimeOptions.

Parameters
uuidConnection UUID
licenseKeyThe per-customer or per-contract licensing identifier for the RVM
versionRequested Runtime Version to connect to
hostRequested Runtime defaults to 127.0.0.1
portRequested Runtime port number; only used when PortDiscovery is disabled.
portDiscoveryModeDetermines Port discovery methods to be used. Defaults to all available.
argumentsArguments to be passed to the Runtime
rvmOptionsThe RVM Options to be used.
securityRealmSecurity Realm
runtimeConnectOptionsAdvanced settings to configure how the adapter manages and connects to a runtime instance.

◆ RuntimeOptions() [2/2]

OpenFinAdapterApi::RuntimeOptions::RuntimeOptions ( const string & uuid,
const string & licenseKey,
const string & version )

Constructs a new instance of the RuntimeOptions.

Parameters
uuidConnection UUID
licenseKeyThe per-customer or per-contract licensing identifier for the RVM
versionRequested Runtime Version to connect to

The documentation for this class was generated from the following file: