mirror of https://gitee.com/bigwinds/arangodb
125 lines
3.1 KiB
Groff
125 lines
3.1 KiB
Groff
'\" t
|
|
.\" Title: zmq_term
|
|
.\" Author: [see the "AUTHORS" section]
|
|
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
|
|
.\" Date: 04/04/2012
|
|
.\" Manual: 0MQ Manual
|
|
.\" Source: 0MQ 2.2.0
|
|
.\" Language: English
|
|
.\"
|
|
.TH "ZMQ_TERM" "3" "04/04/2012" "0MQ 2\&.2\&.0" "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_term \- terminate 0MQ context
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
\fBint zmq_term (void \fR\fB\fI*context\fR\fR\fB);\fR
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
The \fIzmq_term()\fR function shall terminate the 0MQ context \fIcontext\fR\&.
|
|
.sp
|
|
Context termination is performed in the following steps:
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04' 1.\h'+01'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP " 1." 4.2
|
|
.\}
|
|
Any blocking operations currently in progress on sockets open within
|
|
\fIcontext\fR
|
|
shall return immediately with an error code of ETERM\&. With the exception of
|
|
\fIzmq_close()\fR, any further operations on sockets open within
|
|
\fIcontext\fR
|
|
shall fail with an error code of ETERM\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04' 2.\h'+01'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP " 2." 4.2
|
|
.\}
|
|
After interrupting all blocking calls,
|
|
\fIzmq_term()\fR
|
|
shall
|
|
\fIblock\fR
|
|
until the following conditions are satisfied:
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
All sockets open within
|
|
\fIcontext\fR
|
|
have been closed with
|
|
\fIzmq_close()\fR\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
For each socket within
|
|
\fIcontext\fR, all messages sent by the application with
|
|
\fIzmq_send()\fR
|
|
have either been physically transferred to a network peer, or the socket\(cqs linger period set with the
|
|
\fIZMQ_LINGER\fR
|
|
socket option has expired\&.
|
|
.RE
|
|
.RE
|
|
.sp
|
|
For further details regarding socket linger behaviour refer to the \fIZMQ_LINGER\fR option in \fBzmq_setsockopt\fR(3)\&.
|
|
.SH "RETURN VALUE"
|
|
.sp
|
|
The \fIzmq_term()\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
|
|
\fBEFAULT\fR
|
|
.RS 4
|
|
The provided
|
|
\fIcontext\fR
|
|
was invalid\&.
|
|
.RE
|
|
.PP
|
|
\fBEINTR\fR
|
|
.RS 4
|
|
Termination was interrupted by a signal\&. It can be restarted if needed\&.
|
|
.RE
|
|
.SH "SEE ALSO"
|
|
.sp
|
|
\fBzmq\fR(7) \fBzmq_init\fR(3) \fBzmq_close\fR(3) \fBzmq_setsockopt\fR(3)
|
|
.SH "AUTHORS"
|
|
.sp
|
|
This manual page was written by the 0MQ community\&.
|