Skip to content

Commit

Permalink
more link fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
f18m committed Oct 23, 2023
1 parent 1d4ee8c commit d319154
Show file tree
Hide file tree
Showing 71 changed files with 496 additions and 496 deletions.
118 changes: 59 additions & 59 deletions doc/zmq.adoc
Expand Up @@ -38,15 +38,15 @@ you exit your application you must destroy the 'context'. These functions let
you work with 'contexts':

Create a new 0MQ context::
xref:zmq_ctx_new.adoc
* link:zmq_ctx_new.html[zmq_ctx_new]

Work with context properties::
xref:zmq_ctx_set.adoc
xref:zmq_ctx_get.adoc
* link:zmq_ctx_set.html[zmq_ctx_set]
* link:zmq_ctx_get.html[zmq_ctx_get]

Destroy a 0MQ context::
xref:zmq_ctx_shutdown.adoc
xref:zmq_ctx_term.adoc
* link:zmq_ctx_shutdown.html[zmq_ctx_shutdown]
* link:zmq_ctx_term.html[zmq_ctx_term]

Thread safety
^^^^^^^^^^^^^
Expand Down Expand Up @@ -80,73 +80,73 @@ data.
The following functions are provided to work with messages:

Initialise a message::
xref:zmq_msg_init.adoc
xref:zmq_msg_init_size.adoc
xref:zmq_msg_init_buffer.adoc
xref:zmq_msg_init_data.adoc
* link:zmq_msg_init.html[zmq_msg_init]
* link:zmq_msg_init_size.html[zmq_msg_init_size]
* link:zmq_msg_init_buffer.html[zmq_msg_init_buffer]
* link:zmq_msg_init_data.html[zmq_msg_init_data]

Sending and receiving a message::
xref:zmq_msg_send.adoc
xref:zmq_msg_recv.adoc
* link:zmq_msg_send.html[zmq_msg_send]
* link:zmq_msg_recv.html[zmq_msg_recv]

Release a message::
xref:zmq_msg_close.adoc
* link:zmq_msg_close.html[zmq_msg_close]

Access message content::
xref:zmq_msg_data.adoc
xref:zmq_msg_size.adoc
xref:zmq_msg_more.adoc
* link:zmq_msg_data.html[zmq_msg_data]
* link:zmq_msg_size.html[zmq_msg_size]
* link:zmq_msg_more.html[zmq_msg_more]

Work with message properties::
xref:zmq_msg_gets.adoc
xref:zmq_msg_get.adoc
xref:zmq_msg_set.adoc
* link:zmq_msg_gets.html[zmq_msg_gets]
* link:zmq_msg_get.html[zmq_msg_get]
* link:zmq_msg_set.html[zmq_msg_set]

Message manipulation::
xref:zmq_msg_copy.adoc
xref:zmq_msg_move.adoc
* link:zmq_msg_copy.html[zmq_msg_copy]
* link:zmq_msg_move.html[zmq_msg_move]


Sockets
~~~~~~~
0MQ sockets present an abstraction of an asynchronous _message queue_, with the
exact queueing semantics depending on the socket type in use. See
xref:zmq_socket.adoc for the socket types provided.
link:zmq_socket.html[zmq_socket] for the socket types provided.

The following functions are provided to work with sockets:

Creating a socket::
xref:zmq_socket.adoc
* link:zmq_socket.html[zmq_socket]

Closing a socket::
xref:zmq_close.adoc
* link:zmq_close.html[zmq_close]

Manipulating socket options::
xref:zmq_getsockopt.adoc
xref:zmq_setsockopt.adoc
* link:zmq_getsockopt.html[zmq_getsockopt]
* link:zmq_setsockopt.html[zmq_setsockopt]

Establishing a message flow::
xref:zmq_bind.adoc
xref:zmq_connect.adoc
* link:zmq_bind.html[zmq_bind]
* link:zmq_connect.html[zmq_connect]

Sending and receiving messages::
xref:zmq_msg_send.adoc
xref:zmq_msg_recv.adoc
xref:zmq_send.adoc
xref:zmq_recv.adoc
xref:zmq_send_const.adoc
* link:zmq_msg_send.html[zmq_msg_send]
* link:zmq_msg_recv.html[zmq_msg_recv]
* link:zmq_send.html[zmq_send]
* link:zmq_recv.html[zmq_recv]
* link:zmq_send_const.html[zmq_send_const]

