libnng(3)

Applications desiring to use the richest part of libnng will want to +use the message API, where a message structure is passed between functions. +This API provides the most power support for zero-copy.

Messages are divided into a header and body, where the body generally carries +user-payload and the header carries protocol specific header information. +Most applications will only interact with the body.

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

nng_msg_alloc(3)

allocate a message

nng_msg_append(3)

append to message body

nng_msg_body(3)

return message body

nng_msg_chop(3)

remove data from end of message body

clear message body

duplicate a message

free a message

prepend to message body

nng_msg_len(3)

return the message body length

nng_msg_realloc(3)

reallocate a message

nng_msg_trim(3)

remove data from start of message body

nng_recvmsg(3)

receive a message

nng_sendmsg(3)

send a message

Message Header Handling

+ + + + + +

+ +	+Few applications will need these functions, as message headers are only +used to carry protocol-specific content. However, applications which use raw +mode may need to access the header of messages. +

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

nng_msg_header(3)

return message header

nng_msg_header_append(3)

append to message header

nng_msg_header_chop(3)

remove data from end of message header

nng_msg_header_clear(3)

clear message header

nng_msg_header_insert(3)

prepend to message header

nng_msg_header_len(3)

return the message header length

nng_msg_header_trim(3)

remove data from start of message header

Asynchronous Operations

Most applications will interact with nng synchronously; that is that +functions such as nng_send(3) will block the calling +thread until the operation has completed.

+ + + + + +

+ +	+Synchronous operations which send messages may return before the +message has actually been received, or even transmitted. Instead, These +functions return as soon as the message was successfully queued for +delivery. +

Asynchronous operations behave differently. These operations are +initiated by the calling thread, but control returns immediately to +the calling thread. When the operation is subsequently completed (regardless +of whether this was successful or not), then a user supplied function +("callback") is executed.

A context structure, called an aio, is allocated and associated for +each asynchronous operation. Only a single asynchronous operation may +be associated with an aio at any time.

The following functions are used in the asynchronous model:

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

nng_aio_abort(3)

abort asynchronous I/O operation

nng_aio_alloc(3)

allocate asynchronous I/O handle

nng_aio_cancel(3)

cancel asynchronous I/O operation

nng_aio_count(3)

return number of bytes transferred

nng_aio_finish(3)

finish an asynchronous I/O operation

nng_aio_free(3)

free asynchronous I/O handle

nng_aio_get_input(3)

return input parameter

nng_aio_get_msg(3)

get message from an asynchronous receive

nng_aio_get_output(3)

return output result

nng_aio_result(3)

return result of asynchronous operation

nng_aio_set_input(3)

set input parameter

nng_aio_set_iov(3)

set scatter/gather vector

nng_aio_set_msg(3)

set message for an asynchronous send

nng_aio_set_output(3)

set output result

nng_aio_set_timeout(3)

set asynchronous I/O timeout

nng_aio_stop(3)

stop asynchronous I/O operation

nng_aio_wait(3)

wait for asynchronous I/O operation

nng_recv_aio(3)

receive message asynchronously

nng_send_aio(3)

send message asynchronously

Protocols

The following functions are used to construct a socket with a specific +protocol:

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

open a bus socket

open a pair socket

open a pub socket

open a pull socket

open a push socket

open a rep socket

open a req socket

nng_respondent_open(3)

open a respondent socket

nng_sub_open(3)

open a sub socket

nng_surveyor_open(3)

open a surveyor socket

Transports

The following functions are used to register a transport for use.

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

nng_inproc_register(3)

nng_zerotier_register(3)

URL Object

Common functionality is supplied for parsing and handling +universal resource locators (URLS).

+ ++++ + + + + + + + + + + + + + + +

nng_url_clone(3)

clone URL structure

nng_url_free(3)

free URL structure

nng_url_parse(3)

create URL structure from string

HTTP Support

The library may be configured with support for HTTP, and this will +be the case if WebSocket support is configured as well. In this case, +it is possible to access functionality to support the creation of +HTTP (and HTTP/S if TLS support is present) servers and clients.

Common HTTP Functions

The following functions are used to work with HTTP requests, responses, +and connections.

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

nng_http_conn_close(3)

close HTTP connection

nng_http_conn_read(3)

read from HTTP connection

nng_http_conn_read_all(3)

read all from HTTP connection

nng_http_conn_read_req(3)

read HTTP request

nng_http_conn_read_req(3)

read HTTP response

nng_http_conn_write(3)

