table of contents
MONGOC_CLIENT_SELECT_SERVER(3) | Library Functions Manual | MONGOC_CLIENT_SELECT_SERVER(3) |
NAME¶
mongoc_client_select_server() - NoneSYNOPSIS¶
mongoc_server_description_t * mongoc_client_select_server (mongoc_client_t *client, bool for_writes, const mongoc_read_prefs_t *prefs, bson_error_t *error);
Choose a server for an operation, according to the logic described in the Server Selection Spec.
Use this function only for building a language driver that wraps the C Driver. When writing applications in C, higher‐level functions automatically select a suitable server.
PARAMETERS¶
- client
- A mongoc_client_t
- for_writes
- Whether to choose a server suitable for writes or reads.
- prefs
- An optional mongoc_read_prefs_t for_writes is true, prefs must be NULL. Otherwise, use prefs to customize server selection, or pass NULL to use the read preference configured on the client.
- error
- An optional location for a bson_error_t or NULL
RETURNS¶
A mongoc_server_description_t that must be freed with mongoc_server_description_destroy error is filled out.COLOPHON¶
This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.2016‐10‐12 | MongoDB C Driver |