Monitoring socket events::
xref:zmq_socket_monitor.adoc
* link:zmq_socket_monitor.html[zmq_socket_monitor]

.Input/output multiplexing
0MQ provides a mechanism for applications to multiplex input/output events over
a set containing both 0MQ sockets and standard sockets. This mechanism mirrors
the standard _poll()_ system call, and is described in detail in
xref:zmq_poll.adoc. This API is deprecated, however.
link:zmq_poll.html[zmq_poll] This API is deprecated, however.

There is a new DRAFT API with multiple zmq_poller_* function, which is described
in xref:zmq_poller.adoc.
in link:zmq_poller.html[zmq_poller]


Transports
Expand All @@ -158,30 +158,30 @@ advantages and drawbacks.
The following transport mechanisms are provided:

Unicast transport using TCP::
xref:zmq_tcp.adoc
* link:zmq_tcp.html[zmq_tcp]

Reliable multicast transport using PGM::
xref:zmq_pgm.adoc
* link:zmq_pgm.html[zmq_pgm]

Local inter-process communication transport::
xref:zmq_ipc.adoc
* link:zmq_ipc.html[zmq_ipc]

Local in-process (inter-thread) communication transport::
xref:zmq_inproc.adoc
* link:zmq_inproc.html[zmq_inproc]

Virtual Machine Communications Interface (VMC) transport::
xref:zmq_vmci.adoc
* link:zmq_vmci.html[zmq_vmci]

Unreliable unicast and multicast using UDP::
xref:zmq_udp.adoc
* link:zmq_udp.html[zmq_udp]


Proxies
~~~~~~~
0MQ provides 'proxies' to create fanout and fan-in topologies. A proxy connects
a 'frontend' socket to a 'backend' socket and switches all messages between the
two sockets, opaquely. A proxy may optionally capture all traffic to a third
socket. To start a proxy in an application thread, use xref:zmq_proxy.adoc.
socket. To start a proxy in an application thread, use link:zmq_proxy.html[zmq_proxy]


Security
Expand All @@ -192,23 +192,23 @@ security mechanism.
The following security mechanisms are provided for IPC and TCP connections:

Null security::
xref:zmq_null.adoc
* link:zmq_null.html[zmq_null]

Plain-text authentication using username and password::
xref:zmq_plain.adoc
* link:zmq_plain.html[zmq_plain]

Elliptic curve authentication and encryption::
xref:zmq_curve.adoc
* link:zmq_curve.html[zmq_curve]

Generate a CURVE keypair in armored text format::
xref:zmq_curve_keypair.adoc
* link:zmq_curve_keypair.html[zmq_curve_keypair]

Derive a CURVE public key from a secret key:
xref:zmq_curve_public.adoc
Derive a CURVE public key from a secret key::
* link:zmq_curve_public.html[zmq_curve_public]

Converting keys to/from armoured text strings::
xref:zmq_z.adoc85_decode
xref:zmq_z.adoc85_encode
* link:zmq_z85_decode.html[zmq_z85_decode]
* link:zmq_z85_encode.html[zmq_z85_encode]


ERROR HANDLING
Expand All @@ -221,31 +221,31 @@ shall return either a NULL value (if returning a pointer) or a negative value

On non-POSIX systems some users may experience issues with retrieving the
correct value of the 'errno' variable. The _zmq_errno()_ function is provided
to assist in these cases; for details refer to xref:zmq_errno.adoc.
to assist in these cases; for details refer to link:zmq_errno.html[zmq_errno]

The _zmq_strerror()_ function is provided to translate 0MQ-specific error codes
into error message strings; for details refer to xref:zmq_strerror.adoc.
into error message strings; for details refer to link:zmq_strerror.html[zmq_strerror]


UTILITY
-------
The following utility functions are provided:

Working with atomic counters::
xref:zmq_atomic_counter_new.adoc
xref:zmq_atomic_counter_set.adoc
xref:zmq_atomic_counter_inc.adoc
xref:zmq_atomic_counter_dec.adoc
xref:zmq_atomic_counter_value.adoc
xref:zmq_atomic_counter_destroy.adoc
* link:zmq_atomic_counter_new.html[zmq_atomic_counter_new]
* link:zmq_atomic_counter_set.html[zmq_atomic_counter_set]
* link:zmq_atomic_counter_inc.html[zmq_atomic_counter_inc]
* link:zmq_atomic_counter_dec.html[zmq_atomic_counter_dec]
* link:zmq_atomic_counter_value.html[zmq_atomic_counter_value]
* link:zmq_atomic_counter_destroy.html[zmq_atomic_counter_destroy]


