mirror of
https://github.com/zeromq/libzmq.git
synced 2025-01-14 01:37:56 +08: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
82 lines
2.6 KiB
Plaintext
82 lines
2.6 KiB
Plaintext
= zmq_inproc(7)
|
|
|
|
|
|
== NAME
|
|
zmq_inproc - 0MQ local in-process (inter-thread) communication transport
|
|
|
|
|
|
== SYNOPSIS
|
|
The in-process transport passes messages via memory directly between threads
|
|
sharing a single 0MQ 'context'.
|
|
|
|
NOTE: No I/O threads are involved in passing messages using the 'inproc'
|
|
transport. Therefore, if you are using a 0MQ 'context' for in-process messaging
|
|
only you can initialise the 'context' with zero I/O threads. See
|
|
xref:zmq_init.adoc[zmq_init] for details.
|
|
|
|
|
|
== 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 in-process transport, the transport is `inproc`, and the meaning of
|
|
the 'address' part is defined below.
|
|
|
|
|
|
Assigning a local address to a socket
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
When assigning a local address to a 'socket' using _zmq_bind()_ with the
|
|
'inproc' transport, the 'endpoint' shall be interpreted as an arbitrary string
|
|
identifying the 'name' to create. The 'name' must be unique within the 0MQ
|
|
'context' associated with the 'socket' and may be up to 256 characters in
|
|
length. No other restrictions are placed on the format of the 'name'.
|
|
|
|
|
|
Connecting a socket
|
|
~~~~~~~~~~~~~~~~~~~
|
|
When connecting a 'socket' to a peer address using _zmq_connect()_ with the
|
|
'inproc' transport, the 'endpoint' shall be interpreted as an arbitrary string
|
|
identifying the 'name' to connect to. Before version 4.0 he 'name' must have
|
|
been previously created by assigning it to at least one 'socket' within the
|
|
same 0MQ 'context' as the 'socket' being connected. Since version 4.0 the
|
|
order of _zmq_bind()_ and _zmq_connect()_ does not matter just like for the tcp
|
|
transport type.
|
|
|
|
|
|
== EXAMPLES
|
|
.Assigning a local address to a socket
|
|
----
|
|
// Assign the in-process name "#1"
|
|
rc = zmq_bind(socket, "inproc://#1");
|
|
assert (rc == 0);
|
|
// Assign the in-process name "my-endpoint"
|
|
rc = zmq_bind(socket, "inproc://my-endpoint");
|
|
assert (rc == 0);
|
|
----
|
|
|
|
.Connecting a socket
|
|
----
|
|
// Connect to the in-process name "#1"
|
|
rc = zmq_connect(socket, "inproc://#1");
|
|
assert (rc == 0);
|
|
// Connect to the in-process name "my-endpoint"
|
|
rc = zmq_connect(socket, "inproc://my-endpoint");
|
|
assert (rc == 0);
|
|
----
|
|
|
|
|
|
== SEE ALSO
|
|
xref:zmq_bind.adoc[zmq_bind]
|
|
xref:zmq_connect.adoc[zmq_connect]
|
|
xref:zmq_ipc.adoc[zmq_ipc]
|
|
xref:zmq_tcp.adoc[zmq_tcp]
|
|
xref:zmq_pgm.adoc[zmq_pgm]
|
|
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>.
|