← Back to branch summary

~ubuntu-branches/ubuntu/trusty/zeromq3/trusty

« back to all changes in this revision

Viewing changes to doc/zmq_getsockopt.html

  • Committer: Package Import Robot
  • Author(s): Alessandro Ghedini
  • Date: 2012-06-12 10:53:58 UTC
  • mfrom: (1.1.1)
  • Revision ID: package-import@ubuntu.com-20120612105358-irh7e8ivwc4566fi
Tags: 3.2.0~rc1+dfsg-1
* New upstream RC release
* Use repack.{local,stub} instead of get-orig-source rule
* Add 01_fix-unused-variable-error.patch
* Remove build dependency on uuid-dev (no more needed)
* Add 02_check-ifdef-SO_NOSIGPIPE.patch to fix kfreebsd build
* Add 03_fix-test_shutdown_stress-segfault.patch

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/zmq_getsockopt.html
3
3
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4
4
<head>
5
5
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
6
 
<meta name="generator" content="AsciiDoc 8.6.3" />
 
6
<meta name="generator" content="AsciiDoc 8.6.4" />
7
7
<title>zmq_getsockopt(3)</title>
8
8
<style type="text/css">
9
9
/* Sans-serif font. */
394
394
  font-size: 0.9em;
395
395
}
396
396
 
 
397
span.aqua { color: aqua; }
 
398
span.black { color: black; }
 
399
span.blue { color: blue; }
 
400
span.fuchsia { color: fuchsia; }
 
401
span.gray { color: gray; }
 
402
span.green { color: green; }
 
403
span.lime { color: lime; }
 
404
span.maroon { color: maroon; }
 
405
span.navy { color: navy; }
 
406
span.olive { color: olive; }
 
407
span.purple { color: purple; }
 
408
span.red { color: red; }
 
409
span.silver { color: silver; }
 
410
span.teal { color: teal; }
 
411
span.white { color: white; }
 
412
span.yellow { color: yellow; }
 
413
 
 
414
span.aqua-background { background: aqua; }
 
415
span.black-background { background: black; }
 
416
span.blue-background { background: blue; }
 
417
span.fuchsia-background { background: fuchsia; }
 
418
span.gray-background { background: gray; }
 
419
span.green-background { background: green; }
 
420
span.lime-background { background: lime; }
 
421
span.maroon-background { background: maroon; }
 
422
span.navy-background { background: navy; }
 
423
span.olive-background { background: olive; }
 
424
span.purple-background { background: purple; }
 
425
span.red-background { background: red; }
 
426
span.silver-background { background: silver; }
 
427
span.teal-background { background: teal; }
 
428
span.white-background { background: white; }
 
429
span.yellow-background { background: yellow; }
 
430
 
 
431
span.big { font-size: 2em; }
 
