The following pages are present:
Section 1: Commands and Utilities
This section documents utilities and programs that are included with the distribution.
command line access to Scalabity Protocols |
Section 3: Library Functions
This section documents core libary functions that are callable by applications.
nanomsg next generation library |
|
abort asynchronous I/O operation |
|
allocate asynchronous I/O handle |
|
cancel asynchronous I/O operation |
|
return number of bytes transferred |
|
finish asynchronous I/O operation |
|
free asynchronous I/O handle |
|
return input parameter |
|
get message from asynchronous receive |
|
return output result |
|
return result of asynchronous operation |
|
set input parameter |
|
set scatter/gather vector |
|
set message for asynchronous send |
|
set output result |
|
set asynchronous I/O timeout |
|
stop asynchronous I/O operation |
|
wait for asynchronous I/O operation |
|
allocate memory |
|
create bus socket |
|
close socket |
|
send message |
|
create and start dialer |
|
close dialer |
|
create dialer |
|
get dialer option |
|
set dialer option |
|
start dialer |
|
free memory |
|
get socket option |
|
register inproc transport |
|
register ipc transport |
|
create and start listener |
|
close listener |
|
create listener |
|
get listener option |
|
set listener option |
|
start listener |
|
allocate a message |
|
append to message body |
|
return message body |
|
remove data from end of message body |
|
clear message body content |
|
duplicate a message |
|
free a message |
|
get pipe for message |
|
return message header |
|
append to message header |
|
remove data from end of message header |
|
clear message header |
|
prepend to message header |
|
return message header length |
|
remove data from start of message header |
|
prepend to message body |
|
return message body length |
|
reallocate a message |
|
set pipe for message |
|
remove data from start of message body |
|
create pair socket |
|
close pipe |
|
get pipe option |
|
create pub socket |
|
create pull socket |
|
create push socket |
|
recv data |
|
receive message asynchronously |
|
recv message |
|
create rep socket |
|
create rep socket |
|
create respondent socket |
|
send data |
|
send message asynchronously |
|
send message |
|
set socket option |
|
sleep asynchronously |
|
return an error description |
|
create sub socket |
|
create surveyor socket |
|
register tcp transport |
|
register tls transport |
|
clone URL structure |
|
free a URL structure |
|
create URL structure from a string |
|
report library version |
|
register websocket transport |
|
register websocket secure transport |
|
register ZeroTier transport |
Section 3compat: Compatible Library Functions
This section documents the nanomsg 1.0 libary compatible functions.
compatibility with nanomsg 1.0 |
Section 3http: Supplemental HTTP Functions
This section documents supplemental HTTP support functions that are available.
allocate HTTP client |
|
establish HTTP client connection |
|
free HTTP client |
|
get HTTP client TLS configuration |
|
set HTTP client TLS configuration |
|
close HTTP connection |
|
read from HTTP connection |
|
read all from HTTP connection |
|
read HTTP request |
|
read HTTP response |
|
write to HTTP connection |
|
write all to HTTP connection |
|
write HTTP request |
|
write HTTP response |
|
allocate HTTP server handler |
|
free HTTP server handler |
|
return extra data for HTTP handler |
|
set extra data for HTTP handler |
|
set host for HTTP handler |
|
set HTTP handler method |
|
set HTTP handler to match trees |
|
hijack HTTP server connection |
|
add HTTP request header |
|
allocate HTTP request structure |
|
copy HTTP request body |
|
set HTTP request header |
|
free HTTP request structure |
|
return HTTP request header |
|
return HTTP request method |
|
return HTTP request URI |
|
return HTTP request protocol version |
|
set HTTP request body |
|
set HTTP request header |
|
set HTTP request method |
|
set HTTP request URI |
|
set HTTP request protocol version |
|
add HTTP response header |
|
allocate HTTP response structure |
|
allocate HTTP error response |
|
copy HTTP response body |
|
set HTTP response header |
|
free HTTP response structure |
|
return HTTP response header |
|
return HTTP response reason |
|
return HTTP status code |
|
return HTTP response protocol version |
|
set HTTP response body |
|
set HTTP response header |
|
set HTTP response reason |
|
set HTTP response status |
|
set HTTP response protocol version |
|
add HTTP server handler |
|
delete HTTP server handler |
|
get HTTP server TLS configuration |
|
get and hold HTTP server instance |
|
release HTTP server instance |
|
set HTTP server TLS configuration |
|
start HTTP server |
|
stop HTTP server |
Section 3tls: Supplemental TLS Functions
This section documents supplemental TLS functions that are available.
allocate TLS configuration object |
|
configure authentication mode |
|
configure certificate authority certificate chain |
|
load certificate authority from file |
|
load own certificate and key from file |
|
deallocate a TLS configuration object |
|
configure own certificate and key |
|
configure remote server name |
Section 5: Macros and Types
This section documents core macros and types that are available.
asynchronous I/O handle |
|
dialer |
|
relative time in milliseconds |
|
scatter/gather element |
|
listener |
|
message |
|
socket, dialer, listener, and pipe options |
|
communications pipe |
|
socket address |
|
IPv4 socket address |
|
IPv6 socket address |
|
inproc socket address |
|
IPC socket address |
|
ZeroTier socket address |
|
socket handle |
Section 7: Protocols and Transports
This sections documents various protocols and transports that are available in the distribution.
nanomsg next generation |
|
bus protocol |
|
intra-process transport |
|
IPC transport |
|
pair protocol |
|
publisher protocol |
|
pull protocol |
|
push protocol |
|
reply protocol |
|
request protocol |
|
respondent protocol |
|
subscriber protocol |
|
surveyor protocol |
|
TCP/IP transport |
|
TLS transport |
|
WebSocket transport |
|
ZeroTier transport |