MongoDB C++ Driver  mongocxx-3.10.0
Public Member Functions | List of all members
mongocxx::v_noabi::options::client Class Reference

Class representing the optional arguments to a MongoDB driver client object. More...

#include <client.hpp>

Public Member Functions

clientssl_opts (tls ssl_opts)
 Sets the SSL-related options. More...
 
clienttls_opts (tls tls_opts)
 Sets the TLS-related options. More...
 
const stdx::optional< tls > & ssl_opts () const
 The current SSL-related options. More...
 
const stdx::optional< tls > & tls_opts () const
 The current TLS-related options. More...
 
clientauto_encryption_opts (auto_encryption auto_encryption_opts)
 Sets the automatic encryption options. More...
 
const stdx::optional< auto_encryption > & auto_encryption_opts () const
 Gets the current automatic encryption options. More...
 
clientapm_opts (apm apm_opts)
 Sets the APM-related options. More...
 
const stdx::optional< apm > & apm_opts () const
 The current APM-related options. More...
 
clientserver_api_opts (server_api server_api_opts)
 Sets the server API options. More...
 
const stdx::optional< server_api > & server_api_opts () const
 Gets the current server API options or returns a disengaged optional if there are no server API options set. More...
 

Detailed Description

Class representing the optional arguments to a MongoDB driver client object.

Member Function Documentation

◆ apm_opts() [1/2]

const stdx::optional<apm>& mongocxx::v_noabi::options::client::apm_opts ( ) const

The current APM-related options.

Returns
The APM-related options.

◆ apm_opts() [2/2]

client& mongocxx::v_noabi::options::client::apm_opts ( apm  apm_opts)

Sets the APM-related options.

Parameters
apm_optsThe APM-related options.
Returns
A reference to the object on which this member function is being called. This facilitates method chaining.

◆ auto_encryption_opts() [1/2]

const stdx::optional<auto_encryption>& mongocxx::v_noabi::options::client::auto_encryption_opts ( ) const

Gets the current automatic encryption options.

Returns
The automatic encryption opts.

◆ auto_encryption_opts() [2/2]

client& mongocxx::v_noabi::options::client::auto_encryption_opts ( auto_encryption  auto_encryption_opts)

Sets the automatic encryption options.

Parameters
auto_encryption_optsThe options for automatic encryption.
Returns
A reference to the object on which this member function is being called. This facilitates method chaining.

◆ server_api_opts() [1/2]

const stdx::optional<server_api>& mongocxx::v_noabi::options::client::server_api_opts ( ) const

Gets the current server API options or returns a disengaged optional if there are no server API options set.

Returns
The server API options.

◆ server_api_opts() [2/2]

client& mongocxx::v_noabi::options::client::server_api_opts ( server_api  server_api_opts)

Sets the server API options.

Parameters
server_api_optsThe options for server API.
Returns
A reference to the object on which this member function is being called. This facilitates method chaining.

◆ ssl_opts() [1/2]

const stdx::optional<tls>& mongocxx::v_noabi::options::client::ssl_opts ( ) const

The current SSL-related options.

Returns
The SSL-related options.
Deprecated:
Please use tls_opts instead.

◆ ssl_opts() [2/2]

client& mongocxx::v_noabi::options::client::ssl_opts ( tls  ssl_opts)

Sets the SSL-related options.

Parameters
ssl_optsThe SSL-related options.
Returns
A reference to the object on which this member function is being called. This facilitates method chaining.
Deprecated:
Please use tls_opts instead.

◆ tls_opts() [1/2]

const stdx::optional<tls>& mongocxx::v_noabi::options::client::tls_opts ( ) const

The current TLS-related options.

Returns
The TLS-related options.

◆ tls_opts() [2/2]

client& mongocxx::v_noabi::options::client::tls_opts ( tls  tls_opts)

Sets the TLS-related options.

Parameters
tls_optsThe TLS-related options.
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: