Class representing the optional arguments to a MongoDB driver client (TLS)
More...
#include <tls.hpp>
|
| tls & | 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...
|
| |
| tls & | 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...
|
| |
| tls & | 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...
|
| |
| tls & | 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...
|
| |
| tls & | 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...
|
| |
| tls & | allow_invalid_certificates (bool allow_invalid_certificates) |
| | If true, 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...
|
| |
Class representing the optional arguments to a MongoDB driver client (TLS)
◆ allow_invalid_certificates() [1/2]
| const stdx::optional<bool>& mongocxx::v_noabi::options::tls::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.
◆ allow_invalid_certificates() [2/2]
| tls& mongocxx::v_noabi::options::tls::allow_invalid_certificates |
( |
bool |
allow_invalid_certificates | ) |
|
If true, the driver will not verify the server's CA file.
- Parameters
-
| allow_invalid_certificates | Whether or not to check the server's CA file. |
- Returns
- A reference to the object on which this member function is being called. This facilitates method chaining.
◆ ca_dir() [1/2]
| const stdx::optional<bsoncxx::string::view_or_value>& mongocxx::v_noabi::options::tls::ca_dir |
( |
| ) |
const |
Retrieves the current path to the CA directory.
- Returns
- The path to the CA directory.
◆ ca_dir() [2/2]
| tls& mongocxx::v_noabi::options::tls::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. |
- Returns
- A reference to the object on which this member function is being called. This facilitates method chaining.
◆ ca_file() [1/2]
| const stdx::optional<bsoncxx::string::view_or_value>& mongocxx::v_noabi::options::tls::ca_file |
( |
| ) |
const |
Retrieves the current path to the CA file.
- Returns
- The path to the CA file.
◆ ca_file() [2/2]
| tls& mongocxx::v_noabi::options::tls::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. |
- Returns
- A reference to the object on which this member function is being called. This facilitates method chaining.
◆ crl_file() [1/2]
| const stdx::optional<bsoncxx::string::view_or_value>& mongocxx::v_noabi::options::tls::crl_file |
( |
| ) |
const |
Retrieves the current path to the .pem file that contains revoked certificates.
- Returns
- The path to the revoked certificates file.
◆ crl_file() [2/2]
| tls& mongocxx::v_noabi::options::tls::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. |
- Returns
- A reference to the object on which this member function is being called. This facilitates method chaining.
◆ pem_file() [1/2]
| const stdx::optional<bsoncxx::string::view_or_value>& mongocxx::v_noabi::options::tls::pem_file |
( |
| ) |
const |
Retrieves the current path to the .pem file.
- Returns
- The path to the .pem file.
◆ pem_file() [2/2]
| tls& mongocxx::v_noabi::options::tls::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. |
- Returns
- A reference to the object on which this member function is being called. This facilitates method chaining.
◆ pem_password() [1/2]
| const stdx::optional<bsoncxx::string::view_or_value>& mongocxx::v_noabi::options::tls::pem_password |
( |
| ) |
const |
Retrieves the current decryption pass phrase.
- Returns
- The pass phrase.
◆ pem_password() [2/2]
| tls& mongocxx::v_noabi::options::tls::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. |
- Returns
- A reference to the object on which this member function is being called. This facilitates method chaining.
The documentation for this class was generated from the following file:
- src/mongocxx/include/mongocxx/v_noabi/mongocxx/options/tls.hpp
