1MONGOC_CLIENT_POOL_POP(3)          libmongoc         MONGOC_CLIENT_POOL_POP(3)
2
3
4

NAME

6       mongoc_client_pool_pop - mongoc_client_pool_pop()
7

SYNOPSIS

9          mongoc_client_t *
10          mongoc_client_pool_pop (mongoc_client_pool_t *pool)
11             BSON_GNUC_WARN_UNUSED_RESULT;
12
13       Retrieve a mongoc_client_t from the client pool, or create one. The to‐
14       tal number of clients that can be created from this pool is limited  by
15       the  URI  option  "maxPoolSize", default 100. If this number of clients
16       has been created and all are in use, mongoc_client_pool_pop blocks  un‐
17       til  another thread returns a client with mongoc_client_pool_push(). If
18       the "waitQueueTimeoutMS" URI  option  was  specified  with  a  positive
19       value,  then  mongoc_client_pool_pop  will return NULL when the timeout
20       expires.
21
22       The returned mongoc_client_t must be returned to  the  pool  with  mon‐
23       goc_client_pool_push().
24

PARAMETERS

26       • pool: A mongoc_client_pool_t.
27

RETURNS

29       A mongoc_client_t.
30

THREAD SAFETY

32       This function is safe to call from multiple threads.
33

AUTHOR

35       MongoDB, Inc
36

38       2017-present, MongoDB, Inc
39
40
41
42
431.21.1                           Mar 02, 2022        MONGOC_CLIENT_POOL_POP(3)
Impressum