← Back to branch summary

~ubuntu-branches/ubuntu/maverick/zeromq/maverick

« back to all changes in this revision

Viewing changes to doc/zmq_close.3

  • Committer: Bazaar Package Importer
  • Author(s): Adrian von Bidder
  • Date: 2010-03-17 10:43:40 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20100317104340-un1ne0oqe16w8eaq
Tags: 2.0.6beta.dfsg-1
http://bugs.debian.org/567513
http://bugs.debian.org/567848
* New upstream version.
  - Source doesn't include non-C/C++ language bindings anymore.
  - New versioning: 2.0.6 is official upstream version which is a beta.
* Repacked orig tar: removed non-free RFC documents (closes: #567513)
* Improved/corrected description and copyright file, added bzip2 build
  dependency.  Thanks to feedback from zeromq mailing list.
* Disable OpenPGM on non-x86 architectures (closes: #567848)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/zmq_close.3
 
1
'\" t
 
2
.\"     Title: zmq_close
 
3
.\"    Author: [see the "AUTHORS" section]
 
4
.\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
 
5
.\"      Date: 03/16/2010
 
6
.\"    Manual: 0MQ Manual
 
7
.\"    Source: 0MQ 2.0.6
 
8
.\"  Language: English
 
9
.\"
 
10
.TH "ZMQ_CLOSE" "3" "03/16/2010" "0MQ 2\&.0\&.6" "0MQ Manual"
 
11
.\" -----------------------------------------------------------------
 
12
.\" * set default formatting
 
13
.\" -----------------------------------------------------------------
 
14
.\" disable hyphenation
 
15
.nh
 
16
.\" disable justification (adjust text to left margin only)
 
17
.ad l
 
18
.\" -----------------------------------------------------------------
 
19
.\" * MAIN CONTENT STARTS HERE *
 
20
.\" -----------------------------------------------------------------
 
21
.SH "NAME"
 
22
zmq_close \- close 0MQ socket
 
23
.SH "SYNOPSIS"
 
24
.sp
 
25
\fBint zmq_close (void \fR\fB\fI*socket\fR\fR\fB);\fR
 
26
.SH "DESCRIPTION"
 
27
.sp
 
28
The \fIzmq_close()\fR function shall destroy the socket referenced by the \fIsocket\fR argument\&. All active connections on the socket shall be terminated and resources associated with the socket shall be released\&. Any outstanding messages sent with \fIzmq_send()\fR but not yet physically sent to the network shall be dropped\&. Likewise, any outstanding messages physically received from the network but not yet received by the application with \fIzmq_recv()\fR shall also be dropped\&.
 
29
.SH "RETURN VALUE"
 
30
.sp
 
31
The \fIzmq_close()\fR function shall return zero if successful\&. Otherwise it shall return \-1 and set \fIerrno\fR to one of the values defined below\&.
 
32
.SH "ERRORS"
 
33
.sp
 
34
No errors are defined\&.
 
35
.SH "SEE ALSO"
 
36
.sp
 
37
\fBzmq_socket\fR(3) \fBzmq_term\fR(3) \fBzmq\fR(7)
 
38
.SH "AUTHORS"
 
39
.sp
 
40
The 0MQ documentation was written by Martin Sustrik <\m[blue]\fBsustrik@250bpm\&.com\fR\m[]\&\s-2\u[1]\d\s+2> and Martin Lucina <\m[blue]\fBmato@kotelna\&.sk\fR\m[]\&\s-2\u[2]\d\s+2>\&.
 
41
.SH "NOTES"
 
42
.IP " 1." 4
 
43
sustrik@250bpm.com
 
44
.RS 4
 
45
\%mailto:sustrik@250bpm.com
 
46
.RE
 
47
.IP " 2." 4
 
48
mato@kotelna.sk
 
49
.RS 4
 
50
\%mailto:mato@kotelna.sk
 
51
.RE