aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_http_conn_write_req.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man/nng_http_conn_write_req.adoc')
-rw-r--r--docs/man/nng_http_conn_write_req.adoc62
1 files changed, 62 insertions, 0 deletions
diff --git a/docs/man/nng_http_conn_write_req.adoc b/docs/man/nng_http_conn_write_req.adoc
new file mode 100644
index 00000000..040764ca
--- /dev/null
+++ b/docs/man/nng_http_conn_write_req.adoc
@@ -0,0 +1,62 @@
+= nng_http_conn_write_req(3)
+//
+// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
+// Copyright 2018 Capitar IT Group BV <info@capitar.com>
+//
+// This document is supplied under the terms of the MIT License, a
+// copy of which should be located in the distribution where this
+// file was obtained (LICENSE.txt). A copy of the license may also be
+// found online at https://opensource.org/licenses/MIT.
+//
+
+== NAME
+
+nng_http_conn_write_req - write HTTP request
+
+== SYNOPSIS
+
+[source, c]
+-----------
+#include <nng/nng.h>
+#include <nng/supplemental/http/http.h>
+
+void nng_http_conn_write_req(nng_http_conn *conn, nng_http_req *req,
+ nng_aio *aio);
+-----------
+
+== DESCRIPTION
+
+The `nng_http_conn_write_req()` function starts an asynchronous write of
+the HTTP request _req_ to the connection _conn_. The entire request is sent,
+including headers, and if present, the request body data. (The
+request body can be set with
+<<nng_http_req_set_data#,nng_http_req_set_data>> or
+<<nng_http_req_copy_data#,nng_http_req_copy_data>>.)
+
+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#,nng_aio_result>>. That result will
+either be zero or an error code.
+
+== RETURN VALUES
+
+None.
+
+== ERRORS
+
+`NNG_ECANCELED`:: The operation was canceled.
+`NNG_ECLOSED`:: The connection was closed.
+`NNG_ECONNRESET`:: The peer closed the connection.
+`NNG_ENOMEM`:: Insufficient free memory to perform the operation.
+`NNG_ENOTSUP`:: HTTP operations are not supported.
+`NNG_ETIMEDOUT`:: Timeout waiting for data from the connection.
+
+== SEE ALSO
+
+<<nng_aio_alloc#,nng_aio_alloc(3)>>,
+<<nng_aio_result#,nng_aio_result(3)>>,
+<<nng_http_alloc_handler#,nng_http_alloc_handler(3)>>,
+<<nng_http_client_connect#,nng_http_client_connect(3)>>,
+<<nng_http_conn_read_all#,nng_http_conn_read_all(3)>>,
+<<nng_strerror#,nng_strerror(3)>>,
+<<nng#,nng(7)>>