write to HTTP connection

nng_http_conn_write_all(3)

write all to HTTP connection

nng_http_conn_write(3)

write HTTP request

nng_http_conn_write(3)

write HTTP response

nng_http_req_add_header(3)

add HTTP request header

nng_http_req_alloc(3)

allocate HTTP request structure

nng_http_req_copy_data(3)

copy HTTP request body

nng_http_req_del_header(3)

delete HTTP request header

nng_http_req_free(3)

free HTTP request structure

nng_http_req_get_header(3)

return HTTP request header

nng_http_req_get_method(3)

return HTTP request method

nng_http_req_get_uri(3)

return HTTP request URI

nng_http_req_get_version(3)

return HTTP request protocol version

nng_http_req_set_data(3)

set HTTP request body

nng_http_req_set_header(3)

set HTTP request header

nng_http_req_set_method(3)

set HTTP request method

nng_http_req_set_uri(3)

set HTTP request URI

nng_http_req_set_version(3)

set HTTP request protocol version

nng_http_res_add_header(3)

add HTTP response header

nng_http_res_alloc(3)

allocate HTTP response structure

nng_http_res_alloc_error(3)

allocate HTTP error response

nng_http_res_copy_data(3)

copy HTTP response body

nng_http_res_del_header(3)

delete HTTP response header

nng_http_res_free(3)

free HTTP response structure

nng_http_res_set_data(3)

set HTTP response body

nng_http_res_get_header(3)

return HTTP response header

nng_http_res_get_reason(3)

return HTTP response reason

nng_http_res_get_status(3)

return HTTP response status

nng_http_res_get_version(3)

return HTTP response protocol version

nng_http_res_set_header(3)

set HTTP response header

nng_http_res_set_reason(3)

set HTTP response reason

nng_http_res_set_status(3)

set HTTP response status

nng_http_res_set_version(3)

set HTTP response protocol version

HTTP Client Functions

These functions are intended for use with HTTP client applications.

+ ++++ + + + + + + + + + + + + + + + + + + + + + + +

nng_http_client_alloc(3)

allocate HTTP client

nng_http_client_connect(3)

establish HTTP client connection

nng_http_client_free(3)

free HTTP client

nng_http_client_get_tls(3)

get HTTP client TLS configuration

nng_http_client_set_tls(3)

set HTTP client TLS configuration

HTTP Server Functions

These functions are intended for use with HTTP server applications.

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

nng_http_handler_alloc(3)

allocate HTTP server handler

nng_http_handler_free(3)

free HTTP server handler

nng_http_handler_get_data(3)

return extra data for HTTP handler

nng_http_handler_set_data(3)

set extra data for HTTP handler

nng_http_handler_set_host(3)

set host for HTTP handler

nng_http_handler_set_method(3)

set HTTP handler method

nng_http_handler_set_tree(3)

set HTTP handler to match trees

nng_http_hijack(3)

hijack HTTP server connection

nng_http_server_add_handler(3)

add HTTP server handler

nng_http_server_del_handler(3)

delete HTTP server handler

nng_http_server_get_tls(3)

get HTTP server TLS configuration

nng_http_server_get_tls(3)

get and hold HTTP server instance

nng_http_server_get_tls(3)

release HTTP server instance

nng_http_server_set_tls(3)

set HTTP server TLS configuration

nng_http_server_start(3)

start HTTP server

nng_http_server_stop(3)

stop HTTP server

TLS Configuration Objects

The following functions are used to manipulate transport layer security +(TLS) configuration objects.

+ + + + + +

+ +	+These functions will only be present if the library has been built +with TLS support. +

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

nng_tls_config_alloc(3)

allocate TLS configuration

nng_tls_config_auth_mode(3)

set authentication mode

nng_tls_config_ca_chain(3)

set certificate authority chain

nng_tls_config_ca_file(3)

load certificate authority from file

nng_tls_config_cert_key_file_cert(3)

load own certificate and key from file

nng_tls_config_own_cert(3)

set own certificate and key

nng_tls_config_free(3)

free TLS configuration

nng_tls_config_server_name(3)

set remote server name

libnng(3) Manual Page

NAME

SYNOPSIS

DESCRIPTION

Common Functions

Socket Functions

Connection Management

Message Handling Functions

Message Header Handling

Asynchronous Operations

Protocols

Transports

URL Object

HTTP Support

Common HTTP Functions

HTTP Client Functions

HTTP Server Functions

TLS Configuration Objects

SEE ALSO