open source driving agent
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

106 lines
3.4 KiB

'\" t
.\" Title: zmq_tipc
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 09/14/2016
.\" Manual: 0MQ Manual
.\" Source: 0MQ 4.1.5
.\" Language: English
.\"
.TH "ZMQ_TIPC" "7" "09/14/2016" "0MQ 4\&.1\&.5" "0MQ Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
zmq_tipc \- 0MQ unicast transport using TIPC
.SH "SYNOPSIS"
.sp
TIPC is a cluster IPC protocol with a location transparent addressing scheme\&.
.SH "ADDRESSING"
.sp
A 0MQ endpoint is a string consisting of a \fItransport\fR:// followed by an \fIaddress\fR\&. The \fItransport\fR specifies the underlying protocol to use\&. The \fIaddress\fR specifies the transport\-specific address to connect to\&.
.sp
For the TIPC transport, the transport is tipc, and the meaning of the \fIaddress\fR part is defined below\&.
.sp
Assigning a port name to a socket
.sp
.if n \{\
.RS 4
.\}
.nf
When assigning a port name to a socket using _zmq_bind()_ with the \*(Aqtipc\*(Aq
transport, the \*(Aqendpoint\*(Aq 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\*(Aqs will
cause connection requests to be distributed over these in a round\-robin
manner\&.
Connecting a socket
.fi
.if n \{\
.RE
.\}
.sp
When connecting a socket to a peer address using \fIzmq_connect()\fR with the \fItipc\fR transport, the \fIendpoint\fR shall be interpreted as a service ID, followed by a comma and the instance ID\&.
.sp
The instance ID must be within the lower/upper range of a published port name for the endpoint to be valid\&.
.SH "EXAMPLES"
.PP
\fBAssigning a local address to a socket\fR.
.sp
.if n \{\
.RS 4
.\}
.nf
// 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);
.fi
.if n \{\
.RE
.\}
.PP
\fBConnecting a socket\fR.
.sp
.if n \{\
.RS 4
.\}
.nf
// Connect to service 5555 instance id 50
rc = zmq_connect(socket, "tipc://{5555,50}");
assert (rc == 0);
.fi
.if n \{\
.RE
.\}
.sp
.SH "SEE ALSO"
.sp
\fBzmq_bind\fR(3) \fBzmq_connect\fR(3) \fBzmq_tcp\fR(7) \fBzmq_pgm\fR(7) \fBzmq_ipc\fR(7) \fBzmq_inproc\fR(7) \fBzmq\fR(7)
.SH "AUTHORS"
.sp
This page was written by the 0MQ community\&. To make a change please read the 0MQ Contribution Policy at \m[blue]\fBhttp://www\&.zeromq\&.org/docs:contributing\fR\m[]\&.