docs(unified): add comprehensive Unified API interface guide#689
Merged
Conversation
Document all 3 unified interfaces (i_transport, i_connection, i_listener) and foundation types (endpoint_info, connection_callbacks, listener_callbacks, connection_options). Includes interface hierarchy, connection state machine, protocol support matrix, protocol-agnostic code examples, and guide for extending with custom protocol implementations. Closes #685
6 tasks
Add documentation for the const char* constructor overloads of endpoint_info that were present in the header but missing from the guide.
Contributor
Performance ComparisonBase Branch ResultsNo base results PR Branch ResultsNo PR results |
1 similar comment
Contributor
Performance ComparisonBase Branch ResultsNo base results PR Branch ResultsNo PR results |
kcenon
added a commit
that referenced
this pull request
Apr 13, 2026
* docs(unified): add comprehensive Unified API interface guide Document all 3 unified interfaces (i_transport, i_connection, i_listener) and foundation types (endpoint_info, connection_callbacks, listener_callbacks, connection_options). Includes interface hierarchy, connection state machine, protocol support matrix, protocol-agnostic code examples, and guide for extending with custom protocol implementations. Closes #685 * docs(unified): add missing endpoint_info C-string constructor overloads Add documentation for the const char* constructor overloads of endpoint_info that were present in the header but missing from the guide.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #685
Summary
docs/UNIFIED_API_GUIDE.mddocumenting the Unified API interface layeri_transport(base),i_connection(lifecycle),i_listener(server-side)endpoint_info,connection_callbacks,listener_callbacks,connection_optionsTest Plan
Verification Results
One MEDIUM issue found and fixed in second commit: missing
endpoint_infoC-string constructor overloads.