From 75af6aed482ab16997c1388fe801f74d11ec12a4 Mon Sep 17 00:00:00 2001 From: Martin Lucina Date: Mon, 23 Jan 2012 08:54:14 +0100 Subject: Imported Upstream version 2.1.9 --- doc/zmq_getsockopt.html | 198 ++++++++++++++++++++++++++++-------------------- 1 file changed, 114 insertions(+), 84 deletions(-) (limited to 'doc/zmq_getsockopt.html') diff --git a/doc/zmq_getsockopt.html b/doc/zmq_getsockopt.html index 3c0b0e4..e77e2e1 100644 --- a/doc/zmq_getsockopt.html +++ b/doc/zmq_getsockopt.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_getsockopt(3) - +
+

SYNOPSIS

int zmq_getsockopt (void *socket, int option_name, void *option_value, size_t *option_len);

+
+

DESCRIPTION

The zmq_getsockopt() function shall retrieve the value for the option @@ -594,7 +577,8 @@ to by option_value; upon successful completion zmq_getsockopt()option_len argument to indicate the actual size of the option value stored in the buffer.

The following options can be retrieved with the zmq_getsockopt() function:

-

ZMQ_TYPE: Retrieve socket type

+
+

ZMQ_TYPE: Retrieve socket type

The ZMQ_TYPE option shall retrieve the socket type for the specified socket. The socket type is specified at socket creation time and cannot be modified afterwards.

@@ -644,7 +628,9 @@ all
-

ZMQ_RCVMORE: More message parts to follow

+
+
+

ZMQ_RCVMORE: More message parts to follow

The ZMQ_RCVMORE option shall return a boolean value indicating if the multi-part message currently being read from the specified socket has more message parts to follow. If there are no message parts to follow or if the @@ -698,7 +684,9 @@ all

-

ZMQ_HWM: Retrieve high water mark

+
+
+

ZMQ_HWM: Retrieve high water mark

The ZMQ_HWM option shall retrieve the high water mark for the specified socket. The high water mark is a hard limit on the maximum number of outstanding messages ØMQ shall queue in memory for any single peer that the @@ -755,10 +743,12 @@ all

-

ZMQ_SWAP: Retrieve disk offload size

+
+
+

ZMQ_SWAP: Retrieve disk offload size

The ZMQ_SWAP option shall retrieve the disk offload (swap) size for the specified socket. A socket which has ZMQ_SWAP set to a non-zero value may -exceed it’s high water mark; in this case outstanding messages shall be +exceed its high water mark; in this case outstanding messages shall be offloaded to storage on disk rather than held in memory.

The value of ZMQ_SWAP defines the maximum size of the swap space in bytes.

@@ -807,7 +797,9 @@ all
-

ZMQ_AFFINITY: Retrieve I/O thread affinity

+
+
+

ZMQ_AFFINITY: Retrieve I/O thread affinity

The ZMQ_AFFINITY option shall retrieve the I/O thread affinity for newly created connections on the specified socket.

Affinity determines which threads from the ØMQ I/O thread pool associated with @@ -865,7 +857,9 @@ N/A

-

ZMQ_IDENTITY: Retrieve socket identity

+
+
+

ZMQ_IDENTITY: Retrieve socket identity

The ZMQ_IDENTITY option shall retrieve the identity of the specified socket. Socket identity determines if existing ØMQ infrastructure (message queues, forwarding devices) shall be identified with a specific application @@ -923,7 +917,9 @@ all

-

ZMQ_RATE: Retrieve multicast data rate

+
+
+

ZMQ_RATE: Retrieve multicast data rate

The ZMQ_RATE option shall retrieve the maximum send or receive data rate for multicast transports using the specified socket.

@@ -972,7 +968,9 @@ all, when using multicast transports
-

ZMQ_RECOVERY_IVL: Get multicast recovery interval

+
+
+

ZMQ_RECOVERY_IVL: Get multicast recovery interval

The ZMQ_RECOVERY_IVL option shall retrieve the recovery interval for multicast transports using the specified socket. The recovery interval determines the maximum time in seconds that a receiver can be absent from a @@ -1023,7 +1021,9 @@ all, when using multicast transports

-

ZMQ_RECOVERY_IVL_MSEC: Get multicast recovery interval in milliseconds

+
+
+

ZMQ_RECOVERY_IVL_MSEC: Get multicast recovery interval in milliseconds

