nng_http_conn_read(3http)

NNG_HTTP_CONN_READ(3http)

NNG Reference Manual

NNG_HTTP_CONN_READ(3http)

NAME

nng_http_conn_read - read from HTTP connection

SYNOPSIS

#include <nng/nng.h>
#include <nng/supplemental/http/http.h>
void nng_http_conn_read(nng_http_conn *conn, nng_aio *aio);

DESCRIPTION

The nng_http_conn_read() function starts an asynchronous read from the HTTP connection conn, into the scatter/gather vector located in the asynchronous I/O structure aio.

Note

The 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(). That result will either be zero or an error code.

The I/O operation completes as soon as at least one byte has been read, or an error has occurred. Therefore, the number of bytes read may be less than requested. The actual number of bytes read can be determined with nng_aio_count().

Tip

This function is intended to facilitate uses cases that involve changing
the protocol from HTTP, such as WebSocket. Most applications will never need to use this function.

RETURN VALUES

None.

ERRORS

NNG_ECANCELED

The operation was canceled.

NNG_ECLOSED

The connection was closed.

NNG_ECONNRESET

The peer closed the connection.

NNG_EINVAL

The aio does not contain a valid scatter/gather vector.

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.