MISCELLANEOUS
-------------
The following miscellaneous functions are provided:

Report 0MQ library version::
xref:zmq_version.adoc
* link:zmq_version.html[zmq_version]


LANGUAGE BINDINGS
Expand Down
10 changes: 5 additions & 5 deletions doc/zmq_atomic_counter_dec.adoc
Expand Up @@ -49,11 +49,11 @@ return 0;

SEE ALSO
--------
xref:zmq_atomic_counter_new.adoc
xref:zmq_atomic_counter_set.adoc
xref:zmq_atomic_counter_inc.adoc
xref:zmq_atomic_counter_value.adoc
xref:zmq_atomic_counter_destroy.adoc
link:zmq_atomic_counter_new.html[zmq_atomic_counter_new]
link:zmq_atomic_counter_set.html[zmq_atomic_counter_set]
link:zmq_atomic_counter_inc.html[zmq_atomic_counter_inc]
link:zmq_atomic_counter_value.html[zmq_atomic_counter_value]
link:zmq_atomic_counter_destroy.html[zmq_atomic_counter_destroy]


AUTHORS
Expand Down
10 changes: 5 additions & 5 deletions doc/zmq_atomic_counter_destroy.adoc
Expand Up @@ -49,11 +49,11 @@ return 0;
SEE ALSO
--------
xref:zmq_atomic_counter_new.adoc
xref:zmq_atomic_counter_set.adoc
xref:zmq_atomic_counter_inc.adoc
xref:zmq_atomic_counter_dec.adoc
xref:zmq_atomic_counter_value.adoc
link:zmq_atomic_counter_new.html[zmq_atomic_counter_new]
link:zmq_atomic_counter_set.html[zmq_atomic_counter_set]
link:zmq_atomic_counter_inc.html[zmq_atomic_counter_inc]
link:zmq_atomic_counter_dec.html[zmq_atomic_counter_dec]
link:zmq_atomic_counter_value.html[zmq_atomic_counter_value]
AUTHORS
Expand Down
10 changes: 5 additions & 5 deletions doc/zmq_atomic_counter_inc.adoc
Expand Up @@ -48,11 +48,11 @@ return 0;

SEE ALSO
--------
xref:zmq_atomic_counter_new.adoc
xref:zmq_atomic_counter_set.adoc
xref:zmq_atomic_counter_dec.adoc
xref:zmq_atomic_counter_value.adoc
xref:zmq_atomic_counter_destroy.adoc
link:zmq_atomic_counter_new.html[zmq_atomic_counter_new]
link:zmq_atomic_counter_set.html[zmq_atomic_counter_set]
link:zmq_atomic_counter_dec.html[zmq_atomic_counter_dec]
link:zmq_atomic_counter_value.html[zmq_atomic_counter_value]
link:zmq_atomic_counter_destroy.html[zmq_atomic_counter_destroy]


AUTHORS
Expand Down
10 changes: 5 additions & 5 deletions doc/zmq_atomic_counter_new.adoc
Expand Up @@ -49,11 +49,11 @@ return 0;

SEE ALSO
--------
xref:zmq_atomic_counter_set.adoc
xref:zmq_atomic_counter_inc.adoc
xref:zmq_atomic_counter_dec.adoc
xref:zmq_atomic_counter_value.adoc
xref:zmq_atomic_counter_destroy.adoc
link:zmq_atomic_counter_set.html[zmq_atomic_counter_set]
link:zmq_atomic_counter_inc.html[zmq_atomic_counter_inc]
link:zmq_atomic_counter_dec.html[zmq_atomic_counter_dec]
link:zmq_atomic_counter_value.html[zmq_atomic_counter_value]
link:zmq_atomic_counter_destroy.html[zmq_atomic_counter_destroy]


AUTHORS
Expand Down
10 changes: 5 additions & 5 deletions doc/zmq_atomic_counter_set.adoc
Expand Up @@ -48,11 +48,11 @@ return 0;

SEE ALSO
--------
xref:zmq_atomic_counter_new.adoc
xref:zmq_atomic_counter_inc.adoc
xref:zmq_atomic_counter_dec.adoc
xref:zmq_atomic_counter_value.adoc
xref:zmq_atomic_counter_destroy.adoc
link:zmq_atomic_counter_new.html[zmq_atomic_counter_new]
link:zmq_atomic_counter_inc.html[zmq_atomic_counter_inc]
link:zmq_atomic_counter_dec.html[zmq_atomic_counter_dec]
link:zmq_atomic_counter_value.html[zmq_atomic_counter_value]
link:zmq_atomic_counter_destroy.html[zmq_atomic_counter_destroy]


