Scroll to navigation

MONGOC_CLIENT_POOL_SET_SSL_OPTS(3) MongoDB C Driver MONGOC_CLIENT_POOL_SET_SSL_OPTS(3)

NAME

mongoc_client_pool_set_ssl_opts - mongoc_client_pool_set_ssl_opts()

SYNOPSIS

#ifdef MONGOC_ENABLE_SSL
void
mongoc_client_pool_set_ssl_opts (mongoc_client_pool_t *pool,
                                 const mongoc_ssl_opt_t *opts);
#endif


This function is identical to mongoc_client_set_ssl_opts() except for client pools. It ensures that all clients retrieved from mongoc_client_pool_pop() or mongoc_client_pool_try_pop() are configured with the same SSL settings.

The mongoc_ssl_opt_t struct is copied by the pool 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_pool_set_ssl_opts.

A call to mongoc_client_pool_set_ssl_opts overrides all SSL options set through the connection string with which the mongoc_client_pool_t was constructed.

PARAMETERS

  • pool: A mongoc_client_pool_t.
  • opts: A mongoc_ssl_opt_t.

THREAD SAFETY

This function can only be called once on a pool, and must be called before the first call to mongoc_client_pool_pop.

AVAILABILITY

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

AUTHOR

MongoDB, Inc

COPYRIGHT

2017-present, MongoDB, Inc
February 23, 2019 1.14.0