432
span.small { font-size: 0.6em; }
397
433
/* Overrides for manpage documents */
398
434
h1 {
399
435
  padding-top: 0.5em;
1209
1245
<div class="paragraph"><p>The <em>ZMQ_RECONNECT_IVL</em> option shall retrieve the initial reconnection interval
1210
1246
for the specified <em>socket</em>.  The reconnection interval is the period ØMQ shall
1211
1247
wait between attempts to reconnect disconnected peers when using
1212
 
connection-oriented transports.</p></div>
 
1248
connection-oriented transports. The value -1 means no reconnection.</p></div>
1213
1249
<div class="admonitionblock">
1214
1250
<table><tr>
1215
1251
<td class="icon">
1668
1704
<div class="admonitionblock">
1669
1705
<table><tr>
1670
1706
<td class="icon">
 
1707
<div class="title">Note</div>
 
1708
</td>
 
1709
<td class="content">The returned file descriptor is also used internally by the <em>zmq_send</em>
 
1710
and <em>zmq_recv</em> functions. As the descriptor is edge triggered, applications
 
1711
must update the state of <em>ZMQ_EVENTS</em> after each invocation of <em>zmq_send</em>
 
1712
or <em>zmq_recv</em>.To be more explicit: after calling <em>zmq_send</em> the socket may
 
1713
become readable (and vice versa) without triggering a read event on the
 
1714
file descriptor.</td>
 
1715
</tr></table>
 
1716
</div>
 
1717
<div class="admonitionblock">
 
1718
<table><tr>
 
1719
<td class="icon">
1671
1720
<div class="title">Caution</div>
1672
1721
</td>
1673
1722
<td class="content">The returned file descriptor is intended for use with a <em>poll</em> or
1798
1847
</tr>
1799
1848
</table></div>
1800
1849
</div>
 
1850
<div class="sect2">
 
1851
<h3 id="_zmq_last_endpoint_retrieve_the_last_endpoint_set">ZMQ_LAST_ENDPOINT: Retrieve the last endpoint set</h3>
 
1852
<div class="paragraph"><p>The <em>ZMQ_LAST_ENDPOINT</em> option shall retrieve the last endpoint bound for
 
1853
TCP and IPC transports. The returned value will be a string in the form of
 
1854
a ZMQ DSN. Note that if the TCP host is INADDR_ANY, indicated by a *, then
 
1855
the returned address will be 0.0.0.0 (for IPv4).</p></div>
 
1856
<div class="hdlist"><table>
 
1857
<tr>
 
1858
<td class="hdlist1">
 
1859
Option value type
 
1860
<br />
 
1861
</td>
 
1862
<td class="hdlist2">
 
1863
<p style="margin-top: 0;">
 
1864
character string
 
1865
</p>
 
1866
</td>
 
1867
</tr>
 
1868
<tr>
 
1869
<td class="hdlist1">
 
1870
Option value unit
 
1871
<br />
 
1872
</td>
 
1873
<td class="hdlist2">
 
1874
<p style="margin-top: 0;">
 
1875
N/A
 
1876
</p>
 
1877
</td>
 
1878
</tr>
 
1879
<tr>
 
1880
<td class="hdlist1">
 
1881
Default value
 
1882
<br />
 
1883
</td>
 
1884
<td class="hdlist2">
 
1885
<p style="margin-top: 0;">
 
1886
NULL
 
1887
</p>
 
1888
</td>
 
1889
</tr>
 
1890
<tr>
 
1891
<td class="hdlist1">
 
1892
Applicable socket types
 
1893
<br />
 
1894
</td>
 
1895
<td class="hdlist2">
 
1896
<p style="margin-top: 0;">
 
1897
all, when binding TCP or IPC transports
 
1898
</p>
 
1899
</td>
 
1900
</tr>
 
1901
</table></div>
 
1902
</div>
 
1903
<div class="sect2">
 
1904
<h3 id="_zmq_tcp_keepalive_override_so_keepalive_socket_option">ZMQ_TCP_KEEPALIVE: Override SO_KEEPALIVE socket option</h3>
 
1905
<div class="paragraph"><p>Override <em>SO_KEEPALIVE</em> socket option(where supported by OS).
 
1906
The default value of <tt>-1</tt> means to skip any overrides and leave it to OS default.</p></div>
 
1907
<div class="hdlist"><table>
 
1908
<tr>
 
1909
<td class="hdlist1">
 
1910
Option value type
 
1911
<br />
 
1912
</td>
 
1913
<td class="hdlist2">
 
1914
<p style="margin-top: 0;">
 
1915
int
 
1916
</p>
 
1917
</td>
 
1918
</tr>
 
1919
<tr>
 
1920
<td class="hdlist1">
 
1921
Option value unit
 
1922
<br />
 
1923
</td>
 
1924
<td class="hdlist2">
 
1925
<p style="margin-top: 0;">
 
1926
-1,0,1
 
1927
</p>
 
1928
</td>
 
1929
</tr>
 
1930
<tr>
 
1931
<td class="hdlist1">
 
1932
Default value
 
1933
<br />
 
1934
</td>
 
1935
<td class="hdlist2">
 
1936
<p style="margin-top: 0;">
 
1937
-1 (leave to OS default)
 
1938
</p>
 
1939
</td>
 
1940
</tr>
 
1941
<tr>
 
1942
<td class="hdlist1">
 
1943
Applicable socket types
 
1944
<br />
 
1945
</td>
 
1946
<td class="hdlist2">
 
1947
<p style="margin-top: 0;">
 
1948
all, when using TCP transports.
 
1949
</p>
 
1950
</td>
 
1951
</tr>
 
1952
</table></div>
 
1953
</div>
 
1954
<div class="sect2">
 
1955
<h3 id="_zmq_tcp_keepalive_idle_override_tcp_keepcnt_or_tcp_keepalive_on_some_os">ZMQ_TCP_KEEPALIVE_IDLE: Override TCP_KEEPCNT(or TCP_KEEPALIVE on some OS)</h3>
 
1956
<div class="paragraph"><p>Override <em>TCP_KEEPCNT</em>(or <em>TCP_KEEPALIVE</em> on some OS) socket option(where supported by OS).
 
1957
The default value of <tt>-1</tt> means to skip any overrides and leave it to OS default.</p></div>
 
1958
<div class="hdlist"><table>
 
1959
<tr>
 
1960
<td class="hdlist1">
 
1961
Option value type
 
1962
<br />
 
1963
</td>
 
1964
<td class="hdlist2">
 
1965
<p style="margin-top: 0;">
 
1966
int
 
1967
</p>
 
1968
</td>
 
1969
</tr>
 
1970
<tr>
 
1971
<td class="hdlist1">
 
1972
Option value unit
 
1973
<br />
 
1974
</td>
 
1975
<td class="hdlist2">
 
1976
<p style="margin-top: 0;">
 
1977
-1,&gt;0
 
1978
</p>
 
1979
</td>
 
1980
</tr>
 
1981
<tr>
 
1982
<td class="hdlist1">
 
1983
Default value
 
1984
<br />
 
1985
</td>
 
1986
<td class="hdlist2">
 
1987
<p style="margin-top: 0;">
 
1988
-1 (leave to OS default)
 
1989
</p>
 
1990
</td>
 
1991
</tr>
 
1992
<tr>
 
1993
<td class="hdlist1">
 
1994
Applicable socket types
 
1995
<br />
 
1996
</td>
 
1997
<td class="hdlist2">
 
1998
<p style="margin-top: 0;">
 
1999
all, when using TCP transports.
 
2000
</p>
 
2001
</td>
 
2002
</tr>
 
2003
</table></div>
 
2004
</div>
 
2005
<div class="sect2">
 
2006
<h3 id="_zmq_tcp_keepalive_cnt_override_tcp_keepcnt_socket_option">ZMQ_TCP_KEEPALIVE_CNT: Override TCP_KEEPCNT socket option</h3>
 
2007
<div class="paragraph"><p>Override <em>TCP_KEEPCNT</em> socket option(where supported by OS).
 
2008
The default value of <tt>-1</tt> means to skip any overrides and leave it to OS default.</p></div>
 
2009
<div class="hdlist"><table>
 
2010
<tr>
 
2011
<td class="hdlist1">
 
2012
Option value type
 
2013
<br />
 
2014
</td>
 
2015
<td class="hdlist2">
 
2016
<p style="margin-top: 0;">
 
2017
int
 
2018
</p>
 
2019
</td>
 
2020
</tr>
 
2021
<tr>
 
2022
<td class="hdlist1">
 
2023
Option value unit
 
2024
<br />
 
2025
</td>
 
2026
<td class="hdlist2">
 
2027
<p style="margin-top: 0;">
 
2028
-1,&gt;0
 
2029
</p>
 
2030
</td>
 
2031
</tr>
 
2032
<tr>
 
2033
<td class="hdlist1">
 
2034
Default value
 
2035
<br />
 
2036
</td>
 
2037
<td class="hdlist2">
 
2038
<p style="margin-top: 0;">
 
2039
-1 (leave to OS default)
 
2040
</p>
 
2041
</td>
 
2042
</tr>
 
2043
<tr>
 
2044
<td class="hdlist1">
 
2045
Applicable socket types
 
2046
<br />
 
2047
</td>
 
2048
<td class="hdlist2">
 
2049
<p style="margin-top: 0;">
 
2050
all, when using TCP transports.
 
2051
</p>
 
2052
</td>
 
2053
</tr>
 
2054
</table></div>
 
2055
</div>
 
2056
<div class="sect2">
 
2057
<h3 id="_zmq_tcp_keepalive_intvl_override_tcp_keepintvl_socket_option">ZMQ_TCP_KEEPALIVE_INTVL: Override TCP_KEEPINTVL socket option</h3>
 
2058
<div class="paragraph"><p>Override <em>TCP_KEEPINTVL</em> socket option(where supported by OS).
 
2059
The default value of <tt>-1</tt> means to skip any overrides and leave it to OS default.</p></div>
 
2060
<div class="hdlist"><table>
 
2061
<tr>
 
2062
<td class="hdlist1">
 
2063
Option value type
 
2064
<br />
 
2065
</td>
 
2066
<td class="hdlist2">
 
2067
<p style="margin-top: 0;">
 
2068
int
 
2069
</p>
 
2070
</td>
 
2071
</tr>
 
2072
<tr>
 
2073
<td class="hdlist1">
 
2074
Option value unit
 
2075
<br />
 
2076
</td>
 
2077
<td class="hdlist2">
 
2078
<p style="margin-top: 0;">
 
2079
-1,&gt;0
 
2080
</p>
 
2081
</td>
 
2082
</tr>
 
2083
<tr>
 
2084
<td class="hdlist1">
 
2085
Default value
 
2086
<br />
 
2087
</td>
 
2088
<td class="hdlist2">
 
2089
<p style="margin-top: 0;">
 
2090
-1 (leave to OS default)
 
2091
</p>
 
2092
</td>
 
2093
</tr>
 
2094
<tr>
 
2095
<td class="hdlist1">
 
2096
Applicable socket types
 
2097
<br />
 
2098
</td>
 
2099
<td class="hdlist2">
 
2100
<p style="margin-top: 0;">
 
2101
all, when using TCP transports.
 
2102
</p>
 
2103
</td>
 
2104
</tr>
 
2105
</table></div>
 
2106
</div>
1801
2107
</div>
1802
2108
</div>
1803
2109
<div class="sect1">
1874
2180
<div class="sect1">
1875
2181
<h2 id="_authors">AUTHORS</h2>
1876
2182
<div class="sectionbody">
1877
 
<div class="paragraph"><p>The ØMQ documentation was written by Martin Sustrik &lt;<a href="mailto:sustrik@250bpm.com">sustrik@250bpm.com</a>&gt; and
1878
 
Martin Lucina &lt;<a href="mailto:martin@lucina.net">martin@lucina.net</a>&gt;.</p></div>
 
2183
<div class="paragraph"><p>This ØMQ manual page was written by Martin Sustrik &lt;<a href="mailto:sustrik@250bpm.com">sustrik@250bpm.com</a>&gt; and
 
2184
Martin Lucina &lt;<a href="mailto:mato@kotelna.sk">mato@kotelna.sk</a>&gt;.</p></div>
1879
2185
</div>
1880
2186
</div>
1881
2187
</div>
1882
2188
<div id="footnotes"><hr /></div>
1883
2189
<div id="footer">
1884
2190
<div id="footer-text">
1885
 
ØMQ 3.1.0<br />
1886
 
Last updated 2011-12-18 11:17:56 CET
 
2191
ØMQ 3.2.0<br />
 
2192
Last updated 2012-06-05 09:39:30 CEST
1887
2193
</div>
1888
2194
</div>
1889
2195
</body>