The ZMQ_RECOVERY_IVL’_MSEC option shall retrieve the recovery interval, in milliseconds, for multicast transports using the specified 'socket. The recovery interval determines the maximum time in seconds that a receiver @@ -1079,7 +1079,9 @@ all, when using multicast transports

-

ZMQ_MCAST_LOOP: Control multicast loop-back

+
+
+

ZMQ_MCAST_LOOP: Control multicast loop-back

The ZMQ_MCAST_LOOP option controls whether data sent via multicast transports can also be received by the sending host via loop-back. A value of zero indicates that the loop-back functionality is disabled, while the default @@ -1133,7 +1135,9 @@ all, when using multicast transports

-

ZMQ_SNDBUF: Retrieve kernel transmit buffer size

+
+
+

ZMQ_SNDBUF: Retrieve kernel transmit buffer size

The ZMQ_SNDBUF option shall retrieve the underlying kernel transmit buffer size for the specified socket. A value of zero means that the OS default is in effect. For details refer to your operating system documentation for the @@ -1184,7 +1188,9 @@ all

-

ZMQ_RCVBUF: Retrieve kernel receive buffer size

+
+
+

ZMQ_RCVBUF: Retrieve kernel receive buffer size

The ZMQ_RCVBUF option shall retrieve the underlying kernel receive buffer size for the specified socket. A value of zero means that the OS default is in effect. For details refer to your operating system documentation for the @@ -1235,7 +1241,9 @@ all

-

ZMQ_LINGER: Retrieve linger period for socket shutdown

+
+
+

ZMQ_LINGER: Retrieve linger period for socket shutdown

The ZMQ_LINGER option shall retrieve the linger period for the specified socket. The linger period determines how long pending messages which have yet to be sent to a peer shall linger in memory after a socket is closed with @@ -1313,7 +1321,9 @@ all

-

ZMQ_RECONNECT_IVL: Retrieve reconnection interval

+
+
+

ZMQ_RECONNECT_IVL: Retrieve reconnection interval

The ZMQ_RECONNECT_IVL option shall retrieve the initial reconnection interval for the specified socket. The reconnection interval is the period ØMQ shall wait between attempts to reconnect disconnected peers when using @@ -1373,7 +1383,9 @@ all, only for connection-oriented transports

-

ZMQ_RECONNECT_IVL_MAX: Retrieve maximum reconnection interval

+
+
+

ZMQ_RECONNECT_IVL_MAX: Retrieve maximum reconnection interval

The ZMQ_RECONNECT_IVL_MAX option shall retrieve the maximum reconnection interval for the specified socket. This is the maximum period ØMQ shall wait between attempts to reconnect. On each reconnect attempt, the previous interval @@ -1434,7 +1446,9 @@ all, only for connection-oriented transport

-

ZMQ_BACKLOG: Retrieve maximum length of the queue of outstanding connections

+
+
+

ZMQ_BACKLOG: Retrieve maximum length of the queue of outstanding connections

The ZMQ_BACKLOG option shall retrieve the maximum length of the queue of outstanding peer connections for the specified socket; this only applies to connection-oriented transports. For details refer to your operating system @@ -1485,7 +1499,9 @@ all, only for connection-oriented transports

-

ZMQ_FD: Retrieve file descriptor associated with the socket

+
+
+

ZMQ_FD: Retrieve file descriptor associated with the socket

The ZMQ_FD option shall retrieve the file descriptor associated with the specified socket. The returned file descriptor can be used to integrate the socket into an existing event loop; the ØMQ library shall signal any pending @@ -1558,7 +1574,9 @@ all

-

ZMQ_EVENTS: Retrieve socket event state

+
+
+

ZMQ_EVENTS: Retrieve socket event state

The ZMQ_EVENTS option shall retrieve the event state for the specified socket. The returned value is a bit mask constructed by OR’ing a combination of the following event flags:

@@ -1633,11 +1651,16 @@ all
+ + +

RETURN VALUE

The zmq_getsockopt() function shall return zero if successful. Otherwise it shall return -1 and set errno to one of the values defined below.

+
+

ERRORS

@@ -1678,6 +1701,8 @@ The operation was interrupted by delivery of a signal.
+
+

EXAMPLE

@@ -1690,23 +1715,28 @@ rc = zmq_getsockopt (socket, ZMQ_HWM, &hwm, &hwm_size); assert (rc == 0);
+ +

SEE ALSO

zmq_setsockopt(3) zmq_socket(3) zmq(7)

+
+

AUTHORS

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and Martin Lucina <mato@kotelna.sk>.

+
-- cgit v1.2.3