diff options
author | Steven McCoy <steven.mccoy@miru.hk> | 2011-08-08 12:10:31 +0200 |
---|---|---|
committer | Martin Sustrik <sustrik@250bpm.com> | 2011-08-08 12:10:31 +0200 |
commit | 784041f5b99ba28252c9bb67a5bfb4a5da41ef93 (patch) | |
tree | 3306c8c36266a052f9365d757197e7852ec52031 /doc | |
parent | 8378180cbb69c44fdd84f9ee05620bf8744cce48 (diff) |
ZMQ_IPV4ONLY option added
At this point option exists, is documented and can be set,
however, it has no effect.
Signed-off-by: Steven McCoy <steven.mccoy@miru.hk>
Signed-off-by: Martin Sustrik <sustrik@250bpm.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/zmq_getsockopt.txt | 15 | ||||
-rw-r--r-- | doc/zmq_setsockopt.txt | 14 | ||||
-rw-r--r-- | doc/zmq_tcp.txt | 6 |
3 files changed, 32 insertions, 3 deletions
diff --git a/doc/zmq_getsockopt.txt b/doc/zmq_getsockopt.txt index 128b733..5e3051e 100644 --- a/doc/zmq_getsockopt.txt +++ b/doc/zmq_getsockopt.txt @@ -329,6 +329,21 @@ Default value:: -1 (infinite) Applicable socket types:: all +ZMQ_IPV4ONLY: Retrieve IPv4-only socket override status +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Retrieve the underlying native socket type. A value of `1` will use IPv4 +sockets, while the default value of `0` will use IPv6 sockets. An IPv6 socket +lets applications connect to and accept connections from both IPv4 and IPv6 +hosts. + +[horizontal] +Option value type:: int +Option value unit:: boolean +Default value:: 1 (true) +Applicable socket types:: all, when using TCP transports. + + ZMQ_FD: Retrieve file descriptor associated with the socket ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The 'ZMQ_FD' option shall retrieve the file descriptor associated with the diff --git a/doc/zmq_setsockopt.txt b/doc/zmq_setsockopt.txt index f62a7e9..b06388c 100644 --- a/doc/zmq_setsockopt.txt +++ b/doc/zmq_setsockopt.txt @@ -321,6 +321,20 @@ Default value:: -1 (infinite) Applicable socket types:: all +ZMQ_IPV4ONLY: Use IPv4-only sockets +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sets the underlying native socket type. A value of `1` will use IPv4 sockets, +while the default value of `0` will use IPv6 sockets. An IPv6 socket lets +applications connect to and accept connections from both IPv4 and IPv6 hosts. + +[horizontal] +Option value type:: int +Option value unit:: boolean +Default value:: 1 (true) +Applicable socket types:: all, when using TCP transports. + + RETURN VALUE ------------ The _zmq_setsockopt()_ function shall return zero if successful. Otherwise it diff --git a/doc/zmq_tcp.txt b/doc/zmq_tcp.txt index 84ec6c8..a6d7be3 100644 --- a/doc/zmq_tcp.txt +++ b/doc/zmq_tcp.txt @@ -31,13 +31,13 @@ colon and the TCP port number to use. An 'interface' may be specified by either of the following: * The wild-card `*`, meaning all available interfaces. -* The primary IPv4 address assigned to the interface, in its numeric +* The primary IPv4 or IPv6 address assigned to the interface, in its numeric representation. * The interface name as defined by the operating system. NOTE: Interface names are not standardised in any way and should be assumed to be arbitrary and platform dependent. On Win32 platforms no short interface -names exist, thus only the primary IPv4 address may be used to specify an +names exist, thus only the primary IP address may be used to specify an 'interface'. Connecting a socket @@ -49,7 +49,7 @@ a colon and the TCP port number to use. A 'peer address' may be specified by either of the following: * The DNS name of the peer. -* The IPv4 address of the peer, in it's numeric representation. +* The IPv4 or IPv6 address of the peer, in it's numeric representation. WIRE FORMAT |