SslTransportConfig Class Reference

Public Member Functions
	SslTransportConfig ()
ReturnCode_t	get_default_config ()
ReturnCode_t	get_env_config ()

Data Fields
short	participant_index
List< IpTransportInterface >	interfaces
bool	dynamic_interfaces
int	tx_max_packet_size
string	server_cert_file
string	server_key_file
bool	server_verify_client
string	server_verify_ca_list_file
string	server_accept_ca_list_file
string	client_cert_file
string	client_key_file
string	client_verify_ca_list_file

Detailed Description

Structure that holds SSL Transport configuration items.

See also

DomainParticipant::add_transport(Transport) add_transport()

Constructor & Destructor Documentation

SslTransportConfig()

SslTransportConfig ( )

inline

Constructor. Initializes all configuration items with default values.

Member Function Documentation

get_default_config()

ReturnCode_t get_default_config ( )

inline

Initialize the SslTransportConfig object with default values. Currently assigned values may be overwritten by defaults.

get_env_config()

ReturnCode_t get_env_config ( )

inline

Query for environment variables that impact ssl transport configuration. Load the values (if any) into the SslTransportConfig object. Currently assigned values may be overwritten by values derived from environment variables.

Field Documentation

client_cert_file

string client_cert_file

client cert

client_key_file

string client_key_file

client private key

client_verify_ca_list_file

string client_verify_ca_list_file

'verify locations' used by client to verify server certificate

dynamic_interfaces

bool dynamic_interfaces

detect and handle changes to interface addresses

interfaces

List<IpTransportInterface> interfaces

default: empty -> use all available interfaces

participant_index

short participant_index

-1: auto detect; else force (may fail if another participant is using the ports (can't exceed 120)

server_accept_ca_list_file

string server_accept_ca_list_file

list of CA's to send to client as 'acceptable' CA's

server_cert_file

string server_cert_file

server cert

server_key_file

string server_key_file

server private key

server_verify_ca_list_file

string server_verify_ca_list_file

list of CA's to verify client certs against

server_verify_client

bool server_verify_client

Should server verify client certificate

tx_max_packet_size

int tx_max_packet_size

default: 64K (to match UDP limit)