EMA C++ Edition
List of all members
refinitiv::ema::access::ServiceEndpointDiscoveryConfig Class Reference

Public Member Functions

Constructor
 ServiceEndpointDiscoveryConfig ()
  More...
 

Operations

class ServiceEndpointDiscoveryImpl
 
void clear ()
  More...
 
ServiceEndpointDiscoveryConfigtokenServiceUrlV1 (const EmaString &tokenServiceUrl="")
  More...
 
ServiceEndpointDiscoveryConfigtokenServiceUrlV2 (const EmaString &tokenServiceUrl="")
  More...
 
ServiceEndpointDiscoveryConfigserviceDiscoveryUrl (const EmaString &serviceDiscoveryUrl="")
  More...
 
ServiceEndpointDiscoveryConfigrestLogOutputStream (FILE *restLogOutputStream=NULL)
  More...
 
ServiceEndpointDiscoveryConfigrestEnableLog (bool restEnableLog=false)
  More...
 
ServiceEndpointDiscoveryConfigrestVerboseMode (bool restVerboseMode=false)
  More...
 
ServiceEndpointDiscoveryConfiglibSslName (const EmaString &libsslName="")
  More...
 
ServiceEndpointDiscoveryConfiglibCryptoName (const EmaString &libcryptoName="")
  More...
 
ServiceEndpointDiscoveryConfiglibCurlName (const EmaString &libcurlName="")
  More...
 
ServiceEndpointDiscoveryConfigshouldInitializeCPUIDlib (bool shouldInitializeCPUIDlib=true)
  More...
 

Detailed Description

Definition at line 21 of file ServiceEndpointDiscoveryConfig.h.

Constructor & Destructor Documentation

◆ ServiceEndpointDiscoveryConfig()

refinitiv::ema::access::ServiceEndpointDiscoveryConfig::ServiceEndpointDiscoveryConfig ( )

Create an ServiceEndpointDiscoveryConfig that enables customization of default configurations.

Member Function Documentation

◆ clear()

void refinitiv::ema::access::ServiceEndpointDiscoveryConfig::clear ( )

Clears the ServiceEndpointDiscoveryConfig and sets all the defaults.

Remarks
Invoking clear() method clears all the values and resets all the defaults
Returns
reference to this object

◆ libCryptoName()

ServiceEndpointDiscoveryConfig& refinitiv::ema::access::ServiceEndpointDiscoveryConfig::libCryptoName ( const EmaString libcryptoName = "")

Specifies a name to override the default for the openSSL libcrypto shared library. The RSSL API will attempt to dynamically load this library for encrypted connections.

Parameters
[in]libcryptoNamespecifies a name of the openSSL libcrypto shared library.
Returns
reference to this object

◆ libCurlName()

ServiceEndpointDiscoveryConfig& refinitiv::ema::access::ServiceEndpointDiscoveryConfig::libCurlName ( const EmaString libcurlName = "")

Specifies a name to override the default for the curl shared library. The RSSL API will attempt to dynamically load this library for proxy connections.

Parameters
[in]libcurlNamespecifies a name of the curl shared library.
Returns
reference to this object

◆ libSslName()

ServiceEndpointDiscoveryConfig& refinitiv::ema::access::ServiceEndpointDiscoveryConfig::libSslName ( const EmaString libsslName = "")

Specifies a name to override the default for the openSSL libssl shared library. The RSSL API will attempt to dynamically load this library for encrypted connections.

Parameters
[in]libsslNamespecifies a name of the openSSL libssl shared library.
Returns
reference to this object

◆ restEnableLog()

ServiceEndpointDiscoveryConfig& refinitiv::ema::access::ServiceEndpointDiscoveryConfig::restEnableLog ( bool  restEnableLog = false)

Specifies whether to enable or disable REST logging. If set to true, REST logging is enabled. Defaults to false.

Parameters
[in]restEnableLogif true, enables REST logging.
Returns
reference to this object

◆ restLogOutputStream()

ServiceEndpointDiscoveryConfig& refinitiv::ema::access::ServiceEndpointDiscoveryConfig::restLogOutputStream ( FILE *  restLogOutputStream = NULL)

Specifies file output location for REST Logs. If NULL, sends logs to stdout.

Parameters
[in]restLogOutputStreamspecifies the file output location for REST Logs. Defaults to NULL.
Returns
reference to this object

◆ restVerboseMode()

ServiceEndpointDiscoveryConfig& refinitiv::ema::access::ServiceEndpointDiscoveryConfig::restVerboseMode ( bool  restVerboseMode = false)

Specifies whether to enable or disable verbose REST logging. If set to true, verbose REST logging is enabled. Defaults to false.

Parameters
[in]restVerboseModeif true, enables verbose REST logging.
Returns
reference to this object

◆ serviceDiscoveryUrl()

ServiceEndpointDiscoveryConfig& refinitiv::ema::access::ServiceEndpointDiscoveryConfig::serviceDiscoveryUrl ( const EmaString serviceDiscoveryUrl = "")

Specifies an URL to override the default for the RDP service discovery to get global endpoints

Parameters
[in]serviceDiscoveryUrlspecifies an URL for RDP service discovery.
Returns
reference to this object

◆ shouldInitializeCPUIDlib()

ServiceEndpointDiscoveryConfig& refinitiv::ema::access::ServiceEndpointDiscoveryConfig::shouldInitializeCPUIDlib ( bool  shouldInitializeCPUIDlib = true)

Specifies whether to enable or disable CPUID library initialization. If set to true, CPUID library is enabled. Defaults to true.

Parameters
[in]shouldInitializeCPUIDlibif true, enables CPUID library.
Returns
reference to this object

◆ tokenServiceUrlV1()

ServiceEndpointDiscoveryConfig& refinitiv::ema::access::ServiceEndpointDiscoveryConfig::tokenServiceUrlV1 ( const EmaString tokenServiceUrl = "")

Specifies an URL to override the default for token service V1 Password Credentials to perform authentication to get access and refresh tokens.

Parameters
[in]tokenServiceUrlspecifies an URL for token service.
Returns
reference to this object

◆ tokenServiceUrlV2()

ServiceEndpointDiscoveryConfig& refinitiv::ema::access::ServiceEndpointDiscoveryConfig::tokenServiceUrlV2 ( const EmaString tokenServiceUrl = "")

Specifies an URL to override the default for token service V2 Client Credentials to perform authentication to get access and refresh tokens.

Parameters
[in]tokenServiceUrlspecifies an URL for token service.
Returns
reference to this object