docs(sse): add API reference page for sse.h (issue #271) - #305
Merged
Merged
Conversation
Add docs/api/sse.md covering the nine public functions, the cwist_sse_event_t type and the convenience macros in include/cwist/net/http/sse.h, and link it from the module list in docs/API.md. The page describes the code as it is in src/net/http/sse.c. No source or header changes.
Member
|
nice catch! |
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
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.
Fixes #271
Problem
include/cwist/net/http/sse.h exposes nine public functions, but there is
no reference page under docs/api/ and docs/API.md does not list SSE.
Fix
Add docs/api/sse.md in the same format as docs/api/query.md: a header
line, one section per function with its signature and a short
description, the cwist_sse_event_t type, the convenience macros, and a
short example for each of response mode and stream mode. Link it from
the module list in docs/API.md.
Verification
matches the page: the response-mode handler produces
"id:1 / event:message / data:..." frames, and the stream-mode handler
writes the 200 OK headers followed by "event:tick / data:1" and the
":heartbeat" comment over a socketpair.
"retry:0".
Scope
planned work.