Scroll to navigation

MONGOC_CLIENT_SET_SSL_OPTS(3) libmongoc MONGOC_CLIENT_SET_SSL_OPTS(3)

NAME

mongoc_client_set_ssl_opts - mongoc_client_set_ssl_opts()

SYNOPSIS

#ifdef MONGOC_ENABLE_SSL
void
mongoc_client_set_ssl_opts (mongoc_client_t *client,

const mongoc_ssl_opt_t *opts); #endif


Sets the TLS (SSL) options to use when connecting to TLS enabled MongoDB servers.

The mongoc_ssl_opt_t struct is copied by the client along with the strings it points to (pem_file, pem_pwd, ca_file, ca_dir, and crl_file) so they don't have to remain valid after the call to mongoc_client_set_ssl_opts.

A call to mongoc_client_set_ssl_opts overrides all TLS options set through the connection string with which the mongoc_client_t was constructed.

It is a programming error to call this function on a client from a mongoc_client_pool_t. Instead, call mongoc_client_pool_set_ssl_opts() on the pool before popping any clients.

PARAMETERS

  • client: A mongoc_client_t.
  • opts: A mongoc_ssl_opt_t.

AVAILABILITY

This feature requires that the MongoDB C driver was compiled with -DENABLE_SSL.

AUTHOR

MongoDB, Inc

COPYRIGHT

2017-present, MongoDB, Inc

August 31, 2022 1.23.0