aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_http_conn_write_all.3http.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-05-01 17:11:32 -0700
committerGarrett D'Amore <garrett@damore.org>2018-05-01 19:18:37 -0700
commit3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c (patch)
treed670fc9ac327e017c62a72cbaeda4bcacda5f9dd /docs/man/nng_http_conn_write_all.3http.adoc
parent1ef281a7fbd544c6d3384fd8a71d10dc4bb081e8 (diff)
downloadnng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.tar.gz
nng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.tar.bz2
nng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.zip
Markup fixes, ensuring links are colored properly.
It turns out that when creating cross references, we need to make any text styling (generally literal characters) outside of the link, to avoid having the styling override the link color. (We prefer to have links colored for ease of use.) While here a few other markup, and actual content, errors were fixed.
Diffstat (limited to 'docs/man/nng_http_conn_write_all.3http.adoc')
-rw-r--r--docs/man/nng_http_conn_write_all.3http.adoc21
1 files changed, 11 insertions, 10 deletions
diff --git a/docs/man/nng_http_conn_write_all.3http.adoc b/docs/man/nng_http_conn_write_all.3http.adoc
index f517a9a5..d29af75e 100644
--- a/docs/man/nng_http_conn_write_all.3http.adoc
+++ b/docs/man/nng_http_conn_write_all.3http.adoc
@@ -29,37 +29,38 @@ The `nng_http_conn_write_all()` function starts an asynchronous write to the
HTTP connection _conn_, into the scatter/gather vector located in the
asynchronous I/O structure _aio_.
-NOTE: The <<nng_aio_set_iov.3#,`nng_aio_set_iov()`>> function must have been
+NOTE: The `<<nng_aio_set_iov.3#,nng_aio_set_iov()>>` function must have been
called first, to set the scatter/gather vector for _aio_.
This function returns immediately, with no return value.
Completion of the operation is signaled via the _aio_, and the
-final result may be obtained via <<nng_aio_result.3#,`nng_aio_result()`>>.
+final result may be obtained via `<<nng_aio_result.3#,nng_aio_result()>>`.
That result will either be zero or an error code.
The I/O operation completes only when the entire amount of data
-requested has been written, or an error has occurred. If the operation
-completes successfully, then the entire requested data has been written.
+requested has been written, or an error has occurred.
+If the operation completes successfully, then the entire requested data has
+been written.
It is still possible for a partial write to complete in the event of an error.
The actual number of bytes written can be determined with
-<<nng_aio_count.3#,`nng_aio_count()`>>.
+`<<nng_aio_count.3#,nng_aio_count()>>`.
TIP: The main purpose for this function is to faciliate writing HTTP
body content.
TIP: Usually an HTTP request or response will have been written immediately
-prior to this with <<nng_http_conn_write_req.3http#,`http_conn_write_req()`>> or
-<<nng_http_conn_write_res.3http#,`http_conn_write_res()`>>.
+prior to this with `<<nng_http_conn_write_req.3http#,http_conn_write_req()>>` or
+`<<nng_http_conn_write_res.3http#,http_conn_write_res()>>`.
In that case the request or response should have also contained
an `Content-Length` header, and possibly a `Content-Type` header.
TIP: An easier solution to sending HTTP content data, is to include the
conten with the request or reply using a function like
-<<nng_http_req_copy_data.3http#,`nng_http_req_copy_data()`>>.
+`<<nng_http_req_copy_data.3http#,nng_http_req_copy_data()>>`.
In that case, the body data will be written automatically by the
-<<nng_http_conn_write_req.3http#,`http_conn_write_req()`>> or
-<<nng_http_conn_write_req.3http#,`http_conn_write_res()`>> function.
+`<<nng_http_conn_write_req.3http#,http_conn_write_req()>>` or
+`<<nng_http_conn_write_req.3http#,http_conn_write_res()>>` function.
== RETURN VALUES