Section 3: library functions
mongoc_uri_get_auth_source() – Fetches the authSource parameter of an URI if provided. Synopsisconst char * mongoc_uri_get_auth_source (const mongoc_uri_t *uri);Parametersuri A mongoc_uri_t \&.DescriptionFetches the authSource parameter of an URI if provided. ReturnsA string which should not be modified or freed. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_uri_get_auth_mechanism() – Fetches the authMechanism parameter to an URI if provided. Synopsisconst char * mongoc_uri_get_auth_mechanism (const mongoc_uri_t *uri);Parametersuri A mongoc_uri_t \&.DescriptionFetches the authMechanism parameter to an URI if provided. ReturnsA string which should not be modified or freed. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_uri_destroy() – Frees all resources associated with a uri. Synopsisvoid mongoc_uri_destroy (mongoc_uri_t *uri);Parametersuri A mongoc_uri_t \&.DescriptionFrees all resources associated with a uri. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_uri_copy() – Copies the entire contents of a URI. Synopsismongoc_uri_t * mongoc_uri_copy (const mongoc_uri_t *uri);Parametersuri A mongoc_uri_t \&.DescriptionCopies the entire contents of a URI. ReturnsA newly allocated mongoc_uri_t that should be freed with mongoc_uri_destroy(3) \&. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_update_flags_t – Flags for deletion operations Synopsistypedef enum { MONGOC_UPDATE_NONE = 0, MONGOC_UPDATE_UPSERT = 1 << 0, MONGOC_UPDATE_MULTI_UPDATE = 1 << 1, } mongoc_update_flags_t; #define MONGOC_UPDATE_NO_VALIDATE (1U << 31)DescriptionThese flags correspond to the MongoDB wire protocol. They may be bitwise or’d together. The allow for modifying the way an update is performed in the MongoDB…
mongoc_stream_writev() – The mongoc_stream_writev() function shall perform a write to a mongoc_stream_t. It’s modeled on the API and semantics of writev(), though the parameters map only loosely. Synopsisssize_t mongoc_stream_writev (mongoc_stream_t *stream, mongoc_iovec_t *iov, size_t iovcnt, int32_t timeout_msec);Parametersstream A mongoc_stream_t \&.iov A vector of mongoc_iovec_t \&.iovcnt The number of items in iov \&.timeout_msec The number of…
mongoc_stream_uncork() – This function shall allow a previously corked socket to pass bytes to the underlying socket. Synopsisint mongoc_stream_uncork (mongoc_stream_t *stream);Parametersstream A mongoc_stream_t \&. This function shall allow a previously corked socket to pass bytes to the underlying socket. NOTE Not all streams implement this function. Buffering generally works better.Returns0 on success, -1 on failure…
mongoc_stream_tls_t – typedef struct _mongoc_stream_tls_t mongoc_stream_tls_t Synopsistypedef struct _mongoc_stream_tls_t mongoc_stream_tls_tmongoc_stream_tls_t is a mongoc_stream_t subclass for working with OpenSSL TLS streams. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_stream_tls_new() – Creates a new mongoc_stream_tls_t using the parameters supplied. Synopsismongoc_stream_t * mongoc_stream_tls_new (mongoc_stream_t *base_stream, mongoc_ssl_opt_t *opt, int client);Parametersbase_stream A mongoc_stream_t \&.opt A mongoc_ssl_opt_t \&.client 1 for client, 0 for server TLS. Creates a new mongoc_stream_tls_t using the parameters supplied. ReturnsA newly allocated mongoc_stream_tls_t \&. ColophonThis page is part of MongoDB C Driver. Please report…
mongoc_stream_tls_do_handshake() – This function shall perform an SSL handshake on the underlying stream. Synopsisbool mongoc_stream_tls_do_handshake (mongoc_stream_t *stream, int32_t timeout_msec);Parametersstream A mongoc_stream_tls_t \&.timeout_msec A timeout, in milliseconds, for the handshake. This function shall perform an SSL handshake on the underlying stream. ReturnsThe mongoc_stream_tls_do_handshake(3) function returns true if the handshake was successful. If false, errno or openssl…
mongoc_stream_tls_check_cert() – The mongoc_stream_tls_check_cert() function shall perform a RFC-6125 certificate verification. Synopsisbool mongoc_stream_tls_check_cert (mongoc_stream_t *stream, const char *host);Parametersstream A mongoc_stream_tls_t \&.host A UTF-8 string holding the hostname used in socket creation. This value is what will be matched against the server provided certificate. The mongoc_stream_tls_check_cert(3) function shall perform a RFC-6125 certificate verification. ReturnsThe mongoc_stream_tls_check_cert(3) function…
mongoc_stream_t – typedef struct _mongoc_stream_t mongoc_stream_t Synopsistypedef struct _mongoc_stream_t mongoc_stream_tmongoc_stream_t provides a generic streaming IO abstraction based on a struct of pointers interface. The idea is to allow wrappers, perhaps other language drivers, to easily shim their IO system on top of mongoc_stream_t \&. The API for the stream abstraction is currently private and non-extensible….
mongoc_stream_socket_t – typedef struct _mongoc_stream_socket_t mongoc_stream_socket_t Synopsistypedef struct _mongoc_stream_socket_t mongoc_stream_socket_tmongoc_stream_socket_t should be considered a subclass of mongoc_stream_t that works upon socket streams. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_stream_socket_new() – Creates a new mongoc_stream_socket_t using the mongoc_socket_t provided. Synopsismongoc_stream_t * mongoc_stream_socket_new (mongoc_socket_t *socket);Parameterssocket A mongoc_socket_t \&. Creates a new mongoc_stream_socket_t using the mongoc_socket_t provided. NOTE This function transfers ownership of socket to the newly allocated stream.ReturnsA newly allocated mongoc_stream_socket_t that should be freed with mongoc_stream_destroy(3) when no longer in use. ColophonThis page is…
mongoc_stream_socket_get_socket() – Retrieves the underlying mongoc_socket_t for a mongoc_stream_socket_t. Synopsismongoc_socket_t * mongoc_stream_socket_get_socket (mongoc_stream_socket_t *stream);Parametersstream A mongoc_stream_socket_t \&. Retrieves the underlying mongoc_socket_t for a mongoc_stream_socket_t \&. ReturnsA mongoc_stream_socket_t \&. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_stream_setsockopt() – This function is a wrapper around setsockopt() for streams that wrap sockets. Synopsisint mongoc_stream_setsockopt (mongoc_stream_t *stream, int level, int optname, void *optval, socklen_t optlen);Parametersstream A mongoc_stream_t \&.level The level to pass to setsockopt(3) \&.optname The optname to pass to setsockopt(3) \&.optval The optval to pass to setsockopt(3) \&.optlen The optlen to pass to…
mongoc_stream_readv() – This function is identical to mongoc_stream_read() except that it takes a mongoc_iovec_t to perform gathered I/O. Synopsisssize_t mongoc_stream_readv (mongoc_stream_t *stream, mongoc_iovec_t *iov, size_t iovcnt, size_t min_bytes, int32_t timeout_msec);Parametersstream A mongoc_stream_t \&.iov A vector of mongoc_iovec_t \&.iovcnt The number of items in iov \&.min_bytes The minimum number of bytes to read or failure will…
mongoc_stream_read() – The mongoc_stream_read() function shall perform a read from a mongoc_stream_t. It’s modeled on the API and semantics of read(), though the parameters map only loosely. Synopsisssize_t mongoc_stream_read (mongoc_stream_t *stream, void *buf, size_t count, size_t min_bytes, int32_t timeout_msec);Parametersstream A mongoc_stream_t \&.buf The buffer to read into.count The number of bytes to read.min_bytes The minimum…
mongoc_stream_gridfs_t – typedef struct _mongoc_stream_gridfs_t mongoc_stream_gridfs_t Synopsistypedef struct _mongoc_stream_gridfs_t mongoc_stream_gridfs_tThe mongoc_stream_gridfs_t class is an implementation of mongoc_stream_t for files stored in GridFS. It allows for transparently streaming GridFS files from a MongoDB server. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_stream_gridfs_new() – This function shall create a new mongoc_gridfs_file_t. This function does not transfer ownership of file. Therefore, file must remain valid for the lifetime of this stream. Synopsismongoc_stream_t * mongoc_stream_gridfs_new (mongoc_gridfs_file_t *file);Parametersfile A mongoc_gridfs_file_t \&. This function shall create a new mongoc_gridfs_file_t \&. This function does not transfer ownership of file \&. Therefore, file…