Linux Manuals

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. Synopsisint mongoc_socket_connect (mongoc_socket_t *sock, const struct sockaddr *addr, socklen_t addrlen, int64_t expire_at);Parameterssock A mongoc_socket_t \&.addr A struct sockaddr.addrlen A socklen_t.expire_at A int64_t containing the absolute timeout using the monotonic clock.DescriptionThis function is…

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. Synopsisint mongoc_socket_close (mongoc_socket_t *socket);Parameterssocket A mongoc_socket_t \&.DescriptionThis function is a wrapper around the BSD socket shutdown(3) interface. It provides better portability between UNIX-like and Microsoft Windows platforms. Returns0 on success, -1 on…

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. Synopsisint mongoc_socket_bind (mongoc_socket_t *sock, const struct sockaddr *addr, socklen_t addrlen);Parameterssock A mongoc_socket_t \&.addr A struct sockaddr.addrlen A socklen_t.DescriptionThis function is a wrapper around the BSD socket bind(3) interface. It provides better portability…

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. Synopsismongoc_socket_t * mongoc_socket_accept (mongoc_socket_t *sock, int64_t expire_at);Parameterssock A mongoc_socket_t \&.expire_at An int64_t containing a timeout in milliseconds.DescriptionThis function is a wrapper around the BSD socket accept(3) interface. It allows for more…

mongoc_server_description_t – Server description Synopsis#include <mongoc.h> typedef struct _mongoc_server_description_t mongoc_server_description_tmongoc_server_description_t holds information about a mongod server to which the driver has connected. LifecycleIt is required that this object be cleaned up with mongoc_server_description_destroy(3) \&. ColophonThis 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. Synopsismongoc_server_description_t * mongoc_server_description_new_copy (const mongoc_server_description_t *description);Parametersdescription A The server description to copy \&.DescriptionThis function copies the given server description and returns a new server description object. The caller is responsible…

mongoc_server_description_id() – This functionr returns the server id for the given server description. Synopsisuint32_t mongoc_server_description_id (const mongoc_server_description_t *description);Parametersdescription A The server description whose id we want \&.DescriptionThis functionr returns the server id for the given server description. ReturnsA uint32_t id for the given server description. ColophonThis page is part of MongoDB C Driver. Please report…

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 Synopsismongoc_host_list_t * mongoc_server_description_host (const mongoc_server_description_t *description);Parametersdescription A The server description for which we’d like a host \&.DescriptionThis function returns the host that the given server description is associated with. This object is…

mongoc_server_description_destroy() – This function cleans up all memory associated with the given server description. Synopsisvoid mongoc_server_description_destroy(mongoc_server_description_t *description);Parametersdescription A The description to destroy. \&.DescriptionThis function cleans up all memory associated with the given server description. ReturnsNone. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

mongoc_reply_flags_t – Flags for deletion operations Synopsistypedef 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;DescriptionThese flags correspond to the wire protocol. They may be bitwise or’d together. Flag ValuesMONGOC_REPLY_NONE No flags set.MONGOC_REPLY_CURSOR_NOT_FOUND No matching cursor was…

mongoc_remove_flags_t – Flags for deletion operations Synopsistypedef enum { MONGOC_REMOVE_NONE = 0, MONGOC_REMOVE_SINGLE_REMOVE = 1 << 0, } mongoc_remove_flags_t;DescriptionThese 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 ValuesMONGOC_REMOVE_NONE Specify no removal flags. All matching documents…

mongoc_read_prefs_t – A read preference abstraction Synopsismongoc_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 the…

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. Synopsisvoid mongoc_read_prefs_set_tags (mongoc_read_prefs_t *read_prefs, const bson_t *tags);Parametersread_prefs A mongoc_read_prefs_t \&.tags A bson_t \&.DescriptionSets the tags to be used for the read preference. Only mongod instances matching these tags will be…

mongoc_read_prefs_set_mode() – Sets the read preference mode. See the MongoDB website for more information on Read Preferences. Synopsisvoid mongoc_read_prefs_set_mode (mongoc_read_prefs_t *read_prefs, mongoc_read_mode_t mode);Parametersread_prefs A mongoc_read_prefs_t \&.mode A mongoc_read_mode_t \&.DescriptionSets the read preference mode. See the MongoDB website for more information on Read Preferences \&. ColophonThis page is part of MongoDB C Driver. Please report any…

mongoc_read_prefs_new() – Creates a new mongoc_read_prefs_t using the mode specified. Synopsismongoc_read_prefs_t * mongoc_read_prefs_new (mongoc_read_mode_t read_mode);Parametersread_mode A mongoc_read_mode_t \&.DescriptionCreates a new mongoc_read_prefs_t using the mode specified. ReturnsReturns a newly allocated mongoc_read_prefs_t that should be freed with mongoc_read_prefs_destroy(3) \&. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

mongoc_read_prefs_is_valid() – Performs a consistency check of read_prefs to ensure it makes sense and can be satisfied. Synopsisbool mongoc_read_prefs_is_valid (const mongoc_read_prefs_t *read_prefs);Parametersread_prefs A mongoc_read_prefs_t \&.DescriptionPerforms a consistency check of read_prefs to ensure it makes sense and can be satisfied. This only performs local consistency checks. ReturnsReturns true if the read pref is valid. ColophonThis page…

mongoc_read_prefs_get_tags() – Fetches any read preference tags that have been registered. Synopsisconst bson_t * mongoc_read_prefs_get_tags (const mongoc_read_prefs_t *read_prefs);Parametersread_prefs A mongoc_read_prefs_t \&.DescriptionFetches any read preference tags that have been registered. ReturnsReturns a bson_t that 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_read_prefs_get_mode() – Fetches the mongoc_read_mode_t for the read preference. Synopsismongoc_read_mode_t mongoc_read_prefs_get_mode (const mongoc_read_prefs_t *read_prefs);Parametersread_prefs A mongoc_read_prefs_t \&.DescriptionFetches the mongoc_read_mode_t for the read preference. ReturnsReturns the read preference mode. ColophonThis 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. Synopsisvoid mongoc_read_prefs_destroy (mongoc_read_prefs_t *read_prefs);Parametersread_prefs A mongoc_read_prefs_t \&.DescriptionFrees a read preference and all associated resources. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

mongoc_read_prefs_copy() – This function shall deep copy a read preference. Synopsismongoc_read_prefs_t * mongoc_read_prefs_copy (const mongoc_read_prefs_t *read_prefs);Parametersread_prefs A mongoc_read_prefs_t \&.DescriptionThis function shall deep copy a read preference. ReturnsReturns a newly allocated read preference that should be freed with mongoc_read_prefs_destroy(3) \&. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.