Contents Menu Expand Light mode Dark mode Auto light/dark mode
libmongoc 1.26.0
libmongoc 1.26.0
  • Tutorials
    • Obtaining the MongoDB C Driver Libraries
      • Building the C Driver Libraries from Source
      • Installing Prebuilt MongoDB C Driver Libraries
      • Building the mongo-c-driver Documentation Pages
  • How-To Guides
    • How to: Install libbson/libmongoc from Source
  • Reference
    • Package Installation Reference
    • mongo-c-driver Platform Support
  • Tutorial
  • Authentication
  • Basic Troubleshooting
  • Guides
    • Configuring TLS
    • Common Tasks
    • Advanced Connections
    • Connection Pooling
    • Data Compression
    • Cursors
    • Bulk Write Operations
    • Aggregation Framework Examples
    • “distinct” and “mapReduce”
    • Using libmongoc in a Microsoft Visual Studio project
    • Manage Collection Indexes
    • Aids for Debugging
    • In-Use Encryption
      • Client-Side Field Level Encryption
      • Queryable Encryption
  • API Reference
    • Initialization and cleanup
      • mongoc_init()
      • mongoc_cleanup()
    • Logging
    • Error Reporting
      • mongoc_error_has_label()
    • Object Lifecycle
    • GridFS
    • mongoc_auto_encryption_opts_t
      • mongoc_auto_encryption_opts_new()
      • mongoc_auto_encryption_opts_destroy()
      • mongoc_auto_encryption_opts_set_keyvault_client()
      • mongoc_auto_encryption_opts_set_keyvault_client_pool()
      • mongoc_auto_encryption_opts_set_keyvault_namespace()
      • mongoc_auto_encryption_opts_set_kms_providers()
      • mongoc_auto_encryption_opts_set_kms_credential_provider_callback()
      • mongoc_auto_encryption_opts_set_schema_map()
      • mongoc_auto_encryption_opts_set_bypass_auto_encryption()
      • mongoc_auto_encryption_opts_set_extra()
      • mongoc_auto_encryption_opts_set_tls_opts()
      • mongoc_auto_encryption_opts_set_encrypted_fields_map()
      • mongoc_auto_encryption_opts_set_bypass_query_analysis()
    • mongoc_bulk_operation_t
      • mongoc_bulk_operation_delete()
      • mongoc_bulk_operation_delete_one()
      • mongoc_bulk_operation_destroy()
      • mongoc_bulk_operation_execute()
      • mongoc_bulk_operation_get_hint()
      • mongoc_bulk_operation_get_write_concern()
      • mongoc_bulk_operation_insert()
      • mongoc_bulk_operation_insert_with_opts()
      • mongoc_bulk_operation_remove()
      • mongoc_bulk_operation_remove_many_with_opts()
      • mongoc_bulk_operation_remove_one()
      • mongoc_bulk_operation_remove_one_with_opts()
      • mongoc_bulk_operation_replace_one()
      • mongoc_bulk_operation_replace_one_with_opts()
      • mongoc_bulk_operation_set_bypass_document_validation()
      • mongoc_bulk_operation_set_client_session()
      • mongoc_bulk_operation_set_comment()
      • mongoc_bulk_operation_set_hint()
      • mongoc_bulk_operation_set_let()
      • mongoc_bulk_operation_update()
      • mongoc_bulk_operation_update_many_with_opts()
      • mongoc_bulk_operation_update_one()
      • mongoc_bulk_operation_update_one_with_opts()
    • mongoc_change_stream_t
      • mongoc_client_watch()
      • mongoc_database_watch()
      • mongoc_collection_watch()
      • mongoc_change_stream_next()
      • mongoc_change_stream_get_resume_token()
      • mongoc_change_stream_error_document()
      • mongoc_change_stream_destroy()
    • mongoc_client_encryption_t
      • mongoc_client_encryption_new()
      • mongoc_client_encryption_destroy()
      • mongoc_client_encryption_create_datakey()
      • mongoc_client_encryption_create_encrypted_collection()
      • mongoc_client_encryption_rewrap_many_datakey()
      • mongoc_client_encryption_delete_key()
      • mongoc_client_encryption_get_crypt_shared_version()
      • mongoc_client_encryption_get_key()
      • mongoc_client_encryption_get_keys()
      • mongoc_client_encryption_add_key_alt_name()
      • mongoc_client_encryption_remove_key_alt_name()
      • mongoc_client_encryption_get_key_by_alt_name()
      • mongoc_client_encryption_encrypt()
      • mongoc_client_encryption_encrypt_expression()
      • mongoc_client_decryption_decrypt()
    • mongoc_client_encryption_datakey_opts_t
      • mongoc_client_encryption_datakey_opts_new()
      • mongoc_client_encryption_datakey_opts_destroy()
      • mongoc_client_encryption_datakey_opts_set_masterkey()
      • mongoc_client_encryption_datakey_opts_set_keyaltnames()
      • mongoc_client_encryption_datakey_opts_set_keymaterial()
    • mongoc_client_encryption_rewrap_many_datakey_result_t
      • mongoc_client_encryption_rewrap_many_datakey_result_new()
      • mongoc_client_encryption_rewrap_many_datakey_result_destroy()
      • mongoc_client_encryption_rewrap_many_datakey_result_get_bulk_write_result()
    • mongoc_client_encryption_encrypt_opts_t
      • mongoc_client_encryption_encrypt_opts_new()
      • mongoc_client_encryption_encrypt_opts_destroy()
      • mongoc_client_encryption_encrypt_opts_set_keyid()
      • mongoc_client_encryption_encrypt_opts_set_keyaltname()
      • mongoc_client_encryption_encrypt_opts_set_algorithm()
      • mongoc_client_encryption_encrypt_opts_set_contention_factor()
      • mongoc_client_encryption_encrypt_opts_set_query_type()
      • mongoc_client_encryption_encrypt_opts_set_range_opts()
    • mongoc_client_encryption_encrypt_range_opts_t
      • mongoc_client_encryption_encrypt_range_opts_new()
      • mongoc_client_encryption_encrypt_range_opts_destroy()
      • mongoc_client_encryption_encrypt_range_opts_set_sparsity()
      • mongoc_client_encryption_encrypt_range_opts_set_min()
      • mongoc_client_encryption_encrypt_range_opts_set_max()
      • mongoc_client_encryption_encrypt_range_opts_set_precision()
      • mongoc_client_encryption_encrypt_opts_set_range_opts()
    • mongoc_client_encryption_opts_t
      • mongoc_client_encryption_opts_new()
      • mongoc_client_encryption_opts_destroy()
      • mongoc_client_encryption_opts_set_keyvault_client()
      • mongoc_client_encryption_opts_set_keyvault_namespace()
      • mongoc_client_encryption_opts_set_kms_credential_provider_callback ()
      • mongoc_client_encryption_opts_set_kms_providers()
      • mongoc_client_encryption_opts_set_tls_opts()
    • mongoc_client_pool_t
      • mongoc_client_pool_destroy()
      • mongoc_client_pool_enable_auto_encryption()
      • mongoc_client_pool_max_size()
      • mongoc_client_pool_min_size()
      • mongoc_client_pool_new()
      • mongoc_client_pool_new_with_error()
      • mongoc_client_pool_pop()
      • mongoc_client_pool_push()
      • mongoc_client_pool_set_apm_callbacks()
      • mongoc_client_pool_set_appname()
      • mongoc_client_pool_set_error_api()
      • mongoc_client_pool_set_server_api()
      • mongoc_client_pool_set_ssl_opts()
      • mongoc_client_pool_try_pop()
    • mongoc_client_session_t
      • mongoc_client_session_start_transaction()
      • mongoc_client_session_in_transaction()
      • mongoc_client_session_get_transaction_state()
      • mongoc_client_session_commit_transaction()
      • mongoc_client_session_abort_transaction()
      • mongoc_client_session_advance_cluster_time()
      • mongoc_client_session_advance_operation_time()
      • mongoc_client_session_with_transaction()
      • mongoc_client_session_append()
      • mongoc_client_session_get_client()
      • mongoc_client_session_get_cluster_time()
      • mongoc_client_session_get_dirty()
      • mongoc_client_session_get_operation_time()
      • mongoc_client_session_get_opts()
      • mongoc_client_session_get_lsid()
      • mongoc_client_session_get_server_id()
      • mongoc_client_session_destroy()
    • mongoc_client_session_with_transaction_cb_t
    • mongoc_client_t
      • mongoc_client_command()
      • mongoc_client_command_simple()
      • mongoc_client_command_simple_with_server_id()
      • mongoc_client_command_with_opts()
      • mongoc_client_destroy()
      • mongoc_client_enable_auto_encryption()
      • mongoc_client_find_databases_with_opts()
      • mongoc_client_get_collection()
      • mongoc_client_get_crypt_shared_version()
      • mongoc_client_get_database()
      • mongoc_client_get_database_names()
      • mongoc_client_get_database_names_with_opts()
      • mongoc_client_get_default_database()
      • mongoc_client_get_gridfs()
      • mongoc_client_get_handshake_description()
      • mongoc_client_get_read_concern()
      • mongoc_client_get_read_prefs()
      • mongoc_client_get_server_description()
      • mongoc_client_get_server_descriptions()
      • mongoc_client_get_server_status()
      • mongoc_client_get_uri()
      • mongoc_client_get_write_concern()
      • mongoc_client_new()
      • mongoc_client_new_from_uri()
      • mongoc_client_new_from_uri_with_error()
      • mongoc_client_read_command_with_opts()
      • mongoc_client_read_write_command_with_opts()
      • mongoc_client_reset()
      • mongoc_client_select_server()
      • mongoc_client_set_apm_callbacks()
      • mongoc_client_set_appname()
      • mongoc_client_set_error_api()
      • mongoc_client_set_read_concern()
      • mongoc_client_set_read_prefs()
      • mongoc_client_set_server_api()
      • mongoc_client_set_ssl_opts()
      • mongoc_client_set_stream_initiator()
      • mongoc_client_set_write_concern()
      • mongoc_client_start_session()
      • mongoc_client_watch()
      • mongoc_client_write_command_with_opts()
      • mongoc_handshake_data_append()
    • mongoc_collection_t
      • mongoc_collection_aggregate()
      • mongoc_collection_command()
      • mongoc_collection_command_simple()
      • mongoc_collection_command_with_opts()
      • mongoc_collection_copy()
      • mongoc_collection_count_documents()
      • mongoc_collection_estimated_document_count()
      • mongoc_collection_count()
      • mongoc_collection_count_with_opts()
      • mongoc_collection_create_bulk_operation()
      • mongoc_collection_create_bulk_operation_with_opts()
      • mongoc_collection_create_index()
      • mongoc_collection_create_index_with_opts()
      • mongoc_collection_create_indexes_with_opts()
      • mongoc_collection_delete()
      • mongoc_collection_delete_many()
      • mongoc_collection_delete_one()
      • mongoc_collection_destroy()
      • mongoc_collection_drop()
      • mongoc_collection_drop_index()
      • mongoc_collection_drop_index_with_opts()
      • mongoc_collection_drop_with_opts()
      • mongoc_collection_ensure_index()
      • mongoc_collection_find()
      • mongoc_collection_find_and_modify()
      • mongoc_collection_find_and_modify_with_opts()
      • mongoc_collection_find_indexes()
      • mongoc_collection_find_indexes_with_opts()
      • mongoc_collection_find_with_opts()
      • mongoc_collection_get_last_error()
      • mongoc_collection_get_name()
      • mongoc_collection_get_read_concern()
      • mongoc_collection_get_read_prefs()
      • mongoc_collection_get_write_concern()
      • mongoc_collection_insert()
      • mongoc_collection_insert_bulk()
      • mongoc_collection_insert_many()
      • mongoc_collection_insert_one()
      • mongoc_collection_keys_to_index_string()
      • mongoc_collection_read_command_with_opts()
      • mongoc_collection_read_write_command_with_opts()
      • mongoc_collection_remove()
      • mongoc_collection_rename()
      • mongoc_collection_rename_with_opts()
      • mongoc_collection_replace_one()
      • mongoc_collection_save()
      • mongoc_collection_set_read_concern()
      • mongoc_collection_set_read_prefs()
      • mongoc_collection_set_write_concern()
      • mongoc_collection_stats()
      • mongoc_collection_update()
      • mongoc_collection_update_one()
      • mongoc_collection_update_many()
      • mongoc_collection_validate()
      • mongoc_collection_write_command_with_opts()
    • mongoc_cursor_t
      • mongoc_cursor_clone()
      • mongoc_cursor_current()
      • mongoc_cursor_destroy()
      • mongoc_cursor_error()
      • mongoc_cursor_error_document()
      • mongoc_cursor_get_batch_size()
      • mongoc_cursor_get_hint()
      • mongoc_cursor_get_host()
      • mongoc_cursor_get_id()
      • mongoc_cursor_get_limit()
      • mongoc_cursor_get_max_await_time_ms()
      • mongoc_cursor_is_alive()
      • mongoc_cursor_more()
      • mongoc_cursor_new_from_command_reply()
      • mongoc_cursor_new_from_command_reply_with_opts()
      • mongoc_cursor_next()
      • mongoc_cursor_set_batch_size()
      • mongoc_cursor_set_hint()
      • mongoc_cursor_set_limit()
      • mongoc_cursor_set_max_await_time_ms()
    • mongoc_database_t
      • mongoc_database_add_user()
      • mongoc_database_aggregate()
      • mongoc_database_command()
      • mongoc_database_command_simple()
      • mongoc_database_command_with_opts()
      • mongoc_database_copy()
      • mongoc_database_create_collection()
      • mongoc_database_destroy()
      • mongoc_database_drop()
      • mongoc_database_drop_with_opts()
      • mongoc_database_find_collections()
      • mongoc_database_find_collections_with_opts()
      • mongoc_database_get_collection()
      • mongoc_database_get_collection_names()
      • mongoc_database_get_collection_names_with_opts()
      • mongoc_database_get_name()
      • mongoc_database_get_read_concern()
      • mongoc_database_get_read_prefs()
      • mongoc_database_get_write_concern()
      • mongoc_database_has_collection()
      • mongoc_database_read_command_with_opts()
      • mongoc_database_read_write_command_with_opts()
      • mongoc_database_remove_all_users()
      • mongoc_database_remove_user()
      • mongoc_database_set_read_concern()
      • mongoc_database_set_read_prefs()
      • mongoc_database_set_write_concern()
      • mongoc_database_watch()
      • mongoc_database_write_command_with_opts()
    • mongoc_delete_flags_t
    • mongoc_find_and_modify_opts_t
      • mongoc_find_and_modify_opts_append()
      • mongoc_find_and_modify_opts_destroy()
      • mongoc_find_and_modify_opts_get_bypass_document_validation()
      • mongoc_find_and_modify_opts_get_fields()
      • mongoc_find_and_modify_opts_get_flags()
      • mongoc_find_and_modify_opts_get_max_time_ms()
      • mongoc_find_and_modify_opts_get_sort()
      • mongoc_find_and_modify_opts_get_update()
      • mongoc_find_and_modify_opts_new()
      • mongoc_find_and_modify_opts_set_bypass_document_validation()
      • mongoc_find_and_modify_opts_set_fields()
      • mongoc_find_and_modify_opts_set_flags()
      • mongoc_find_and_modify_opts_set_max_time_ms()
      • mongoc_find_and_modify_opts_set_sort()
      • mongoc_find_and_modify_opts_set_update()
    • mongoc_gridfs_file_list_t
      • mongoc_gridfs_file_list_destroy()
      • mongoc_gridfs_file_list_error()
      • mongoc_gridfs_file_list_next()
    • mongoc_gridfs_file_opt_t
    • mongoc_gridfs_file_t
      • mongoc_gridfs_file_destroy()
      • mongoc_gridfs_file_error()
      • mongoc_gridfs_file_get_aliases()
      • mongoc_gridfs_file_get_chunk_size()
      • mongoc_gridfs_file_get_content_type()
      • mongoc_gridfs_file_get_filename()
      • mongoc_gridfs_file_get_id()
      • mongoc_gridfs_file_get_length()
      • mongoc_gridfs_file_get_md5()
      • mongoc_gridfs_file_get_metadata()
      • mongoc_gridfs_file_get_upload_date()
      • mongoc_gridfs_file_readv()
      • mongoc_gridfs_file_remove()
      • mongoc_gridfs_file_save()
      • mongoc_gridfs_file_seek()
      • mongoc_gridfs_file_set_aliases()
      • mongoc_gridfs_file_set_content_type()
      • mongoc_gridfs_file_set_filename()
      • mongoc_gridfs_file_set_id()
      • mongoc_gridfs_file_set_md5()
      • mongoc_gridfs_file_set_metadata()
      • mongoc_gridfs_file_tell()
      • mongoc_gridfs_file_writev()
      • mongoc_stream_gridfs_new()
    • mongoc_gridfs_bucket_t
      • mongoc_gridfs_bucket_abort_upload()
      • mongoc_gridfs_bucket_delete_by_id()
      • mongoc_gridfs_bucket_destroy()
      • mongoc_gridfs_bucket_download_to_stream()
      • mongoc_gridfs_bucket_find()
      • mongoc_gridfs_bucket_new()
      • mongoc_gridfs_bucket_open_download_stream()
      • mongoc_gridfs_bucket_open_upload_stream()
      • mongoc_gridfs_bucket_open_upload_stream_with_id()
      • mongoc_gridfs_bucket_stream_error()
      • mongoc_gridfs_bucket_upload_from_stream()
      • mongoc_gridfs_bucket_upload_from_stream_with_id()
    • mongoc_gridfs_t
      • mongoc_gridfs_create_file()
      • mongoc_gridfs_create_file_from_stream()
      • mongoc_gridfs_destroy()
      • mongoc_gridfs_drop()
      • mongoc_gridfs_find()
      • mongoc_gridfs_find_one()
      • mongoc_gridfs_find_one_by_filename()
      • mongoc_gridfs_find_one_with_opts()
      • mongoc_gridfs_find_with_opts()
      • mongoc_gridfs_get_chunks()
      • mongoc_gridfs_get_files()
      • mongoc_gridfs_remove_by_filename()
    • mongoc_host_list_t
    • mongoc_index_opt_geo_t
      • mongoc_index_opt_geo_get_default()
      • mongoc_index_opt_geo_init()
    • mongoc_index_opt_t
      • mongoc_index_opt_get_default()
      • mongoc_index_opt_init()
    • mongoc_index_opt_wt_t
      • mongoc_index_opt_wt_get_default()
      • mongoc_index_opt_wt_init()
    • mongoc_insert_flags_t
    • mongoc_iovec_t
    • mongoc_optional_t
      • mongoc_optional_copy()
      • mongoc_optional_init()
      • mongoc_optional_is_set()
      • mongoc_optional_set_value()
      • mongoc_optional_value()
    • mongoc_query_flags_t
    • mongoc_rand
      • mongoc_rand_add()
      • mongoc_rand_seed()
      • mongoc_rand_status()
    • mongoc_read_concern_t
      • mongoc_read_concern_append()
      • mongoc_read_concern_copy()
      • mongoc_read_concern_destroy()
      • mongoc_read_concern_get_level()
      • mongoc_read_concern_is_default()
      • mongoc_read_concern_new()
      • mongoc_read_concern_set_level()
    • mongoc_read_mode_t
    • mongoc_read_prefs_t
      • mongoc_read_prefs_add_tag()
      • mongoc_read_prefs_copy()
      • mongoc_read_prefs_destroy()
      • mongoc_read_prefs_get_hedge()
      • mongoc_read_prefs_get_max_staleness_seconds()
      • mongoc_read_prefs_get_mode()
      • mongoc_read_prefs_get_tags()
      • mongoc_read_prefs_is_valid()
      • mongoc_read_prefs_new()
      • mongoc_read_prefs_set_hedge()
      • mongoc_read_prefs_set_max_staleness_seconds()
      • mongoc_read_prefs_set_mode()
      • mongoc_read_prefs_set_tags()
    • mongoc_remove_flags_t
    • mongoc_reply_flags_t
    • mongoc_server_api_t
      • mongoc_server_api_copy()
      • mongoc_server_api_deprecation_errors()
      • mongoc_server_api_destroy()
      • mongoc_server_api_get_deprecation_errors()
      • mongoc_server_api_get_strict()
      • mongoc_server_api_get_version()
      • mongoc_server_api_new()
      • mongoc_server_api_strict()
    • mongoc_server_api_version_t
      • mongoc_server_api_version_from_string()
      • mongoc_server_api_version_to_string()
    • mongoc_server_description_t
      • mongoc_server_description_destroy()
      • mongoc_server_description_hello_response()
      • mongoc_server_description_host()
      • mongoc_server_description_id()
      • mongoc_server_description_ismaster()
      • mongoc_server_description_last_update_time()
      • mongoc_server_description_new_copy()
      • mongoc_server_description_round_trip_time()
      • mongoc_server_description_type()
      • mongoc_server_descriptions_destroy_all()
    • mongoc_session_opt_t
      • mongoc_session_opts_new()
      • mongoc_session_opts_get_causal_consistency()
      • mongoc_session_opts_set_causal_consistency()
      • mongoc_session_opts_get_default_transaction_opts()
      • mongoc_session_opts_set_default_transaction_opts()
      • mongoc_session_opts_get_snapshot()
      • mongoc_session_opts_set_snapshot()
      • mongoc_session_opts_get_transaction_opts()
      • mongoc_session_opts_clone()
      • mongoc_session_opts_destroy()
    • mongoc_socket_t
      • mongoc_socket_accept()
      • mongoc_socket_bind()
      • mongoc_socket_close()
      • mongoc_socket_connect()
      • mongoc_socket_destroy()
      • mongoc_socket_errno()
      • mongoc_socket_getnameinfo()
      • mongoc_socket_getsockname()
      • mongoc_socket_listen()
      • mongoc_socket_new()
      • mongoc_socket_recv()
      • mongoc_socket_send()
      • mongoc_socket_sendv()
      • mongoc_socket_setsockopt()
    • mongoc_ssl_opt_t
      • mongoc_ssl_opt_get_default()
    • mongoc_stream_buffered_t
    • mongoc_stream_file_t
      • mongoc_stream_file_get_fd()
      • mongoc_stream_file_new()
      • mongoc_stream_file_new_for_path()
    • mongoc_stream_socket_t
      • mongoc_stream_socket_get_socket()
      • mongoc_stream_socket_new()
    • mongoc_stream_t
      • mongoc_stream_buffered_new()
      • mongoc_stream_close()
      • mongoc_stream_cork()
      • mongoc_stream_destroy()
      • mongoc_stream_flush()
      • mongoc_stream_get_base_stream()
      • mongoc_stream_read()
      • mongoc_stream_readv()
      • mongoc_stream_setsockopt()
      • mongoc_stream_should_retry()
      • mongoc_stream_timed_out()
      • mongoc_stream_uncork()
      • mongoc_stream_write()
      • mongoc_stream_writev()
    • mongoc_stream_tls_t
    • mongoc_topology_description_t
      • mongoc_topology_description_destroy()
      • mongoc_topology_description_get_servers()
      • mongoc_topology_description_has_readable_server()
      • mongoc_topology_description_has_writable_server()
      • mongoc_topology_description_new_copy()
      • mongoc_topology_description_type()
    • mongoc_transaction_opt_t
      • mongoc_transaction_opts_new()
      • mongoc_transaction_opts_get_read_concern()
      • mongoc_transaction_opts_set_read_concern()
      • mongoc_transaction_opts_get_write_concern()
      • mongoc_transaction_opts_set_write_concern()
      • mongoc_transaction_opts_get_read_prefs()
      • mongoc_transaction_opts_set_read_prefs()
      • mongoc_transaction_opts_get_max_commit_time_ms()
      • mongoc_transaction_opts_set_max_commit_time_ms()
      • mongoc_transaction_opts_clone()
      • mongoc_transaction_opts_destroy()
    • mongoc_transaction_state_t
    • mongoc_update_flags_t
    • mongoc_uri_t
      • mongoc_uri_copy()
      • mongoc_uri_destroy()
      • mongoc_uri_get_auth_mechanism()
      • mongoc_uri_get_auth_source()
      • mongoc_uri_get_compressors()
      • mongoc_uri_get_database()
      • mongoc_uri_get_hosts()
      • mongoc_uri_get_mechanism_properties()
      • mongoc_uri_get_option_as_bool()
      • mongoc_uri_get_option_as_int32()
      • mongoc_uri_get_option_as_int64()
      • mongoc_uri_get_option_as_utf8()
      • mongoc_uri_get_options()
      • mongoc_uri_get_password()
      • mongoc_uri_get_read_concern()
      • mongoc_uri_get_read_prefs()
      • mongoc_uri_get_read_prefs_t()
      • mongoc_uri_get_replica_set()
      • mongoc_uri_get_service()
      • mongoc_uri_get_ssl()
      • mongoc_uri_get_string()
      • mongoc_uri_get_srv_hostname()
      • mongoc_uri_get_srv_service_name()
      • mongoc_uri_get_tls()
      • mongoc_uri_get_username()
      • mongoc_uri_get_write_concern()
      • mongoc_uri_has_option()
      • mongoc_uri_new()
      • mongoc_uri_new_for_host_port()
      • mongoc_uri_new_with_error()
      • mongoc_uri_option_is_bool()
      • mongoc_uri_option_is_int32()
      • mongoc_uri_option_is_int64()
      • mongoc_uri_option_is_utf8()
      • mongoc_uri_set_auth_mechanism()
      • mongoc_uri_set_auth_source()
      • mongoc_uri_set_compressors()
      • mongoc_uri_set_database()
      • mongoc_uri_set_mechanism_properties()
      • mongoc_uri_set_option_as_bool()
      • mongoc_uri_set_option_as_int32()
      • mongoc_uri_set_option_as_int64()
      • mongoc_uri_set_option_as_utf8()
      • mongoc_uri_set_password()
      • mongoc_uri_set_read_concern()
      • mongoc_uri_set_read_prefs_t()
      • mongoc_uri_set_username()
      • mongoc_uri_set_write_concern()
      • mongoc_uri_unescape()
    • Version Checks
      • mongoc_check_version()
      • mongoc_get_major_version()
      • mongoc_get_micro_version()
      • mongoc_get_minor_version()
      • mongoc_get_version()
    • mongoc_write_concern_t
      • mongoc_write_concern_append()
      • mongoc_write_concern_copy()
      • mongoc_write_concern_destroy()
      • mongoc_write_concern_get_fsync()
      • mongoc_write_concern_get_journal()
      • mongoc_write_concern_get_w()
      • mongoc_write_concern_get_wmajority()
      • mongoc_write_concern_get_wtag()
      • mongoc_write_concern_get_wtimeout()
      • mongoc_write_concern_get_wtimeout_int64()
      • mongoc_write_concern_is_acknowledged()
      • mongoc_write_concern_is_default()
      • mongoc_write_concern_is_valid()
      • mongoc_write_concern_journal_is_set()
      • mongoc_write_concern_new()
      • mongoc_write_concern_set_fsync()
      • mongoc_write_concern_set_journal()
      • mongoc_write_concern_set_w()
      • mongoc_write_concern_set_wmajority()
      • mongoc_write_concern_set_wtag()
      • mongoc_write_concern_set_wtimeout()
      • mongoc_write_concern_set_wtimeout_int64()
  • Application Performance Monitoring (APM)
    • mongoc_apm_callbacks_t
      • mongoc_apm_callbacks_destroy()
      • mongoc_apm_callbacks_new()
      • mongoc_apm_set_command_failed_cb()
      • mongoc_apm_set_command_started_cb()
      • mongoc_apm_set_command_succeeded_cb()
      • mongoc_apm_set_server_changed_cb()
      • mongoc_apm_set_server_closed_cb()
      • mongoc_apm_set_server_heartbeat_failed_cb()
      • mongoc_apm_set_server_heartbeat_started_cb()
      • mongoc_apm_set_server_heartbeat_succeeded_cb()
      • mongoc_apm_set_server_opening_cb()
      • mongoc_apm_set_topology_changed_cb()
      • mongoc_apm_set_topology_closed_cb()
      • mongoc_apm_set_topology_opening_cb()
    • mongoc_apm_command_failed_t
      • mongoc_apm_command_failed_get_command_name()
      • mongoc_apm_command_failed_get_context()
      • mongoc_apm_command_failed_get_duration()
      • mongoc_apm_command_failed_get_error()
      • mongoc_apm_command_failed_get_host()
      • mongoc_apm_command_failed_get_operation_id()
      • mongoc_apm_command_failed_get_reply()
      • mongoc_apm_command_failed_get_request_id()
      • mongoc_apm_command_failed_get_server_id()
      • mongoc_apm_command_failed_get_service_id()
      • mongoc_apm_command_failed_get_server_connection_id()
      • mongoc_apm_command_failed_get_server_connection_id_int64()
    • mongoc_apm_command_started_t
      • mongoc_apm_command_started_get_command()
      • mongoc_apm_command_started_get_command_name()
      • mongoc_apm_command_started_get_context()
      • mongoc_apm_command_started_get_database_name()
      • mongoc_apm_command_started_get_host()
      • mongoc_apm_command_started_get_operation_id()
      • mongoc_apm_command_started_get_request_id()
      • mongoc_apm_command_started_get_server_id()
      • mongoc_apm_command_started_get_service_id()
      • mongoc_apm_command_started_get_server_connection_id()
      • mongoc_apm_command_started_get_server_connection_id_int64()
    • mongoc_apm_command_succeeded_t
      • mongoc_apm_command_succeeded_get_command_name()
      • mongoc_apm_command_succeeded_get_context()
      • mongoc_apm_command_succeeded_get_duration()
      • mongoc_apm_command_succeeded_get_host()
      • mongoc_apm_command_succeeded_get_operation_id()
      • mongoc_apm_command_succeeded_get_reply()
      • mongoc_apm_command_succeeded_get_request_id()
      • mongoc_apm_command_succeeded_get_server_id()
      • mongoc_apm_command_succeeded_get_service_id()
      • mongoc_apm_command_succeeded_get_server_connection_id()
      • mongoc_apm_command_succeeded_get_server_connection_id_int64()
    • mongoc_apm_server_changed_t
      • mongoc_apm_server_changed_get_context()
      • mongoc_apm_server_changed_get_host()
      • mongoc_apm_server_changed_get_new_description()
      • mongoc_apm_server_changed_get_previous_description()
      • mongoc_apm_server_changed_get_topology_id()
    • mongoc_apm_server_closed_t
      • mongoc_apm_server_closed_get_context()
      • mongoc_apm_server_closed_get_host()
      • mongoc_apm_server_closed_get_topology_id()
    • mongoc_apm_server_heartbeat_failed_t
      • mongoc_apm_server_heartbeat_failed_get_awaited()
      • mongoc_apm_server_heartbeat_failed_get_context()
      • mongoc_apm_server_heartbeat_failed_get_duration()
      • mongoc_apm_server_heartbeat_failed_get_error()
      • mongoc_apm_server_heartbeat_failed_get_host()
    • mongoc_apm_server_heartbeat_started_t
      • mongoc_apm_server_heartbeat_started_get_awaited()
      • mongoc_apm_server_heartbeat_started_get_context()
      • mongoc_apm_server_heartbeat_started_get_host()
    • mongoc_apm_server_heartbeat_succeeded_t
      • mongoc_apm_server_heartbeat_succeeded_get_awaited()
      • mongoc_apm_server_heartbeat_succeeded_get_context()
      • mongoc_apm_server_heartbeat_succeeded_get_duration()
      • mongoc_apm_server_heartbeat_succeeded_get_host()
      • mongoc_apm_server_heartbeat_succeeded_get_reply()
    • mongoc_apm_server_opening_t
      • mongoc_apm_server_opening_get_context()
      • mongoc_apm_server_opening_get_host()
      • mongoc_apm_server_opening_get_topology_id()
    • mongoc_apm_topology_changed_t
      • mongoc_apm_topology_changed_get_context()
      • mongoc_apm_topology_changed_get_new_description()
      • mongoc_apm_topology_changed_get_previous_description()
      • mongoc_apm_topology_changed_get_topology_id()
    • mongoc_apm_topology_closed_t
      • mongoc_apm_topology_closed_get_context()
      • mongoc_apm_topology_closed_get_topology_id()
    • mongoc_apm_topology_opening_t
      • mongoc_apm_topology_opening_get_context()
      • mongoc_apm_topology_opening_get_topology_id()
Back to top

mongoc_apm_server_heartbeat_started_t#

Heartbeat-started event

Synopsis#

An event notification sent when the driver begins executing a “hello” command to check the status of a server.

See also

Introduction to Application Performance Monitoring

Functions#

  • mongoc_apm_server_heartbeat_started_get_awaited()
  • mongoc_apm_server_heartbeat_started_get_context()
  • mongoc_apm_server_heartbeat_started_get_host()
Next
mongoc_apm_server_heartbeat_started_get_awaited()
Previous
mongoc_apm_server_heartbeat_failed_get_host()
Copyright © 2017-present, MongoDB, Inc
Made with Sphinx and @pradyunsg's Furo
On this page
  • mongoc_apm_server_heartbeat_started_t
    • Synopsis
    • Functions