mongoc_client_set_stream_initiator(3)

mongoc_client_set_stream_initiator()

Section 3 libmongoc-doc bookworm source

Description

MONGOC_CLIENT_SET_STREAM_INITIATOR

NAME

mongoc_client_set_stream_initiator - mongoc_client_set_stream_initiator()

SYNOPSIS

void
mongoc_client_set_stream_initiator (mongoc_client_t *client,
mongoc_stream_initiator_t initiator,
void *user_data);

The mongoc_client_set_stream_initiator() function shall associate a given mongoc_client_t with a new stream initiator. This will completely replace the default transport (buffered TCP, possibly with TLS). The initiator should fulfill the mongoc_stream_t contract. user_data is passed through to the initiator callback and may be used for whatever run time customization is necessary.

If user_data is passed, it is the application's responsibility to ensure user_data remains valid for the lifetime of the client.

PARAMETERS

client: A mongoc_client_t.

initiator: A mongoc_stream_initiator_t.

user_data: User supplied pointer for callback function.

AUTHOR

MongoDB, Inc

COPYRIGHT

2017-present, MongoDB, Inc