Zeromq Toolkit - zmq_getsockopt

: value = zmq_getsockopt (sock, optionid)

Get the current value of an option.

Inputs

sock - the socket to connect.

optionid - the setsockopt option to set.

Valid optionids are:

ZMQ_RCVMORE

Flag for whether a message has been split into multiple messages. The return value will be either 0 or 1.

ZMQ_TYPE

Socket type for zeromq socket created with zmq_socket. Valid types are the same as the socket type value specified with zmq_socket.

ZMQ_EVENTS

Get the event state of zeromq socket. The returned value is a bit mask that may contain the following set values:

• ZMQ_POLLIN set when at least one message is available to read and zmq_recv will not block.
• ZMQ_POLLOUT set when at least one message can be written without zmq_send blocking.

ZMQ_IDENTITY or ZMQ_ROUTING_ID

Get the socket identity value

ZMQ_RATE

Get the multicast data rate

ZMQ_PRIORITY

Get socket priority (linux only)

ZMQ_BACKLOG

Get length of queue for pending connections

ZMQ_LAST_ENDPOINT

Get the last endpoint the socket was connected to

ZMQ_CONNECT_TIMEOUT

Get the connect timeout value

ZMQ_SOCKS_PROXY

Get the SOCKS5 proxy value (string)

ZMQ_CURVE_SERVER

Get whether socket is a curve server (1) or not (0)

ZMQ_CURVE_PRIVATEKEY

Get a the curve socket private key (string)

ZMQ_CURVE_PUBLICKEY

Get a the curve socket public key (string)

ZMQ_CURVE_SERVERKEY

Get a the curve socket public key (string)

ZMQ_PLAIN_SERVER

Get whether socket server will use plain authentication (1) or not (0)

ZMQ_PLAIN_USERNAME

Get the plain socket username (string)

ZMQ_PLAIN_PASSWORD

Get the plain socket password (string)

ZMQ_GSSAPI_SERVER

Get whether socket server will use gssapi authentication (1) or not (0)

ZMQ_GSSAPI_PLAINTEXT

Get whether socket will encrypt gssapi authentication (1) or not (0)

ZMQ_GSSAPI_PRINCIPAL

Get the name of the gssapi principal (string)

ZMQ_GSSAPI_SERVICE_PRINCIPAL

Get the name of the gssapi service principal (string)

ZMQ_MECHANISM

Get the security mechanism (ZMQ_NULL, ZMQ_PLAIN, ZMQ_CURVE, ZMQ_GSSAPI)

Outputs

value - the value set for the option, or [].

See also: zmq_socket, zmq_setsockopt.