From c9971e08a0b611fe1b6b6162a2a430ae53d3a3dd Mon Sep 17 00:00:00 2001 From: KIU Shueng Chuan Date: Tue, 4 Aug 2015 22:14:50 +0800 Subject: [PATCH] write man pages --- doc/zmq_getsockopt.txt | 14 ++++++++++++++ doc/zmq_setsockopt.txt | 14 ++++++++++++++ 2 files changed, 28 insertions(+) diff --git a/doc/zmq_getsockopt.txt b/doc/zmq_getsockopt.txt index 243cb2d8..4e0cfb9d 100644 --- a/doc/zmq_getsockopt.txt +++ b/doc/zmq_getsockopt.txt @@ -63,6 +63,20 @@ Default value:: 100 Applicable socket types:: all, only for connection-oriented transports +ZMQ_CONNECT_TIMEOUT: Retrieve connect() timeout +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Retrieves how long to wait before timing-out a connect() system call. +The connect() system call normally takes a long time before it returns a +time out error. Setting this option allows the library to time out the call +at an earlier interval. + +[horizontal] +Option value type:: int +Option value unit:: milliseconds +Default value:: 0 (disabled) +Applicable socket types:: all, when using TCP transports. + + ZMQ_CURVE_PUBLICKEY: Retrieve current CURVE public key ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/zmq_setsockopt.txt b/doc/zmq_setsockopt.txt index 13918956..07c2a2ef 100644 --- a/doc/zmq_setsockopt.txt +++ b/doc/zmq_setsockopt.txt @@ -109,6 +109,20 @@ Default value:: 0 (false) Applicable socket types:: ZMQ_PULL, ZMQ_PUSH, ZMQ_SUB, ZMQ_PUB, ZMQ_DEALER +ZMQ_CONNECT_TIMEOUT: Set connect() timeout +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Sets how long to wait before timing-out a connect() system call. +The connect() system call normally takes a long time before it returns a +time out error. Setting this option allows the library to time out the call +at an earlier interval. + +[horizontal] +Option value type:: int +Option value unit:: milliseconds +Default value:: 0 (disabled) +Applicable socket types:: all, when using TCP transports. + + ZMQ_CURVE_PUBLICKEY: Set CURVE public key ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Sets the socket's long term public key. You must set this on CURVE client