Qore zmq Module
1.0.0
|
These constants define socket option codes for ZSocket::setOption() and ZSocket::getOption(). More...
Variables | |
const | Qore::ZMQ::ZMQ_AFFINITY = ZMQ_AFFINITY |
Set I/O thread affinity. More... | |
const | Qore::ZMQ::ZMQ_BACKLOG = ZMQ_BACKLOG |
Set maximum length of the queue of outstanding connections. More... | |
const | Qore::ZMQ::ZMQ_CONFLATE = ZMQ_CONFLATE |
Keep only last message. More... | |
const | Qore::ZMQ::ZMQ_CONNECT_RID = ZMQ_CONNECT_RID |
Assign the next outbound connection id. More... | |
const | Qore::ZMQ::ZMQ_CONNECT_TIMEOUT = ZMQ_CONNECT_TIMEOUT |
Set connect timeout. More... | |
const | Qore::ZMQ::ZMQ_CURVE_PUBLICKEY = ZMQ_CURVE_PUBLICKEY |
Set CURVE public key. More... | |
const | Qore::ZMQ::ZMQ_CURVE_SECRETKEY = ZMQ_CURVE_SECRETKEY |
Set CURVE secret key. More... | |
const | Qore::ZMQ::ZMQ_CURVE_SERVER = ZMQ_CURVE_SERVER |
Set CURVE server role. More... | |
const | Qore::ZMQ::ZMQ_CURVE_SERVERKEY = ZMQ_CURVE_SERVERKEY |
Set CURVE server key. More... | |
const | Qore::ZMQ::ZMQ_GSSAPI_PLAINTEXT = ZMQ_GSSAPI_PLAINTEXT |
Disable GSSAPI encryption. More... | |
const | Qore::ZMQ::ZMQ_GSSAPI_PRINCIPAL = ZMQ_GSSAPI_PRINCIPAL |
Set name of GSSAPI principal. More... | |
const | Qore::ZMQ::ZMQ_GSSAPI_SERVER = ZMQ_GSSAPI_SERVER |
Set GSSAPI server role. More... | |
const | Qore::ZMQ::ZMQ_GSSAPI_SERVICE_PRINCIPAL = ZMQ_GSSAPI_SERVICE_PRINCIPAL |
Set name of GSSAPI service principal. More... | |
const | Qore::ZMQ::ZMQ_HANDSHAKE_IVL = ZMQ_HANDSHAKE_IVL |
Set maximum handshake interval. More... | |
const | Qore::ZMQ::ZMQ_HEARTBEAT_IVL = ZMQ_HEARTBEAT_IVL |
Set interval between sending ZMTP heartbeats. More... | |
const | Qore::ZMQ::ZMQ_HEARTBEAT_TIMEOUT = ZMQ_HEARTBEAT_TIMEOUT |
Set timeout for ZMTP heartbeats. More... | |
const | Qore::ZMQ::ZMQ_HEARTBEAT_TTL = ZMQ_HEARTBEAT_TTL |
Set the TTL value for ZMTP heartbeats. More... | |
const | Qore::ZMQ::ZMQ_IDENTITY = ZMQ_IDENTITY |
Set socket identity. More... | |
const | Qore::ZMQ::ZMQ_IMMEDIATE = ZMQ_IMMEDIATE |
Queue messages only to completed connections. More... | |
const | Qore::ZMQ::ZMQ_INVERT_MATCHING = ZMQ_INVERT_MATCHING |
Invert message filtering. More... | |
const | Qore::ZMQ::ZMQ_IPV6 = ZMQ_IPV6 |
Enable IPv6 on socket. More... | |
const | Qore::ZMQ::ZMQ_LINGER = ZMQ_LINGER |
Set linger period for socket shutdown. More... | |
const | Qore::ZMQ::ZMQ_MAXMSGSIZE = ZMQ_MAXMSGSIZE |
Maximum acceptable inbound message size. More... | |
const | Qore::ZMQ::ZMQ_MULTICAST_HOPS = ZMQ_MULTICAST_HOPS |
Maximum network hops for multicast packets. More... | |
const | Qore::ZMQ::ZMQ_MULTICAST_MAXTPDU = ZMQ_MULTICAST_MAXTPDU |
Maximum transport data unit size for multicast packets. More... | |
const | Qore::ZMQ::ZMQ_PLAIN_PASSWORD = ZMQ_PLAIN_PASSWORD |
Set PLAIN security password. More... | |
const | Qore::ZMQ::ZMQ_PLAIN_SERVER = ZMQ_PLAIN_SERVER |
Set PLAIN server role. More... | |
const | Qore::ZMQ::ZMQ_PLAIN_USERNAME = ZMQ_PLAIN_USERNAME |
Set PLAIN security username. More... | |
const | Qore::ZMQ::ZMQ_PROBE_ROUTER = ZMQ_PROBE_ROUTER |
bootstrap connections to ROUTER sockets More... | |
const | Qore::ZMQ::ZMQ_RATE = ZMQ_RATE |
Set multicast data rate. More... | |
const | Qore::ZMQ::ZMQ_RCVBUF = ZMQ_RCVBUF |
Set kernel receive buffer size. More... | |
const | Qore::ZMQ::ZMQ_RCVHWM = ZMQ_RCVHWM |
Set high water mark for inbound messages. More... | |
const | Qore::ZMQ::ZMQ_RCVTIMEO = ZMQ_RCVTIMEO |
Maximum time before a recv operation returns with EAGAIN . More... | |
const | Qore::ZMQ::ZMQ_RECONNECT_IVL = ZMQ_RECONNECT_IVL |
Set reconnection interval. More... | |
const | Qore::ZMQ::ZMQ_RECONNECT_IVL_MAX = ZMQ_RECONNECT_IVL_MAX |
Set maximum reconnection interval. More... | |
const | Qore::ZMQ::ZMQ_RECOVERY_IVL = ZMQ_RECOVERY_IVL |
Set multicast recovery interval. More... | |
const | Qore::ZMQ::ZMQ_REQ_CORRELATE = ZMQ_REQ_CORRELATE |
match replies with requests More... | |
const | Qore::ZMQ::ZMQ_REQ_RELAXED = ZMQ_REQ_RELAXED |
relax strict alternation between request and reply More... | |
const | Qore::ZMQ::ZMQ_ROUTER_HANDOVER = ZMQ_ROUTER_HANDOVER |
handle duplicate client identities on ROUTER sockets More... | |
const | Qore::ZMQ::ZMQ_ROUTER_MANDATORY = ZMQ_ROUTER_MANDATORY |
accept only routable messages on ROUTER sockets More... | |
const | Qore::ZMQ::ZMQ_SNDBUF = ZMQ_SNDBUF |
Set kernel transmit buffer size. More... | |
const | Qore::ZMQ::ZMQ_SNDHWM = ZMQ_SNDHWM |
Set the high water mark for outbound messages. More... | |
const | Qore::ZMQ::ZMQ_SNDTIMEO = ZMQ_SNDTIMEO |
Maximum time before a send operation returns with EAGAIN . More... | |
const | Qore::ZMQ::ZMQ_SOCKS_PROXY = ZMQ_SOCKS_PROXY |
Set SOCKS5 proxy address. More... | |
const | Qore::ZMQ::ZMQ_STREAM_NOTIFY = ZMQ_STREAM_NOTIFY |
send connect and disconnect notifications More... | |
const | Qore::ZMQ::ZMQ_SUBSCRIBE = ZMQ_SUBSCRIBE |
Establish message filter. More... | |
const | Qore::ZMQ::ZMQ_TCP_KEEPALIVE = ZMQ_TCP_KEEPALIVE |
Override SO_KEEPALIVE socket option. More... | |
const | Qore::ZMQ::ZMQ_TCP_KEEPALIVE_CNT = ZMQ_TCP_KEEPALIVE_CNT |
Override TCP_KEEPCNT socket option. More... | |
const | Qore::ZMQ::ZMQ_TCP_KEEPALIVE_IDLE = ZMQ_TCP_KEEPALIVE_IDLE |
Override TCP_KEEPIDLE (or TCP_KEEPALIVE on some OSes) More... | |
const | Qore::ZMQ::ZMQ_TCP_KEEPALIVE_INTVL = ZMQ_TCP_KEEPALIVE_INTVL |
Override TCP_KEEPINTVL socket option. More... | |
const | Qore::ZMQ::ZMQ_TCP_MAXRT = ZMQ_TCP_MAXRT |
Set TCP Maximum Retransmit Timeout. More... | |
const | Qore::ZMQ::ZMQ_TOS = ZMQ_TOS |
Set the Type-of-Service on socket. More... | |
const | Qore::ZMQ::ZMQ_UNSUBSCRIBE = ZMQ_UNSUBSCRIBE |
Remove message filter. More... | |
const | Qore::ZMQ::ZMQ_XPUB_MANUAL = ZMQ_XPUB_MANUAL |
change the subscription handling to manual More... | |
const | Qore::ZMQ::ZMQ_XPUB_NODROP = ZMQ_XPUB_NODROP |
do not silently drop messages if SENDHWM is reached More... | |
const | Qore::ZMQ::ZMQ_XPUB_VERBOSE = ZMQ_XPUB_VERBOSE |
pass subscribe messages on an XPUB socket More... | |
const | Qore::ZMQ::ZMQ_XPUB_VERBOSER = ZMQ_XPUB_VERBOSER |
pass subscribe and unsubscribe messages on XPUB socket More... | |
const | Qore::ZMQ::ZMQ_XPUB_WELCOME_MSG = ZMQ_XPUB_WELCOME_MSG |
Set welcome message that will be received by subscriber when connecting. More... | |
const | Qore::ZMQ::ZMQ_ZAP_DOMAIN = ZMQ_ZAP_DOMAIN |
Set RFC 27 authentication domain. More... | |
const | Qore::ZMQ::ZmqOptionCodeMap |
ZeroMQ option map mapping option codes to strings. | |
const | Qore::ZMQ::ZmqOptionStringMap |
ZeroMQ option map mapping strings to option codes. | |
These constants define socket option codes for ZSocket::setOption() and ZSocket::getOption().
const Qore::ZMQ::ZMQ_AFFINITY = ZMQ_AFFINITY |
Set I/O thread affinity.
The ZMQ_AFFINITY option shall set 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 the socket's context shall handle newly created connections. A value of zero specifies no affinity, meaning that work shall be distributed fairly among all ØMQ I/O threads in the thread pool. For non-zero values, the lowest bit corresponds to thread 1, second lowest bit to thread 2 and so on. For example, a value of 3 specifies that subsequent connections on socket shall be handled exclusively by I/O threads 1 and 2.
0MQ Socket Option Information
Property | Description |
Option value type | uint64_t |
Option value unit | N/A (bitmap) |
Default value | 0 |
Applicable socket types | N/A |
const Qore::ZMQ::ZMQ_BACKLOG = ZMQ_BACKLOG |
Set maximum length of the queue of outstanding connections.
The ZMQ_BACKLOG option shall set 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 documentation for the listen function.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | connections |
Default value | 100 |
Applicable socket types | all, only for connection-oriented transports. |
const Qore::ZMQ::ZMQ_CONFLATE = ZMQ_CONFLATE |
Keep only last message.
If set, a socket shall keep only one message in its inbound/outbound queue, this message being the last message received/the last message to be sent. Ignores ZMQ_RCVHWM and ZMQ_SNDHWM options. Does not support multi-part messages, in particular, only one part of it is kept in the socket internal queue.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | boolean |
Default value | 0 (false) |
Applicable socket types | ZSocketPull, ZSocketPush, ZSocketSub, ZSocketPub, ZSocketDealer |
const Qore::ZMQ::ZMQ_CONNECT_RID = ZMQ_CONNECT_RID |
Assign the next outbound connection id.
The ZMQ_CONNECT_RID option sets the peer id of the next host connected via the ZSocket::connect() call, and immediately readies that connection for data transfer with the named id. This option applies only to the first subsequent call to ZSocket::connect(), calls thereafter use default connection behaviour.
Typical use is to set this socket option ahead of each ZSocket::connect() attempt to a new host. Each connection MUST be assigned a unique name. Assigning a name that is already in use is not allowed.
Useful when connecting ROUTER to ROUTER, or STREAM to STREAM, as it allows for immediate sending to peers. Outbound id framing requirements for ROUTER and STREAM sockets apply.
The peer id should be from 1 to 255 bytes long and MAY NOT start with binary zero.
0MQ Socket Option Information
Property | Description |
Option value type | binary data |
N/A | |
nothing | |
ROUTER, STREAM |
const Qore::ZMQ::ZMQ_CONNECT_TIMEOUT = 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.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | milliseconds |
Default value | 0 (disabled) |
Applicable socket types | all, when using TCP transports. |
const Qore::ZMQ::ZMQ_CURVE_PUBLICKEY = ZMQ_CURVE_PUBLICKEY |
Set CURVE public key.
Sets the socket's long term public key. You must set this on CURVE client sockets. You can provide the key as 32 binary bytes, or as a 40-character string encoded in the Z85 encoding format and terminated in a null byte. The public key must always be used with the matching secret key. To generate a public/secret key pair, use zmq_curve_keypair(). To derive the public key from a secret key, use zmq_curve_public().
0MQ Socket Option Information
Property | Description |
Option value type | binary data or Z85 text string |
Option value size | 32 (binary) or 40 (byte character string) |
Default value | nothing |
Applicable socket types | all, when using TCP transport |
const Qore::ZMQ::ZMQ_CURVE_SECRETKEY = ZMQ_CURVE_SECRETKEY |
Set CURVE secret key.
Sets the socket's long term secret key. You must set this on both CURVE client and server sockets. You can provide the key as 32 binary bytes, or as a 40-character string encoded in the Z85 encoding format and terminated in a null byte. To generate a public/secret key pair, use zmq_curve_keypair(). To derive the public key from a secret key, use zmq_curve_public().
0MQ Socket Option Information
Property | Description |
Option value type | binary data or Z85 text string |
Option value size | 32 (binary) or 40 (byte character string) |
Default value | nothing |
Applicable socket types | all, when using TCP transport |
const Qore::ZMQ::ZMQ_CURVE_SERVER = ZMQ_CURVE_SERVER |
Set CURVE server role.
Defines whether the socket will act as server for CURVE security. A value of 1 means the socket will act as CURVE server. A value of 0 means the socket will not act as CURVE server, and its security role then depends on other option settings. Setting this to 0 shall reset the socket security to NULL. When you set this you must also set the server's secret key using the ZMQ_CURVE_SECRETKEY option. A server socket does not need to know its own public key.
0MQ Socket Option Information
Property | Description |
Option value type | bool |
Option value unit | True, False |
Default value | False |
Applicable socket types | all, when using TCP transport |
const Qore::ZMQ::ZMQ_CURVE_SERVERKEY = ZMQ_CURVE_SERVERKEY |
Set CURVE server key.
Sets the socket's long term server key. You must set this on CURVE client sockets. You can provide the key as 32 binary bytes, or as a 40-character string encoded in the Z85 encoding format and terminated in a null byte. This key must have been generated together with the server's secret key. To generate a public/secret key pair, use zmq_curve_keypair().
0MQ Socket Option Information
Property | Description |
Option value type | binary data or Z85 text string |
Option value size | 32 (binary) or 40 (byte character string) |
Default value | NULL |
Applicable socket types | all, when using TCP transport |
const Qore::ZMQ::ZMQ_GSSAPI_PLAINTEXT = ZMQ_GSSAPI_PLAINTEXT |
Disable GSSAPI encryption.
Defines whether communications on the socket will be encrypted. A value of 1 means that communications will be plaintext. A value of 0 means communications will be encrypted.
0MQ Socket Option Information
Property | Description |
Option value type | bool |
Option value unit | True, False |
Default value | False |
Applicable socket types | all, when using TCP transport |
const Qore::ZMQ::ZMQ_GSSAPI_PRINCIPAL = ZMQ_GSSAPI_PRINCIPAL |
Set name of GSSAPI principal.
Sets the name of the principal for whom GSSAPI credentials should be acquired.
0MQ Socket Option Information
Property | Description |
Option value type | character string |
Option value unit | N/A |
Default value | not set |
Applicable socket types | all, when using TCP transport |
const Qore::ZMQ::ZMQ_GSSAPI_SERVER = ZMQ_GSSAPI_SERVER |
Set GSSAPI server role.
Defines whether the socket will act as server for GSSAPI security. A value of 1 means the socket will act as GSSAPI server. A value of 0 means the socket will act as GSSAPI client.
0MQ Socket Option Information
Property | Description |
Option value type | bool |
Option value unit | True, False |
Default value | False |
Applicable socket types | all, when using TCP transport |
const Qore::ZMQ::ZMQ_GSSAPI_SERVICE_PRINCIPAL = ZMQ_GSSAPI_SERVICE_PRINCIPAL |
Set name of GSSAPI service principal.
Sets the name of the principal of the GSSAPI server to which a GSSAPI client intends to connect.
0MQ Socket Option Information
Property | Description |
Option value type | character string |
Option value unit | N/A |
Default value | not set |
Applicable socket types | all, when using TCP transport |
const Qore::ZMQ::ZMQ_HANDSHAKE_IVL = ZMQ_HANDSHAKE_IVL |
Set maximum handshake interval.
The ZMQ_HANDSHAKE_IVL option shall set the maximum handshake interval for the specified socket. Handshaking is the exchange of socket configuration information (socket type, identity, security) that occurs when a connection is first opened, only for connection-oriented transports. If handshaking does not complete within the configured time, the connection shall be closed. The value 0 means no handshake time limit.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | milliseconds |
Default value | 30000 |
Applicable socket types | all but STREAM, only for connection-oriented transports |
const Qore::ZMQ::ZMQ_HEARTBEAT_IVL = ZMQ_HEARTBEAT_IVL |
Set interval between sending ZMTP heartbeats.
The ZMQ_HEARTBEAT_IVL option shall set the interval between sending ZMTP heartbeats for the specified socket. If this option is set and is greater than 0, then a PING
ZMTP command will be sent every ZMQ_HEARTBEAT_IVL milliseconds.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | milliseconds |
Default value | 0 |
Applicable socket types | all, when using connection-oriented transports |
const Qore::ZMQ::ZMQ_HEARTBEAT_TIMEOUT = ZMQ_HEARTBEAT_TIMEOUT |
Set timeout for ZMTP heartbeats.
The ZMQ_HEARTBEAT_TIMEOUT option shall set how long to wait before timing-out a connection after sending a PING
command and not receiving any traffic. This option is only valid if ZMQ_HEARTBEAT_IVL is also set, and is greater than 0. The connection will time out if there is no traffic received after sending the PING
command, but the received traffic does not have to be a PONG
command - any received traffic will cancel the timeout.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | milliseconds |
Default value | 0 |
Applicable socket types | all, when using connection-oriented transports |
const Qore::ZMQ::ZMQ_HEARTBEAT_TTL = ZMQ_HEARTBEAT_TTL |
Set the TTL value for ZMTP heartbeats.
The ZMQ_HEARTBEAT_TTL option shall set the timeout on the remote peer for ZMTP heartbeats. If this option is greater than 0, the remote side shall time out the connection if it does not receive any more traffic within the TTL period. This option does not have any effect if ZMQ_HEARTBEAT_IVL is not set or is 0. Internally, this value is rounded down to the nearest decisecond, any value less than 100 will have no effect.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | milliseconds |
Default value | 0 |
Applicable socket types | all, when using connection-oriented transports |
const Qore::ZMQ::ZMQ_IDENTITY = ZMQ_IDENTITY |
Set socket identity.
The ZMQ_IDENTITY option shall set the identity of the specified socket when connecting to a ROUTER socket. The identity should be from 1 to 255 bytes long and may contain any values.
If two clients use the same identity when connecting to a ROUTER, the results shall depend on the ZMQ_ROUTER_HANDOVER option setting. If that is not set (or set to the default of zero), the ROUTER socket shall reject clients trying to connect with an already-used identity. If that option is set to 1, the ROUTER socket shall hand-over the connection to the new client and disconnect the existing one.
0MQ Socket Option Information
Property | Description |
Option value type | binary data |
Option value unit | N/A |
Default value | NULL |
Applicable socket types | REQ, REP, ROUTER, DEALER. |
const Qore::ZMQ::ZMQ_IMMEDIATE = ZMQ_IMMEDIATE |
Queue messages only to completed connections.
By default queues will fill on outgoing connections even if the connection has not completed. This can lead to "lost" messages on sockets with round-robin routing (REQ, PUSH, DEALER). If this option is set to True, messages shall be queued only to completed connections. This will cause the socket to block if there are no other connections, but will prevent queues from filling on pipes awaiting connection.
0MQ Socket Option Information
Property | Description |
Option value type | bool |
Option value unit | True, False |
Default value | False |
Applicable socket types | all, only for connection-oriented transports. |
const Qore::ZMQ::ZMQ_INVERT_MATCHING = ZMQ_INVERT_MATCHING |
Invert message filtering.
Reverses the filtering behavior of PUB-SUB
sockets, when set to True.
On PUB and XPUB sockets, this causes messages to be sent to all connected sockets except those subscribed to a prefix that matches the message. On SUB sockets, this causes only incoming messages that do not match any of the socket's subscriptions to be received by the user.
Whenever ZMQ_INVERT_MATCHING is set to True on a PUB socket, all SUB sockets connecting to it must also have the option set to 1. Failure to do so will have the SUB sockets reject everything the PUB socket sends them. XSUB sockets do not need to do this because they do not filter incoming messages.
0MQ Socket Option Information
Property | Description |
Option value type | bool |
Option value unit | True, False |
Default value | False |
Applicable socket types | PUB, XPUB, SUB |
const Qore::ZMQ::ZMQ_IPV6 = ZMQ_IPV6 |
Enable IPv6 on socket.
Set the IPv6 option for the socket. A value of True means IPv6 is enabled on the socket, while False means the socket will use only IPv4. When IPv6 is enabled the socket will connect to, or accept connections from, both IPv4 and IPv6 hosts.
0MQ Socket Option Information
Property | Description |
Option value type | bool |
Option value unit | True, False |
Default value | False |
Applicable socket types | all, when using TCP transports. |
const Qore::ZMQ::ZMQ_LINGER = ZMQ_LINGER |
Set linger period for socket shutdown.
The ZMQ_LINGER option shall set 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 disconnected and further affects the termination of the socket's context.
he following outlines the different behaviours:
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | milliseconds |
Default value | 30000 (thirty seconds) |
Applicable socket types | all |
const Qore::ZMQ::ZMQ_MAXMSGSIZE = ZMQ_MAXMSGSIZE |
Maximum acceptable inbound message size.
Limits the size of the inbound message. If a peer sends a message larger than ZMQ_MAXMSGSIZE it is disconnected. Value of -1 means no limit.
0MQ Socket Option Information
Property | Description |
Option value type | int64_t |
Option value unit | bytes |
Default value | -1 |
Applicable socket types | all |
const Qore::ZMQ::ZMQ_MULTICAST_HOPS = ZMQ_MULTICAST_HOPS |
Maximum network hops for multicast packets.
Sets the time-to-live field in every multicast packet sent from this socket. The default is 1 which means that the multicast packets don't leave the local network.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | network hops |
Default value | 1 |
Applicable socket types | all, when using multicast transports |
const Qore::ZMQ::ZMQ_MULTICAST_MAXTPDU = ZMQ_MULTICAST_MAXTPDU |
Maximum transport data unit size for multicast packets.
Sets the maximum transport data unit size used for outbound multicast packets.
This must be set at or below the minimum Maximum Transmission Unit (MTU) for all network paths over which multicast reception is required.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | bytes |
Default value | 1500 |
Applicable socket types | all, when using multicast transports |
const Qore::ZMQ::ZMQ_PLAIN_PASSWORD = ZMQ_PLAIN_PASSWORD |
Set PLAIN security password.
Sets the password for outgoing connections over TCP or IPC. If you set this to a non-null value, the security mechanism used for connections shall be PLAIN. If you set this to a null value, the security mechanism used for connections shall be NULL.
0MQ Socket Option Information
Property | Description |
Option value type | character string |
Option value unit | N/A |
Default value | not set |
Applicable socket types | all, when using TCP transport |
const Qore::ZMQ::ZMQ_PLAIN_SERVER = ZMQ_PLAIN_SERVER |
Set PLAIN server role.
Defines whether the socket will act as server for PLAIN security, see zmq_plain(7). A value of 1 means the socket will act as PLAIN server. A value of 0 means the socket will not act as PLAIN server, and its security role then depends on other option settings. Setting this to 0 shall reset the socket security to NULL.
0MQ Socket Option Information
Property | Description |
Option value type | bool |
Option value unit | True, False |
Default value | False |
Applicable socket types | all, when using TCP transport |
const Qore::ZMQ::ZMQ_PLAIN_USERNAME = ZMQ_PLAIN_USERNAME |
Set PLAIN security username.
Sets the username for outgoing connections over TCP or IPC. If you set this to a non-null value, the security mechanism used for connections shall be PLAIN. If you set this to a null value, the security mechanism used for connections shall be NULL.
0MQ Socket Option Information
Property | Description |
Option value type | character string |
Option value unit | N/A |
Default value | not set |
Applicable socket types | all, when using TCP transport |
const Qore::ZMQ::ZMQ_PROBE_ROUTER = ZMQ_PROBE_ROUTER |
bootstrap connections to ROUTER sockets
When set to True, the socket will automatically send an empty message when a new connection is made or accepted. You may set this on ROUTER, DEALER, or ROUTER sockets connected to a ROUTER socket. The application must filter such empty messages. The ZMQ_PROBE_ROUTER option in effect provides the ROUTER application with an event signaling the arrival of a new peer.
0MQ Socket Option Information
Property | Description |
Option value type | bool |
Option value unit | True, False |
Default value | False |
Applicable socket types | ROUTER, DEALER, REQ |
const Qore::ZMQ::ZMQ_RATE = ZMQ_RATE |
Set multicast data rate.
The ZMQ_RATE option shall set the maximum send or receive data rate for multicast transports such as zmq_pgm(7) using the specified socket.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | kilobits per second |
Default value | 100 |
Applicable socket types | all, when using multicast transports |
const Qore::ZMQ::ZMQ_RCVBUF = ZMQ_RCVBUF |
Set kernel receive buffer size.
The ZMQ_RCVBUF option shall set the underlying kernel receive buffer size for the socket to the specified size in bytes. A value of -1 means leave the OS default unchanged. For details refer to your operating system documentation for the SO_RCVBUF socket option.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | bytes |
Default value | -1 |
Applicable socket types | all |
const Qore::ZMQ::ZMQ_RCVHWM = ZMQ_RCVHWM |
Set high water mark for inbound messages.
The ZMQ_RCVHWM option shall set the high water mark for inbound messages on 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 specified socket is communicating with. A value of zero means no limit.
If this limit has been reached the socket shall enter an exceptional state and depending on the socket type, ØMQ shall take appropriate action such as blocking or dropping sent messages. Refer to the individual socket descriptions for details on the exact action taken for each socket type.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | messages |
Default value | 1000 |
Applicable socket types | all |
const Qore::ZMQ::ZMQ_RCVTIMEO = ZMQ_RCVTIMEO |
Maximum time before a recv operation returns with EAGAIN
.
Sets the timeout for receive operation on the socket. If the value is 0, a receive operation will return immediately with an EAGAIN
error if there is no message to receive. If the value is -1, it will block until a message is available. For all other values, it will wait for a message for that amount of time before returning with an EAGAIN
error.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | milliseconds |
Default value | -1 (infinite) |
Applicable socket types | all |
const Qore::ZMQ::ZMQ_RECONNECT_IVL = ZMQ_RECONNECT_IVL |
Set reconnection interval.
The ZMQ_RECONNECT_IVL option shall set 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 connection-oriented transports. The value -1 means no reconnection.
The reconnection interval may be randomized by ØMQ to prevent reconnection storms in topologies with a large number of peers per socket.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | milliseconds |
Default value | 100 |
Applicable socket types | all, only for connection-oriented transports |
const Qore::ZMQ::ZMQ_RECONNECT_IVL_MAX = ZMQ_RECONNECT_IVL_MAX |
Set maximum reconnection interval.
The ZMQ_RECONNECT_IVL_MAX
option shall set 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 shall be doubled until ZMQ_RECONNECT_IVL_MAX
is reached. This allows for exponential backoff strategy. Default value means no exponential backoff is performed and reconnect interval calculations are only based on ZMQ_RECONNECT_IVL.
Values less than ZMQ_RECONNECT_IVL will be ignored.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | milliseconds |
Default value | 0 (only use ZMQ_RECONNECT_IVL) |
Applicable socket types | all, only for connection-oriented transports |
const Qore::ZMQ::ZMQ_RECOVERY_IVL = ZMQ_RECOVERY_IVL |
Set multicast recovery interval.
The ZMQ_RECOVERY_IVL option shall set the recovery interval for multicast transports using the specified socket. The recovery interval determines the maximum time in milliseconds that a receiver can be absent from a multicast group before unrecoverable data loss will occur.
Exercise care when setting large recovery intervals as the data needed for recovery will be held in memory. For example, a 1 minute recovery interval at a data rate of 1Gbps requires a 7GB in-memory buffer.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | milliseconds |
Default value | 10000 |
Applicable socket types | all, when using multicast transports |
const Qore::ZMQ::ZMQ_REQ_CORRELATE = ZMQ_REQ_CORRELATE |
match replies with requests
The default behaviour of REQ sockets is to rely on the ordering of messages to match requests and responses and that is usually sufficient. When this option is set to 1, the REQ socket will prefix outgoing messages with an extra frame containing a request id. That means the full message is (request id, 0, user frames…). The REQ socket will discard all incoming messages that don't begin with these two frames.
0MQ Socket Option Information
Property | Description |
Option value type | bool |
Option value unit | True, False |
Default value | False |
Applicable socket types | REQ |
const Qore::ZMQ::ZMQ_REQ_RELAXED = ZMQ_REQ_RELAXED |
relax strict alternation between request and reply
By default, a REQ socket does not allow initiating a new request with send() until the reply to the previous one has been received. When set to True, sending another message is allowed and previous replies will be discarded if any. The request-reply state machine is reset and a new request is sent to the next available peer.
If set to True, also enable ZMQ_REQ_CORRELATE to ensure correct matching of requests and replies. Otherwise a late reply to an aborted request can be reported as the reply to the superseding request.
0MQ Socket Option Information
Property | Description |
Option value type | bool |
Option value unit | True, False |
Default value | False |
Applicable socket types | REQ |
const Qore::ZMQ::ZMQ_ROUTER_HANDOVER = ZMQ_ROUTER_HANDOVER |
handle duplicate client identities on ROUTER sockets
If two clients use the same identity when connecting to a ROUTER, the results shall depend on the ZMQ_ROUTER_HANDOVER
option setting. If that is not set (or set to the default of zero), the ROUTER socket shall reject clients trying to connect with an already-used identity. If that option is set to True, the ROUTER socket shall hand-over the connection to the new client and disconnect the existing one.
0MQ Socket Option Information
Property | Description |
Option value type | bool |
Option value unit | True, False |
Default value | False |
Applicable socket types | ROUTER |
const Qore::ZMQ::ZMQ_ROUTER_MANDATORY = ZMQ_ROUTER_MANDATORY |
accept only routable messages on ROUTER sockets
Sets the ROUTER socket behaviour when an unroutable message is encountered. A value of False is the default and discards the message silently when it cannot be routed or the peers SNDHWM
is reached. A value of True returns an EHOSTUNREACH
error code if the message cannot be routed or EAGAIN
error code if the SNDHWM
is reached and ZMQ_DONTWAIT
was used. Without ZMQ_DONTWAIT
it will block until the SNDTIMEO
is reached or a spot in the send queue opens up.
0MQ Socket Option Information
Property | Description |
Option value type | bool |
Option value unit | True, False |
Default value | False |
Applicable socket types | ROUTER |
const Qore::ZMQ::ZMQ_SNDBUF = ZMQ_SNDBUF |
Set kernel transmit buffer size.
The ZMQ_SNDBUF
option shall set the underlying kernel transmit buffer size for the socket to the specified size in bytes. A value of -1 means leave the OS default unchanged. For details please refer to your operating system documentation for the SO_SNDBUF
socket option.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | bytes |
Default value | -1 |
Applicable socket types | all |
const Qore::ZMQ::ZMQ_SNDHWM = ZMQ_SNDHWM |
Set the high water mark for outbound messages.
If this limit has been reached the socket shall enter an exceptional state and depending on the socket type, ØMQ shall take appropriate action such as blocking or dropping sent messages. Refer to the individual socket descriptions for details on the exact action taken for each socket type.
ØMQ does not guarantee that the socket will accept as many messages as set here, and the actual limit may be as much as 60-70% lower depending on the flow of messages on the socket.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | messages |
Default value | 1000 |
Applicable socket types | all |
const Qore::ZMQ::ZMQ_SNDTIMEO = ZMQ_SNDTIMEO |
Maximum time before a send operation returns with EAGAIN
.
Sets the timeout for send operation on the socket. If the value is 0, send operations will return immediately with an EAGAIN
error if the message cannot be sent. If the value is -1, it will block until the message is sent. For all other values, it will try to send the message for that amount of time before returning with an EAGAIN
error.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | milliseconds |
Default value | -1 (infinite) |
Applicable socket types | all |
const Qore::ZMQ::ZMQ_SOCKS_PROXY = ZMQ_SOCKS_PROXY |
Set SOCKS5 proxy address.
Sets the SOCKS5 proxy address that shall be used by the socket for the TCP connection(s). Does not support SOCKS5 authentication. If the endpoints are domain names instead of addresses they shall not be resolved and they shall be forwarded unchanged to the SOCKS proxy service in the client connection request message (address type 0x03
domain name).
0MQ Socket Option Information
Property | Description |
Option value type | character string |
Option value unit | N/A |
Default value | not set |
Applicable socket types | all, when using TCP transport |
const Qore::ZMQ::ZMQ_STREAM_NOTIFY = ZMQ_STREAM_NOTIFY |
send connect and disconnect notifications
Enables connect and disconnect notifications on a STREAM socket when set to True. When notifications are enabled, the socket delivers a zero-length message when a peer connects or disconnects.
0MQ Socket Option Information
Property | Description |
Option value type | bool |
Option value unit | True, False |
Default value | False |
Applicable socket types | STREAM |
const Qore::ZMQ::ZMQ_SUBSCRIBE = ZMQ_SUBSCRIBE |
Establish message filter.
The ZMQ_SUBSCRIBE
option shall establish a new message filter on a SUB socket. Newly created SUB sockets shall filter out all incoming messages, therefore you should call this option to establish an initial message filter.
An empty option_value of length zero shall subscribe to all incoming messages. A non-empty option_value shall subscribe to all messages beginning with the specified prefix. Multiple filters may be attached to a single SUB socket, in which case a message shall be accepted if it matches at least one filter.
0MQ Socket Option Information
Property | Description |
Option value type | binary data |
Option value unit | N/A |
Default value | N/A |
Applicable socket types | SUB |
const Qore::ZMQ::ZMQ_TCP_KEEPALIVE = ZMQ_TCP_KEEPALIVE |
Override SO_KEEPALIVE
socket option.
Override SO_KEEPALIVE
socket option (where supported by OS). The default value of -1 means to skip any overrides and leave it to OS default.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | -1,0,1 |
Default value | -1 (leave to OS default) |
Applicable socket types | all, when using TCP transports. |
const Qore::ZMQ::ZMQ_TCP_KEEPALIVE_CNT = ZMQ_TCP_KEEPALIVE_CNT |
Override TCP_KEEPCNT
socket option.
Override TCP_KEEPCNT
socket option (where supported by OS). The default value of -1 means to skip any overrides and leave it to OS default.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | -1,>0 |
Default value | -1 (leave to OS default) |
Applicable socket types | all, when using TCP transports. |
const Qore::ZMQ::ZMQ_TCP_KEEPALIVE_IDLE = ZMQ_TCP_KEEPALIVE_IDLE |
Override TCP_KEEPIDLE
(or TCP_KEEPALIVE
on some OSes)
Override TCP_KEEPIDLE
(or TCP_KEEPALIVE
on some OSes) socket option (where supported by OS). The default value of -1 means to skip any overrides and leave it to OS default.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | -1,>0 |
Default value | -1 (leave to OS default) |
Applicable socket types | all, when using TCP transports. |
const Qore::ZMQ::ZMQ_TCP_KEEPALIVE_INTVL = ZMQ_TCP_KEEPALIVE_INTVL |
Override TCP_KEEPINTVL
socket option.
Override TCP_KEEPINTVL
socket option(where supported by OS). The default value of -1 means to skip any overrides and leave it to OS default.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | -1,>0 |
Default value | -1 (leave to OS default) |
Applicable socket types | all, when using TCP transports. |
const Qore::ZMQ::ZMQ_TCP_MAXRT = ZMQ_TCP_MAXRT |
Set TCP Maximum Retransmit Timeout.
On OSes where it is supported, sets how long before an unacknowledged TCP retransmit times out. The system normally attempts many TCP retransmits following an exponential backoff strategy. This means that after a network outage, it may take a long time before the session can be re-established. Setting this option allows the timeout to happen at a shorter interval.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | milliseconds |
Default value | 0 (leave to OS default) |
Applicable socket types | all, when using TCP transports. |
const Qore::ZMQ::ZMQ_TOS = ZMQ_TOS |
Set the Type-of-Service on socket.
Sets the ToS fields (Differentiated services (DS) and Explicit Congestion Notification (ECN) field of the IP header. The ToS field is typically used to specify a packets priority. The availability of this option is dependent on intermediate network equipment that inspect the ToS field and provide a path for low-delay, high-throughput, highly-reliable service, etc.
0MQ Socket Option Information
Property | Description |
Option value type | int |
Option value unit | >0 |
Default value | 0 |
Applicable socket types | all, only for connection-oriented transports |
const Qore::ZMQ::ZMQ_UNSUBSCRIBE = ZMQ_UNSUBSCRIBE |
Remove message filter.
The ZMQ_UNSUBSCRIBE
option shall remove an existing message filter on a SUB socket. The filter specified must match an existing filter previously established with the ZMQ_SUBSCRIBE option. If the socket has several instances of the same filter attached the ZMQ_UNSUBSCRIBE
option shall remove only one instance, leaving the rest in place and functional.
0MQ Socket Option Information
Property | Description |
Option value type | binary data |
Option value unit | N/A |
Default value | N/A |
Applicable socket types | SUB |
const Qore::ZMQ::ZMQ_XPUB_MANUAL = ZMQ_XPUB_MANUAL |
change the subscription handling to manual
Sets the XPUB socket subscription handling mode manual/automatic. A value of False is the default and subscription requests will be handled automatically. A value of True will change the subscription requests handling to manual, with manual mode subscription requests are not added to the subscription list. To add subscription the user needs to set the subscription on the socket manually by setting the ZMQ_SUBSCRIBE option on the XPUB socket with ZSocket::setOption().
0MQ Socket Option Information
Property | Description |
Option value type | bool |
Option value unit | True, False |
Default value | False |
Applicable socket types | XPUB |
const Qore::ZMQ::ZMQ_XPUB_NODROP = ZMQ_XPUB_NODROP |
do not silently drop messages if SENDHWM
is reached
Sets the XPUB socket behaviour to return error EAGAIN
if SENDHWM
is reached and the message could not be sent.
A value of False is the default and drops the message silently when the peer's SNDHWM
is reached. A value of True returns an EAGAIN
error code if the SNDHWM
is reached and ZMQ_DONTWAIT
was used.
0MQ Socket Option Information
Property | Description |
Option value type | bool |
Option value unit | True, False |
Default value | False |
Applicable socket types | XPUB, PUB |
const Qore::ZMQ::ZMQ_XPUB_VERBOSE = ZMQ_XPUB_VERBOSE |
pass subscribe messages on an XPUB socket
Sets the XPUB socket behaviour on new subscriptions. If enabled, the socket passes all subscribe messages to the caller. If disabled, these are not visible to the caller. The default is False (disabled).
0MQ Socket Option Information
Property | Description |
Option value type | bool |
Option value unit | True, False |
Default value | False |
Applicable socket types | XPUB |
const Qore::ZMQ::ZMQ_XPUB_VERBOSER = ZMQ_XPUB_VERBOSER |
pass subscribe and unsubscribe messages on XPUB socket
Sets the XPUB socket behaviour on new subscriptions and ubsubscriptions. If enabled, the socket passes all subscribe and unsubscribe messages to the caller. If disabled, these are not visible to the caller. The default is False (disabled).
0MQ Socket Option Information
Property | Description |
Option value type | bool |
Option value unit | True, False |
Default value | False |
Applicable socket types | XPUB |
const Qore::ZMQ::ZMQ_XPUB_WELCOME_MSG = ZMQ_XPUB_WELCOME_MSG |
Set welcome message that will be received by subscriber when connecting.
Sets a welcome message the will be recieved by subscriber when connecting.
The subscriber must subscribe to the welcome message before connecting.
Welcome message will also be sent on reconnecting. For the welcome message to work well, the user must poll on incoming subscription messages on the XPUB socket and handle them.
Use NULL and length of zero to disable the welcome message.
0MQ Socket Option Information
Property | Description |
Option value type | binary data |
Option value unit | N/A |
Default value | NULL |
Applicable socket types | XPUB |
const Qore::ZMQ::ZMQ_ZAP_DOMAIN = ZMQ_ZAP_DOMAIN |
Set RFC 27 authentication domain.
Sets the domain for ZAP (ZMQ RFC 27) authentication. For NULL security (the default on all tcp:// connections), ZAP authentication only happens if you set a non-empty domain.
For PLAIN and CURVE security, ZAP requests are always made, if there is a ZAP handler present. See http://rfc.zeromq.org/spec:27 for more details.
0MQ Socket Option Information
Property | Description |
Option value type | character string |
Option value unit | N/A |
Default value | not set |
Applicable socket types | all, when using TCP transport |