mongoc_uri_destroy() – Frees all resources associated with a uri. Synopsis void mongoc_uri_destroy (mongoc_uri_t *uri); Parameters uri A mongoc_uri_t \&. Description Frees all resources associated with a uri. Colophon This 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. Synopsis mongoc_uri_t * mongoc_uri_copy (const mongoc_uri_t *uri); Parameters uri A mongoc_uri_t \&. Description Copies the entire contents of a URI. Returns A newly allocated mongoc_uri_t that should be freed with mongoc_uri_destroy(3) \&. Colophon This page is part of MongoDB C Driver. Please report any bugs at…
mongoc_update_flags_t – Flags for deletion operations Synopsis typedef 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) Description These flags correspond to the MongoDB wire protocol. They may be bitwise or’d together. The allow for modifying the way an update is performed…
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. Synopsis ssize_t mongoc_stream_writev (mongoc_stream_t *stream, mongoc_iovec_t *iov, size_t iovcnt, int32_t timeout_msec); Parameters stream A mongoc_stream_t \&. iov A vector of mongoc_iovec_t \&. iovcnt The number of items in…
mongoc_stream_uncork() – This function shall allow a previously corked socket to pass bytes to the underlying socket. Synopsis int mongoc_stream_uncork (mongoc_stream_t *stream); Parameters stream 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. Returns 0…
mongoc_stream_tls_t – typedef struct _mongoc_stream_tls_t mongoc_stream_tls_t Synopsis typedef struct _mongoc_stream_tls_t mongoc_stream_tls_t mongoc_stream_tls_t is a mongoc_stream_t subclass for working with OpenSSL TLS streams. Colophon This 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. Synopsis mongoc_stream_t * mongoc_stream_tls_new (mongoc_stream_t *base_stream, mongoc_ssl_opt_t *opt, int client); Parameters base_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. Returns A newly allocated mongoc_stream_tls_t \&. Colophon This page is…
mongoc_stream_tls_do_handshake() – This function shall perform an SSL handshake on the underlying stream. Synopsis bool mongoc_stream_tls_do_handshake (mongoc_stream_t *stream, int32_t timeout_msec); Parameters stream 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. Returns The mongoc_stream_tls_do_handshake(3) function returns true if the handshake was successful….
mongoc_stream_tls_check_cert() – The mongoc_stream_tls_check_cert() function shall perform a RFC-6125 certificate verification. Synopsis bool mongoc_stream_tls_check_cert (mongoc_stream_t *stream, const char *host); Parameters stream 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…
mongoc_stream_t – typedef struct _mongoc_stream_t mongoc_stream_t Synopsis typedef struct _mongoc_stream_t mongoc_stream_t mongoc_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…
mongoc_stream_socket_t – typedef struct _mongoc_stream_socket_t mongoc_stream_socket_t Synopsis typedef struct _mongoc_stream_socket_t mongoc_stream_socket_t mongoc_stream_socket_t should be considered a subclass of mongoc_stream_t that works upon socket streams. Colophon This 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. Synopsis mongoc_stream_t * mongoc_stream_socket_new (mongoc_socket_t *socket); Parameters socket 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. Returns A newly allocated mongoc_stream_socket_t that should be freed with mongoc_stream_destroy(3) when no longer…
mongoc_stream_socket_get_socket() – Retrieves the underlying mongoc_socket_t for a mongoc_stream_socket_t. Synopsis mongoc_socket_t * mongoc_stream_socket_get_socket (mongoc_stream_socket_t *stream); Parameters stream A mongoc_stream_socket_t \&. Retrieves the underlying mongoc_socket_t for a mongoc_stream_socket_t \&. Returns A mongoc_stream_socket_t \&. Colophon This 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. Synopsis int mongoc_stream_setsockopt (mongoc_stream_t *stream, int level, int optname, void *optval, socklen_t optlen); Parameters stream 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)…
mongoc_stream_readv() – This function is identical to mongoc_stream_read() except that it takes a mongoc_iovec_t to perform gathered I/O. Synopsis ssize_t mongoc_stream_readv (mongoc_stream_t *stream, mongoc_iovec_t *iov, size_t iovcnt, size_t min_bytes, int32_t timeout_msec); Parameters stream A mongoc_stream_t \&. iov A vector of mongoc_iovec_t \&. iovcnt The number of items in iov \&. min_bytes The minimum number of…
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. Synopsis ssize_t mongoc_stream_read (mongoc_stream_t *stream, void *buf, size_t count, size_t min_bytes, int32_t timeout_msec); Parameters stream A mongoc_stream_t \&. buf The buffer to read into. count The number of…
mongoc_stream_gridfs_t – typedef struct _mongoc_stream_gridfs_t mongoc_stream_gridfs_t Synopsis typedef struct _mongoc_stream_gridfs_t mongoc_stream_gridfs_t The 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. Colophon This 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. Synopsis mongoc_stream_t * mongoc_stream_gridfs_new (mongoc_gridfs_file_t *file); Parameters file A mongoc_gridfs_file_t \&. This function shall create a new mongoc_gridfs_file_t \&. This function does not transfer ownership of file…
mongoc_stream_get_base_stream() – This function shall fetch the underlying stream for streams that wrap a base stream. Such implementations include mongoc_stream_buffered_t and mongoc_stream_tls_t. Synopsis mongoc_stream_t * mongoc_stream_get_base_stream (mongoc_stream_t *stream); Parameters stream A mongoc_stream_t \&. This function shall fetch the underlying stream for streams that wrap a base stream. Such implementations include mongoc_stream_buffered_t and mongoc_stream_tls_t \&. Returns…
mongoc_stream_flush() – This function shall flush any buffered bytes in the underlying stream to the physical transport. It mimics the API and semantics of fflush(), forcing a write of user space buffered data. Synopsis int mongoc_stream_flush (mongoc_stream_t *stream); Parameters stream A mongoc_stream_t \&. This function shall flush any buffered bytes in the underlying stream to…