#include <blpapi_tlsoptions.h>

Public Member Functions
	TlsOptions ()

	TlsOptions (const TlsOptions &)

	~TlsOptions ()

TlsOptions &	operator= (const TlsOptions &rhs)

void	setTlsHandshakeTimeoutMs (int tlsHandshakeTimeoutMs)

void	setCrlFetchTimeoutMs (int crlFetchTimeoutMs)

blpapi_TlsOptions_t *	handle () const

Static Public Member Functions
static TlsOptions	createFromFiles (const char clientCredentialsFileName, const char clientCredentialsPassword, const char *trustedCertificatesFileName)

static TlsOptions	createFromBlobs (const char clientCredentialsRawData, int clientCredentialsRawDataLength, const char clientCredentialsPassword, const char *trustedCertificatesRawData, int trustedCertificatesRawDataLength)

Detailed Description

Contains the user specified TLS options.

To enable SSL connections, create a TlsOptions object using the methods TlsOptions::createFromBlobs and TlsOptions::createFromFiles.

See Component blpapi_tlsoptions

Constructor & Destructor Documentation

◆ TlsOptions() [1/2]

TlsOptions ( )

Create a TlsOptions with all TLS options with no certificate information.

◆ TlsOptions() [2/2]

TlsOptions ( const TlsOptions & options )

Copy constructor

◆ ~TlsOptions()

~TlsOptions ( )

Destroy this TlsOptions.

Member Function Documentation

◆ createFromBlobs()

TlsOptions createFromBlobs	(	const char *	clientCredentialsRawData,
		int	clientCredentialsRawDataLength,
		const char *	clientCredentialsPassword,
		const char *	trustedCertificatesRawData,
		int	trustedCertificatesRawDataLength
	)

static

Create a TlsOptions using DER encoded client credentials in PKCS#12 format and DER encoded trust material in PKCS#7 format from the specified raw data.

◆ createFromFiles()

TlsOptions createFromFiles	(	const char *	clientCredentialsFileName,
		const char *	clientCredentialsPassword,
		const char *	trustedCertificatesFileName
	)

static

Creates a TlsOptions using a DER encoded client credentials in PKCS#12 format and DER encoded trust material in PKCS#7 format from the specified files.

◆ handle()

blpapi_TlsOptions_t * handle ( ) const

Return the handle of the current TLS options.

◆ operator=()

TlsOptions & operator= ( const TlsOptions & rhs )

Assign to this object the value of the specified rhs object.

◆ setCrlFetchTimeoutMs()

void setCrlFetchTimeoutMs ( int crlFetchTimeoutMs )

Set the CRL fetch timeout to the specified crlFetchTimeoutMs. The default is 20,000 milliseconds. The TLS handshake timeout will be set to the default if the specified crlFetchTimeoutMs is not positive.

◆ setTlsHandshakeTimeoutMs()

void setTlsHandshakeTimeoutMs ( int tlsHandshakeTimeoutMs )

Set the TLS handshake timeout to the specified tlsHandshakeTimeoutMs. The default is 10,000 milliseconds. The TLS handshake timeout will be set to the default if the specified tlsHandshakeTimeoutMs is not positive.

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

blpapi_tlsoptions.h

Public Member Functions

Static Public Member Functions