[CDRIVER-4133] Document possible values for mongoc_host_list_t.family Created: 18/Aug/21  Updated: 10/Feb/23

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

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

Issue Links:
Related
related to PHPC-1955 Consider exposing mongoc_host_list_t.... Backlog
is related to PHPC-1893 Define SDAM event classes Closed

 Description   

mongoc_host_list_t is a public struct, but no documentation is provided for its int family field. AFAIK, possible values for that field come from a subset of the AF_* constants defined in socket(2). The documentation would do well to discuss this.

This came up during a code review for PHPC-1893.


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