Scroll to navigation

MONGOC_CLIENT_POOL_TRY_POP(3) libmongoc MONGOC_CLIENT_POOL_TRY_POP(3)

SYNOPSIS

mongoc_client_t *
mongoc_client_pool_try_pop (mongoc_client_pool_t *pool)


   BSON_GNUC_WARN_UNUSED_RESULT;


This function is identical to mongoc_client_pool_pop() except it will return NULL instead of blocking for a client to become available.

NOTE:

Return a checked out mongoc_client_t to the pool with mongoc_client_pool_push() quickly to encourage reuse of clients among threads.


PARAMETERS

•
pool: A mongoc_client_pool_t.

RETURNS

A mongoc_client_t if one is immediately available, otherwise NULL.

THREAD SAFETY

This function is safe to call from multiple threads.

AUTHOR

MongoDB, Inc

COPYRIGHT

2009-present, MongoDB, Inc.

October 9, 2024 1.28.1