AUTHORS
Expand Down
10 changes: 5 additions & 5 deletions doc/zmq_atomic_counter_value.adoc
Expand Up @@ -49,11 +49,11 @@ return 0;

SEE ALSO
--------
xref:zmq_atomic_counter_new.adoc
xref:zmq_atomic_counter_set.adoc
xref:zmq_atomic_counter_inc.adoc
xref:zmq_atomic_counter_dec.adoc
xref:zmq_atomic_counter_destroy.adoc
link:zmq_atomic_counter_new.html[zmq_atomic_counter_new]
link:zmq_atomic_counter_set.html[zmq_atomic_counter_set]
link:zmq_atomic_counter_inc.html[zmq_atomic_counter_inc]
link:zmq_atomic_counter_dec.html[zmq_atomic_counter_dec]
link:zmq_atomic_counter_destroy.html[zmq_atomic_counter_destroy]


AUTHORS
Expand Down
26 changes: 13 additions & 13 deletions doc/zmq_bind.adoc
Expand Up @@ -23,28 +23,28 @@ The 'endpoint' is a string consisting of a 'transport'`://` followed by an

0MQ provides the the following transports:

'tcp':: unicast transport using TCP, see xref:zmq_tcp.adoc
'ipc':: local inter-process communication transport, see xref:zmq_ipc.adoc
'inproc':: local in-process (inter-thread) communication transport, see xref:zmq_inproc.adoc
'pgm', 'epgm':: reliable multicast transport using PGM, see xref:zmq_pgm.adoc
'vmci':: virtual machine communications interface (VMCI), see xref:zmq_vmci.adoc
'udp':: unreliable unicast and multicast using UDP, see xref:zmq_udp.adoc
'tcp':: unicast transport using TCP, see link:zmq_tcp.html[zmq_tcp]
'ipc':: local inter-process communication transport, see link:zmq_ipc.html[zmq_ipc]
'inproc':: local in-process (inter-thread) communication transport, see link:zmq_inproc.html[zmq_inproc]
'pgm', 'epgm':: reliable multicast transport using PGM, see link:zmq_pgm.html[zmq_pgm]
'vmci':: virtual machine communications interface (VMCI), see link:zmq_vmci.html[zmq_vmci]
'udp':: unreliable unicast and multicast using UDP, see link:zmq_udp.html[zmq_udp]

Every 0MQ socket type except 'ZMQ_PAIR' and 'ZMQ_CHANNEL' supports one-to-many and many-to-one
semantics. The precise semantics depend on the socket type and are defined in
xref:zmq_socket.adoc.
link:zmq_socket.html[zmq_socket]

The 'ipc', 'tcp', 'vmci' and 'udp' transports accept wildcard addresses: see
xref:zmq_ipc.adoc, xref:zmq_tcp.adoc, xref:zmq_vmci.adoc and
xref:zmq_udp.adoc for details.
link:zmq_ipc.html[zmq_ipc], link:zmq_tcp.html[zmq_tcp], link:zmq_vmci.html[zmq_vmci] and
link:zmq_udp.html[zmq_udp] for details.

NOTE: the address syntax may be different for _zmq_bind()_ and _zmq_connect()_
especially for the 'tcp', 'pgm' and 'epgm' transports.

NOTE: following a _zmq_bind()_, the socket enters a 'mute' state unless or
until at least one incoming or outgoing connection is made, at which point
the socket enters a 'ready' state. In the mute state, the socket blocks or
drops messages according to the socket type, as defined in xref:zmq_socket.adoc.
drops messages according to the socket type, as defined in link:zmq_socket.html[zmq_socket]
By contrast, following a libzmq:zmq_connect, the socket enters the 'ready' state.


Expand Down Expand Up @@ -94,9 +94,9 @@ assert (rc == 0);

SEE ALSO
--------
xref:zmq_connect.adoc
xref:zmq_socket.adoc
xref:zmq.adoc
link:zmq_connect.html[zmq_connect]
link:zmq_socket.html[zmq_socket]
link:zmq.html[zmq]


AUTHORS
Expand Down

0 comments on commit d319154

Please sign in to comment.