mongoc_socket_destroy() – This function releases all resources associated with a mongoc_socket_t. This should be called when you are no longer using the socket. Synopsis void mongoc_socket_destroy (mongoc_socket_t *sock); Parameters sock A mongoc_socket_t \&. Description This function releases all resources associated with a mongoc_socket_t \&. This should be called when you are no longer using the…
mongoc_socket_connect() – This function is a wrapper around the BSD socket connect() interface. It provides better portability between UNIX-like and Microsoft Windows platforms. Synopsis int mongoc_socket_connect (mongoc_socket_t *sock, const struct sockaddr *addr, socklen_t addrlen, int64_t expire_at); Parameters sock A mongoc_socket_t \&. addr A struct sockaddr. addrlen A socklen_t. expire_at A int64_t containing the absolute timeout…
mongoc_socket_close() – This function is a wrapper around the BSD socket shutdown() interface. It provides better portability between UNIX-like and Microsoft Windows platforms. Synopsis int mongoc_socket_close (mongoc_socket_t *socket); Parameters socket A mongoc_socket_t \&. Description This function is a wrapper around the BSD socket shutdown(3) interface. It provides better portability between UNIX-like and Microsoft Windows platforms….
mongoc_socket_bind() – This function is a wrapper around the BSD socket bind() interface. It provides better portability between UNIX-like and Microsoft Windows platforms. Synopsis int mongoc_socket_bind (mongoc_socket_t *sock, const struct sockaddr *addr, socklen_t addrlen); Parameters sock A mongoc_socket_t \&. addr A struct sockaddr. addrlen A socklen_t. Description This function is a wrapper around the BSD…
mongoc_socket_accept() – This function is a wrapper around the BSD socket accept() interface. It allows for more portability between UNIX-like and Microsoft Windows platforms. Synopsis mongoc_socket_t * mongoc_socket_accept (mongoc_socket_t *sock, int64_t expire_at); Parameters sock A mongoc_socket_t \&. expire_at An int64_t containing a timeout in milliseconds. Description This function is a wrapper around the BSD socket…
mongoc_server_description_t – Server description Synopsis #include <mongoc.h> typedef struct _mongoc_server_description_t mongoc_server_description_t mongoc_server_description_t holds information about a mongod server to which the driver has connected. Lifecycle It is required that this object be cleaned up with mongoc_server_description_destroy(3) \&. Colophon This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_server_description_new_copy() – This function copies the given server description and returns a new server description object. The caller is responsible for destroying the new copy. Synopsis mongoc_server_description_t * mongoc_server_description_new_copy (const mongoc_server_description_t *description); Parameters description A The server description to copy \&. Description This function copies the given server description and returns a new server description…
mongoc_server_description_id() – This functionr returns the server id for the given server description. Synopsis uint32_t mongoc_server_description_id (const mongoc_server_description_t *description); Parameters description A The server description whose id we want \&. Description This functionr returns the server id for the given server description. Returns A uint32_t id for the given server description. Colophon This page is…
mongoc_server_description_host() – This function returns the host that the given server description is associated with. This object is owned by the server description Synopsis mongoc_host_list_t * mongoc_server_description_host (const mongoc_server_description_t *description); Parameters description A The server description for which we’d like a host \&. Description This function returns the host that the given server description is…
mongoc_server_description_destroy() – This function cleans up all memory associated with the given server description. Synopsis void mongoc_server_description_destroy(mongoc_server_description_t *description); Parameters description A The description to destroy. \&. Description This function cleans up all memory associated with the given server description. Returns None. Colophon This page is part of MongoDB C Driver. Please report any bugs at…
mongoc_reply_flags_t – Flags for deletion operations Synopsis typedef enum { MONGOC_REPLY_NONE = 0, MONGOC_REPLY_CURSOR_NOT_FOUND = 1 << 0, MONGOC_REPLY_QUERY_FAILURE = 1 << 1, MONGOC_REPLY_SHARD_CONFIG_STALE = 1 << 2, MONGOC_REPLY_AWAIT_CAPABLE = 1 << 3, } mongoc_reply_flags_t; Description These flags correspond to the wire protocol. They may be bitwise or’d together. Flag Values MONGOC_REPLY_NONE No flags set….
mongoc_remove_flags_t – Flags for deletion operations Synopsis typedef enum { MONGOC_REMOVE_NONE = 0, MONGOC_REMOVE_SINGLE_REMOVE = 1 << 0, } mongoc_remove_flags_t; Description These flags correspond to the MongoDB wire protocol. They may be bitwise or’d together. They may change the number of documents that are removed during a remove command. Flag Values MONGOC_REMOVE_NONE Specify no removal…
mongoc_read_prefs_t – A read preference abstraction Synopsis mongoc_read_prefs_t provides an abstraction on top of the MongoDB connection read prefences. It allows for hinting to the driver which nodes in a replica set should be accessed first. You can specify a read preference mode on connection objects, database objects, collection objects, or per-operation. Generally, it makes…
mongoc_read_prefs_set_tags() – Sets the tags to be used for the read preference. Only mongod instances matching these tags will be suitable for handling the request. Synopsis void mongoc_read_prefs_set_tags (mongoc_read_prefs_t *read_prefs, const bson_t *tags); Parameters read_prefs A mongoc_read_prefs_t \&. tags A bson_t \&. Description Sets the tags to be used for the read preference. Only mongod…
mongoc_read_prefs_set_mode() – Sets the read preference mode. See the MongoDB website for more information on Read Preferences. Synopsis void mongoc_read_prefs_set_mode (mongoc_read_prefs_t *read_prefs, mongoc_read_mode_t mode); Parameters read_prefs A mongoc_read_prefs_t \&. mode A mongoc_read_mode_t \&. Description Sets the read preference mode. See the MongoDB website for more information on Read Preferences \&. Colophon This page is part…
mongoc_read_prefs_new() – Creates a new mongoc_read_prefs_t using the mode specified. Synopsis mongoc_read_prefs_t * mongoc_read_prefs_new (mongoc_read_mode_t read_mode); Parameters read_mode A mongoc_read_mode_t \&. Description Creates a new mongoc_read_prefs_t using the mode specified. Returns Returns a newly allocated mongoc_read_prefs_t that should be freed with mongoc_read_prefs_destroy(3) \&. Colophon This page is part of MongoDB C Driver. Please report any…
mongoc_read_prefs_is_valid() – Performs a consistency check of read_prefs to ensure it makes sense and can be satisfied. Synopsis bool mongoc_read_prefs_is_valid (const mongoc_read_prefs_t *read_prefs); Parameters read_prefs A mongoc_read_prefs_t \&. Description Performs a consistency check of read_prefs to ensure it makes sense and can be satisfied. This only performs local consistency checks. Returns Returns true if the…
mongoc_read_prefs_get_tags() – Fetches any read preference tags that have been registered. Synopsis const bson_t * mongoc_read_prefs_get_tags (const mongoc_read_prefs_t *read_prefs); Parameters read_prefs A mongoc_read_prefs_t \&. Description Fetches any read preference tags that have been registered. Returns Returns a bson_t that should not be modified or freed. Colophon This page is part of MongoDB C Driver. Please…
mongoc_read_prefs_get_mode() – Fetches the mongoc_read_mode_t for the read preference. Synopsis mongoc_read_mode_t mongoc_read_prefs_get_mode (const mongoc_read_prefs_t *read_prefs); Parameters read_prefs A mongoc_read_prefs_t \&. Description Fetches the mongoc_read_mode_t for the read preference. Returns Returns the read preference mode. Colophon This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
mongoc_read_prefs_destroy() – Frees a read preference and all associated resources. Synopsis void mongoc_read_prefs_destroy (mongoc_read_prefs_t *read_prefs); Parameters read_prefs A mongoc_read_prefs_t \&. Description Frees a read preference and all associated resources. Colophon This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.