bionic (3) mongoc_client_pool_min_size.3.gz

Provided by: libmongoc-doc_1.9.2+dfsg-1build1_all bug

NAME

       mongoc_client_pool_min_size - mongoc_client_pool_min_size()

SYNOPSIS

          void
          mongoc_client_pool_min_size (mongoc_client_pool_t *pool,
                                       uint32_t min_pool_size)
             BSON_GNUC_DEPRECATED;

       This  function sets the maximum number of idle clients to be kept in the pool. Any idle clients in excess
       of the maximum are destroyed. This function is deprecated  because  its  behavior  does  not  match  what
       developers expect from a "minimum pool size", and its actual behavior is likely to hurt performance.

       Applications  should not call this function, they should instead accept the default behavior, which is to
       keep all idle clients that are pushed into the pool.

PARAMETERS

pool: A mongoc_client_pool_t.

       • min_pool_size: The number of idle clients to keep in the pool.

THREAD SAFETY

       This function is safe to call from multiple threads.

       Subsequent calls to mongoc_client_pool_push respect the new minimum size, and close  the  least  recently
       used mongoc_client_t if the minimum size is exceeded.

AUTHOR

       MongoDB, Inc

       2018, MongoDB, Inc