focal (3) mongoc_client_session_with_transaction_cb_t.3.gz

Provided by: libmongoc-doc_1.16.1-1build2_all bug

NAME

       mongoc_client_session_with_transaction_cb_t - mongoc_client_session_with_transaction_cb_t

SYNOPSIS

          typedef bool (*mongoc_client_session_with_transaction_cb_t) (
             mongoc_client_session_t *session,
             void *ctx,
             bson_t **reply,
             bson_error_t *error);

       Provide  this  callback  to mongoc_client_session_with_transaction. The callback should run a sequence of
       operations meant to be contained within a transaction.  The callback  should  not  attempt  to  start  or
       commit transactions.

PARAMETERS

session: A mongoc_client_session_t.

       • ctx: A void* set to the the user-provided ctx passed to mongoc_client_session_with_transaction.

       • reply:  An  optional  location  for  a  bson_t  or  NULL.  The  callback should set this if it runs any
         operations against the server and receives replies.

       • error: A bson_error_t. The callback should set this if it receives any errors while running  operations
         against the server.

RETURN

       Returns true for success and false on failure. If cb returns false then it should also set error.

SEE ALSO

       mongoc_client_session_with_transaction

AUTHOR

       MongoDB, Inc

       2017-present, MongoDB, Inc