Skip to content

Commit

Permalink
docs: http method updates (rough draft for now)
Browse files Browse the repository at this point in the history
  • Loading branch information
gdamore committed Jan 6, 2025
1 parent 651696e commit 2ff83eb
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
10 changes: 5 additions & 5 deletions docs/man/nng_http_conn_read_req.3http.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= nng_http_conn_read_req(3http)
//
// Copyright 2018 Staysail Systems, Inc. <[email protected]>
// Copyright 2025 Staysail Systems, Inc. <[email protected]>
// Copyright 2018 Capitar IT Group BV <[email protected]>
//
// This document is supplied under the terms of the MIT License, a
Expand All @@ -20,15 +20,15 @@ nng_http_conn_read_req - read HTTP request
#include <nng/nng.h>
#include <nng/supplemental/http/http.h>
void nng_http_conn_read_req(nng_http_conn *conn, nng_http_req *req,
nng_aio *aio);
void nng_http_conn_read_req(nng_http_conn *conn, nng_aio *aio);
----

== DESCRIPTION

The `nng_http_conn_read_req()` function starts an asynchronous read from the
HTTP connection _conn_, reading an HTTP request into the _req_, including all
of the related headers.
HTTP connection _conn_, reading an HTTP request into the request object
associated with _conn_, including all of the related headers.
(The request object can be obtained via `nng_http_conn_req()`.

NOTE: Any HTTP entity/body data associated with the request is *not* read
automatically.
Expand Down
7 changes: 3 additions & 4 deletions docs/man/nng_http_conn_write_res.3http.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= nng_http_conn_write_res(3http)
//
// Copyright 2018 Staysail Systems, Inc. <[email protected]>
// Copyright 2025 Staysail Systems, Inc. <[email protected]>
// Copyright 2018 Capitar IT Group BV <[email protected]>
//
// This document is supplied under the terms of the MIT License, a
Expand All @@ -20,14 +20,13 @@ nng_http_conn_write_res - write HTTP response
#include <nng/nng.h>
#include <nng/supplemental/http/http.h>
void nng_http_conn_write_res(nng_http_conn *conn, nng_http_res *res,
nng_aio *aio);
void nng_http_conn_write_res(nng_http_conn *conn, nng_aio *aio);
----

== DESCRIPTION

The `nng_http_conn_write_res()` function starts an asynchronous write of
the HTTP response _res_ to the connection _conn_.
the HTTP response associated with the connection _conn_.
The entire response is sent,
including headers, and if present, the response body data.
(The response body can be set with
Expand Down

0 comments on commit 2ff83eb

Please sign in to comment.