MONGOC_HANDSHAKE_DATA_APPEND(3) libmongoc MONGOC_HANDSHAKE_DATA_APPEND(3) SYNOPSIS bool mongoc_handshake_data_append (const char *driver_name, const char *driver_version, const char *platform); Appends the given strings to the handshake data for the underlying C Dri- ver. DESCRIPTION This function is intended for use by drivers which wrap the C Driver. Calling this function will store the given strings as handshake data about the system and driver by appending them to the handshake data for the un- derlying C Driver. These values, along with other handshake data collected during mongoc_init will be sent to the server as part of the initial con- nection handshake in the "client" document. This function must not be called more than once, or after server monitoring begins. For a sin- gle-threaded mongoc_client_t, server monitoring begins on the first opera- tion requiring a server. For a mongoc_client_pool_t, server monitoring be- gins on the first call to :symbol:`mongoc_client_pool_pop. The passed in strings are copied, and don't have to remain valid after the call to mongoc_handshake_data_append(). The driver may store truncated ver- sions of the passed in strings. NOTE: This function allocates memory, and therefore caution should be used when using this in conjunction with bson_mem_set_vtable(). If this func- tion is called before bson_mem_set_vtable(), then - bson_mem_restore_vtable() must be called before calling mongoc_cleanup(). Failure to do so will result in memory being freed by the wrong allocator. PARAMETERS * driver_name: An optional string storing the name of the wrapping driver * driver_version: An optional string storing the version of the wrapping driver. * platform: An optional string storing any information about the current platform, for example configure options or compile flags. RETURNS true if the given fields are set successfully. Otherwise, it returns false and logs an error. The default handshake data the driver sends with "hello" looks something like: client: { driver: { name: "mongoc", version: "1.5.0" }, os: {...}, platform: "CC=gcc CFLAGS=-Wall -pedantic" } If we call mongoc_handshake_data_append() ("phongo", "1.1.8", "CC=clang / ") and it returns true, the driver sends handshake data like: client: { driver: { name: "mongoc / phongo", version: "1.5.0 / 1.1.8" }, os: {...}, platform: "CC=clang / gcc CFLAGS=-Wall -pedantic" } AUTHOR MongoDB, Inc COPYRIGHT 2009-present, MongoDB, Inc. 1.30.8 Aug 27, 2026 MONGOC_HANDSHAKE_DATA_APPEND(3)
SYNOPSIS | DESCRIPTION | PARAMETERS | RETURNS | AUTHOR | COPYRIGHT
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mongoc_handshake_data_append&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>