mirror of
https://github.com/zeromq/libzmq.git
synced 2025-01-19 08:46:44 +01:00
b6ca9b2983
* migrate from the old, unmaintained "asciidoc-py" tool to the new "asciidoctor" generator * migrate from asciidoc-py syntax to the modern Asciidoc syntax (especially page titles and section titles) * remove the need of "xmlto" utility to create the manpage output; use asciidoctor for that * add HTML output support to the doc/Makefile by using asciidoctor * change API documentation files extension from .txt to .adoc to make it more explicit that they are Asciidoc-encoded (as a bonus several IDE plugins will autodetect the .adoc format as Asciidoc) * remove asciidoc.conf: asciidoctor does not support that; this also required replacing the macro linkzmq into all documentation pages * add a new Github action CI do deploy to Github Pages the static HTMLs produced by Asciidoctors * removed references to the "xmlto" and "a2x" tools from the build and packaging systems: Asciidoctor can convert the documentation directly to e.g. pdf (via extended converters) and anyway there was no code/target for using "xmlto" and "a2x" tools anyway
77 lines
2.1 KiB
Plaintext
77 lines
2.1 KiB
Plaintext
= zmq_tipc(7)
|
|
|
|
|
|
== NAME
|
|
zmq_tipc - 0MQ unicast transport using TIPC
|
|
|
|
|
|
== SYNOPSIS
|
|
TIPC is a cluster IPC protocol with a location transparent addressing scheme.
|
|
|
|
|
|
== ADDRESSING
|
|
A 0MQ endpoint is a string consisting of a 'transport'`://` followed by an
|
|
'address'. The 'transport' specifies the underlying protocol to use. The
|
|
'address' specifies the transport-specific address to connect to.
|
|
|
|
For the TIPC transport, the transport is `tipc`, and the meaning of the
|
|
'address' part is defined below.
|
|
|
|
|
|
Assigning a port name to a socket
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
When assigning a port name to a socket using _zmq_bind()_ with the 'tipc'
|
|
transport, the 'endpoint' is defined in the form:
|
|
{type, lower, upper}
|
|
|
|
* Type is the numerical (u32) ID of your service.
|
|
* Lower and Upper specify a range for your service.
|
|
|
|
Publishing the same service with overlapping lower/upper ID's will
|
|
cause connection requests to be distributed over these in a round-robin
|
|
manner.
|
|
|
|
|
|
Connecting a socket
|
|
~~~~~~~~~~~~~~~~~~~
|
|
When connecting a socket to a peer address using _zmq_connect()_ with the 'tipc'
|
|
transport, the 'endpoint' shall be interpreted as a service ID, followed by a
|
|
comma and the instance ID.
|
|
|
|
The instance ID must be within the lower/upper range of a published port name
|
|
for the endpoint to be valid.
|
|
|
|
== EXAMPLES
|
|
.Assigning a local address to a socket
|
|
----
|
|
// Publish TIPC service ID 5555
|
|
rc = zmq_bind(socket, "tipc://{5555,0,0}");
|
|
assert (rc == 0);
|
|
// Publish TIPC service ID 5555 with a service range of 0-100
|
|
rc = zmq_bind(socket, "tipc://{5555,0,100}");
|
|
assert (rc == 0);
|
|
----
|
|
|
|
.Connecting a socket
|
|
----
|
|
// Connect to service 5555 instance id 50
|
|
rc = zmq_connect(socket, "tipc://{5555,50}");
|
|
assert (rc == 0);
|
|
----
|
|
|
|
|
|
== SEE ALSO
|
|
xref:zmq_bind.adoc[zmq_bind]
|
|
xref:zmq_connect.adoc[zmq_connect]
|
|
xref:zmq_tcp.adoc[zmq_tcp]
|
|
xref:zmq_pgm.adoc[zmq_pgm]
|
|
xref:zmq_ipc.adoc[zmq_ipc]
|
|
xref:zmq_inproc.adoc[zmq_inproc]
|
|
xref:zmq_vmci.adoc[zmq_vmci]
|
|
xref:zmq.adoc[zmq]
|
|
|
|
|
|
== AUTHORS
|
|
This page was written by the 0MQ community. To make a change please
|
|
read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>.
|