summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMartin Lucina <martin@lucina.net>2012-03-29 14:53:01 +0200
committerMartin Lucina <martin@lucina.net>2012-03-29 14:53:01 +0200
commit437db5a6c8348faa551a41b5ddb38072bd6924cb (patch)
tree30142a64a8686b51f4375a11f16091ab8933d44a /doc
parent9c7e081f51063b6cdb4674f4d2e6c4eab502a327 (diff)
Documentation updates for 1.0.1
Signed-off-by: Martin Lucina <martin@lucina.net>
Diffstat (limited to 'doc')
-rw-r--r--doc/xs_getsockopt.txt16
-rw-r--r--doc/xs_setsockopt.txt15
2 files changed, 15 insertions, 16 deletions
diff --git a/doc/xs_getsockopt.txt b/doc/xs_getsockopt.txt
index c113f16..99d9376 100644
--- a/doc/xs_getsockopt.txt
+++ b/doc/xs_getsockopt.txt
@@ -121,7 +121,7 @@ XS_IDENTITY: Set socket identity
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'XS_IDENTITY' option shall retrieve the identity of the specified 'socket'.
Socket identity is used only by request/reply pattern. Namely, it can be used
-in tandem with ROUTER socket to route messages to the peer with specific
+in tandem with a 'XS_XREP' socket to route messages to the peer with specific
identity.
Identity should be at least one byte and at most 255 bytes long. Identities
@@ -338,7 +338,7 @@ hosts.
Option value type:: int
Option value unit:: boolean
Default value:: 1 (true)
-Applicable socket types:: all, when using TCP transports.
+Applicable socket types:: all, when using TCP transport.
XS_FD: Retrieve file descriptor associated with the socket
@@ -390,18 +390,18 @@ Option value unit:: N/A (flags)
Default value:: N/A
Applicable socket types:: all
-XS_KEEPALIVE: Use TCP keepalives
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-When set to `1` TCP keepalives are enabled. This option can be used to prevent
-the infrastructure (VPNs and similar) to terminate connections with no activity.
-The keepalive period as such is normally a global OS setting.
+XS_KEEPALIVE: Enable transport keepalives
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+When set to `1`, this option enables use of protocol keepalives on the
+'socket', if supported by the underlying transport protocol.
[horizontal]
Option value type:: int
Option value unit:: boolean
Default value:: 0 (false)
-Applicable socket types:: all, when using TCP transports.
+Applicable socket types:: all, when using TCP transport.
RETURN VALUE
diff --git a/doc/xs_setsockopt.txt b/doc/xs_setsockopt.txt
index e9a7050..e07d9dd 100644
--- a/doc/xs_setsockopt.txt
+++ b/doc/xs_setsockopt.txt
@@ -126,7 +126,7 @@ XS_IDENTITY: Set socket identity
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'XS_IDENTITY' option shall set the identity of the specified 'socket'.
Socket identity is used only by request/reply pattern. Namely, it can be used
-in tandem with ROUTER socket to route messages to the peer with specific
+in tandem with a 'XS_XREP' socket to route messages to the peer with specific
identity.
Identity should be at least one byte and at most 255 bytes long. Identities
@@ -346,20 +346,19 @@ applications connect to and accept connections from both IPv4 and IPv6 hosts.
Option value type:: int
Option value unit:: boolean
Default value:: 1 (true)
-Applicable socket types:: all, when using TCP transports.
+Applicable socket types:: all, when using TCP transport.
-XS_KEEPALIVE: Use TCP keepalives
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+XS_KEEPALIVE: Enable transport keepalives
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-When set to `1` TCP keepalives are enabled. This option can be used to prevent
-the infrastructure (VPNs and similar) to terminate connections with no activity.
-The keepalive period as such is normally a global OS setting.
+When set to `1`, this option enables use of protocol keepalives on the
+'socket', if supported by the underlying transport protocol.
[horizontal]
Option value type:: int
Option value unit:: boolean
Default value:: 0 (false)
-Applicable socket types:: all, when using TCP transports.
+Applicable socket types:: all, when using TCP transport.
RETURN VALUE