[CDRIVER-4176] Make MONGOC_RTT_UNSET and MONGOC_NO_SERVER_CONNECTION_ID public Created: 04/Oct/21  Updated: 28/Apr/22

Status: Backlog
Project: C Driver
Component/s: docs, libmongoc
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Minor - P4
Reporter: Jeremy Mikola Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: documentation
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
related to PHPC-1985 Server::getLatency() should return nu... Closed
is related to CDRIVER-4085 Add server connectionId to command mo... Closed

 Description   

Load Balancers: Monitoring states that "all other fields in the ServerDescription MUST remain unset." This includes the round-trip time (RTT).

Internally, MONGOC_RTT_UNSET is defined as -1; however, this is not mentioned in the documentation for mongoc_server_description_round_trip_time. A load balanced client may be the first scenarior where RTT may be unset, so this possible return value should be noted in the documentation.

Additionally, CDRIVER-4085 introduced a MONGOC_NO_SERVER_CONNECTION_ID constant. Its value is relevant to documentation for get_server_connection_id, so it'd make sense to publicize that constant as well.


Generated at Wed Feb 07 21:20:10 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.