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.
114 lines
3.6 KiB
114 lines
3.6 KiB
6 years ago
|
'\" t
|
||
|
|
.\" Title: zmq_disconnect
|
||
|
|
.\" 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_DISCONNECT" "3" "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_disconnect \- Disconnect a socket
|
||
|
|
.SH "SYNOPSIS"
|
||
|
|
.sp
|
||
|
|
\fBint zmq_disconnect (void \fR\fB\fI*socket\fR\fR\fB, const char \fR\fB\fI*endpoint\fR\fR\fB);\fR
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
.sp
|
||
|
|
The \fIzmq_disconnect()\fR function shall disconnect a socket specified by the \fIsocket\fR argument from the endpoint specified by the \fIendpoint\fR argument\&. Any outstanding messages physically received from the network but not yet received by the application with \fIzmq_recv()\fR shall be discarded\&. The behaviour for discarding messages sent by the application with \fIzmq_send()\fR but not yet physically transferred to the network depends on the value of the \fIZMQ_LINGER\fR socket option for the specified \fIsocket\fR\&.
|
||
|
|
.sp
|
||
|
|
The \fIendpoint\fR argument is as described in \fBzmq_connect\fR(3)
|
||
|
|
.if n \{\
|
||
|
|
.sp
|
||
|
|
.\}
|
||
|
|
.RS 4
|
||
|
|
.it 1 an-trap
|
||
|
|
.nr an-no-space-flag 1
|
||
|
|
.nr an-break-flag 1
|
||
|
|
.br
|
||
|
|
.ps +1
|
||
|
|
\fBNote\fR
|
||
|
|
.ps -1
|
||
|
|
.br
|
||
|
|
.sp
|
||
|
|
The default setting of \fIZMQ_LINGER\fR does not discard unsent messages; this behaviour may cause the application to block when calling \fIzmq_term()\fR\&. For details refer to \fBzmq_setsockopt\fR(3) and \fBzmq_term\fR(3)\&.
|
||
|
|
.sp .5v
|
||
|
|
.RE
|
||
|
|
.SH "RETURN VALUE"
|
||
|
|
.sp
|
||
|
|
The \fIzmq_disconnect()\fR function shall return zero if successful\&. Otherwise it shall return \-1 and set \fIerrno\fR to one of the values defined below\&.
|
||
|
|
.SH "ERRORS"
|
||
|
|
.PP
|
||
|
|
\fBEINVAL\fR
|
||
|
|
.RS 4
|
||
|
|
The endpoint supplied is invalid\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBETERM\fR
|
||
|
|
.RS 4
|
||
|
|
The 0MQ
|
||
|
|
\fIcontext\fR
|
||
|
|
associated with the specified
|
||
|
|
\fIsocket\fR
|
||
|
|
was terminated\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBENOTSOCK\fR
|
||
|
|
.RS 4
|
||
|
|
The provided
|
||
|
|
\fIsocket\fR
|
||
|
|
was invalid\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBENOENT\fR
|
||
|
|
.RS 4
|
||
|
|
The provided endpoint is not connected\&.
|
||
|
|
.RE
|
||
|
|
.SH "EXAMPLE"
|
||
|
|
.PP
|
||
|
|
\fBConnecting a subscriber socket to an in-process and a TCP transport\fR.
|
||
|
|
.sp
|
||
|
|
.if n \{\
|
||
|
|
.RS 4
|
||
|
|
.\}
|
||
|
|
.nf
|
||
|
|
/* Create a ZMQ_SUB socket */
|
||
|
|
void *socket = zmq_socket (context, ZMQ_SUB);
|
||
|
|
assert (socket);
|
||
|
|
/* Connect it to the host server001, port 5555 using a TCP transport */
|
||
|
|
rc = zmq_connect (socket, "tcp://server001:5555");
|
||
|
|
assert (rc == 0);
|
||
|
|
/* Disconnect from the previously connected endpoint */
|
||
|
|
rc = zmq_disconnect (socket, "tcp://server001:5555");
|
||
|
|
assert (rc == 0);
|
||
|
|
.fi
|
||
|
|
.if n \{\
|
||
|
|
.RE
|
||
|
|
.\}
|
||
|
|
.sp
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.sp
|
||
|
|
\fBzmq_connect\fR(3) \fBzmq_socket\fR(3) \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[]\&.
|