Class representing the optional arguments to a MongoDB driver client (SSL) More...

#include <ssl.hpp>

Public Member Functions
ssl &	pem_file (bsoncxx::string::view_or_value pem_file)
	The path to the .pem file containing a public key certificate and its associated private key. More...

const stdx::optional< bsoncxx::string::view_or_value > &	pem_file () const
	Retrieves the current path to the .pem file. More...

ssl &	pem_password (bsoncxx::string::view_or_value pem_password)
	The pass phrase used to decrypt an encrypted PEM file. More...

const stdx::optional< bsoncxx::string::view_or_value > &	pem_password () const
	Retrieves the current decryption pass phrase. More...

ssl &	ca_file (bsoncxx::string::view_or_value ca_file)
	The path to the .pem file that contains the root certificate chain from the Certificate Authority. More...

const stdx::optional< bsoncxx::string::view_or_value > &	ca_file () const
	Retrieves the current path to the CA file. More...

ssl &	ca_dir (bsoncxx::string::view_or_value ca_dir)
	The path to the Certificate Authority directory. More...

const stdx::optional< bsoncxx::string::view_or_value > &	ca_dir () const
	Retrieves the current path to the CA directory. More...

ssl &	crl_file (bsoncxx::string::view_or_value crl_file)
	The path to the .pem file that contains revoked certificates. More...

const stdx::optional< bsoncxx::string::view_or_value > &	crl_file () const
	Retrieves the current path to the .pem file that contains revoked certificates. More...

ssl &	allow_invalid_certificates (bool allow_invalid_certificates)
	If false, the driver will not verify the server's CA file. More...

const stdx::optional< bool > &	allow_invalid_certificates () const
	Retrieves whether or not the driver will check the server's CA file. More...

Detailed Description

Class representing the optional arguments to a MongoDB driver client (SSL)

Member Function Documentation

ssl& mongocxx::options::ssl::allow_invalid_certificates ( bool allow_invalid_certificates )

If false, the driver will not verify the server's CA file.

Parameters

allow_invalid_certificates Whether or not to check the server's CA file.

const stdx::optional<bool>& mongocxx::options::ssl::allow_invalid_certificates ( ) const

Retrieves whether or not the driver will check the server's CA file.

Returns: Whether or not the driver will check the server's CA file.

ssl& mongocxx::options::ssl::ca_dir ( bsoncxx::string::view_or_value ca_dir )

The path to the Certificate Authority directory.

Parameters

ca_dir The path to the CA directory.

const stdx::optional<bsoncxx::string::view_or_value>& mongocxx::options::ssl::ca_dir ( ) const

Retrieves the current path to the CA directory.

Returns: The path to the CA directory.

ssl& mongocxx::options::ssl::ca_file ( bsoncxx::string::view_or_value ca_file )

The path to the .pem file that contains the root certificate chain from the Certificate Authority.

Parameters

ca_file The path to the CA file.

const stdx::optional<bsoncxx::string::view_or_value>& mongocxx::options::ssl::ca_file ( ) const

Retrieves the current path to the CA file.

Returns: The path to the CA file.

ssl& mongocxx::options::ssl::crl_file ( bsoncxx::string::view_or_value crl_file )

The path to the .pem file that contains revoked certificates.

Parameters

crl_file The path to the PEM file.

const stdx::optional<bsoncxx::string::view_or_value>& mongocxx::options::ssl::crl_file ( ) const

Retrieves the current path to the .pem file that contains revoked certificates.

Returns: The path to the revoked certificates file.

ssl& mongocxx::options::ssl::pem_file ( bsoncxx::string::view_or_value pem_file )

The path to the .pem file containing a public key certificate and its associated private key.

Parameters

pem_file The path to the .pem file.

const stdx::optional<bsoncxx::string::view_or_value>& mongocxx::options::ssl::pem_file ( ) const

Retrieves the current path to the .pem file.

Returns: The path to the .pem file.

ssl& mongocxx::options::ssl::pem_password ( bsoncxx::string::view_or_value pem_password )

The pass phrase used to decrypt an encrypted PEM file.

Parameters

pem_password The pass phrase.

const stdx::optional<bsoncxx::string::view_or_value>& mongocxx::options::ssl::pem_password ( ) const

Retrieves the current decryption pass phrase.

Returns: The pass phrase.

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

src/mongocxx/options/ssl.hpp

Public Member Functions

Detailed Description

Member Function Documentation