ZMQ
Namespace: fszmq
Contains commonly-used pre-defined ZMQ values
Nested types and modules
| Type | Description |
| SocketType | Distinguishes socket roles from other intergral values |
Functions and values
| Function or value | Description |
AFFINITY
Signature: int
|
(UInt64) I/O thread affinity bit-mask |
BACKLOG
Signature: int
|
(Int32) Maximum number of queued peers |
CAP_CURVE
Signature: string
|
Used to test if library supports the CURVE security mechanism |
CAP_GSSAPI
Signature: string
|
Used to test if library supports the GSSAPI security mechanism |
CAP_IPC
Signature: string
|
Used to test if library supports the IPC transport protocol |
CAP_NORM
Signature: string
|
Used to test if library supports the NORM transport protocol |
CAP_PGM
Signature: string
|
Used to test if library supports the PGM transport protocol |
CAP_TIPC
Signature: string
|
Used to test if library supports the TIPC transport protocol |
CONFLATE
Signature: int
|
(Int32) 1 to keep last message in queue (ignores high-water mark options), 0 otherwise |
CONNECT_RID
Signature: int
|
(Byte[]) Sets the peer ID of the next connected host, and immediately readies that connection for data transfer with the named ID |
CURVE_PUBLICKEY
Signature: int
|
(String or Byte[]) sets the long-term public key on a client or server socket |
CURVE_SECRETKEY
Signature: int
|
(String or Byte[]) sets the long-term secret key on a client socket |
CURVE_SERVER
Signature: int
|
(Int32) 1 to make socket act as server for CURVE security, 0 otherwise |
CURVE_SERVERKEY
Signature: int
|
(String or Byte[]) sets the long-term server key on a client socket |
DEALER
Signature: int<MeasureProduct<SocketType,MeasureOne>>
|
Participates in asynchronous request/reply exchanges with compatible peers (i.e. ZMQ.REP, ZMQ.DEALER, ZMQ.ROUTER) |
DELAY_ATTACH_ON_CONNECT
Signature: int
|
Deprecated. Use ZMQ.IMMEDAITE |
DONTWAIT
Signature: int
|
Queue message frame for sending (return immediately) |
EVENT_ACCEPT_FAILED
Signature: uint16
|
Could not accept client connection |
EVENT_ACCEPTED
Signature: uint16
|
Connection accepted to bound interface |
EVENT_ALL
Signature: uint16
|
Monitor all possible events |
EVENT_BIND_FAILED
Signature: uint16
|
Socket could not bind to address |
EVENT_CLOSE_FAILED
Signature: uint16
|
Connection could not be closed (only for ipc transport) |
EVENT_CLOSED
Signature: uint16
|
Socket connection closed |
EVENT_CONNECT_DELAYED
Signature: uint16
|
Synchronous connection failed; socket is being polled |
EVENT_CONNECT_RETRIED
Signature: uint16
|
Asynchronous (re)connection attempt |
EVENT_CONNECTED
Signature: uint16
|
Socket connection established |
EVENT_DISCONNECTED
Signature: uint16
|
Broken session (specific to ipc and tcp transports) |
EVENT_LISTENING
Signature: uint16
|
Socket bound to address; ready to accept connections |
EVENT_MONITOR_STOPPED
Signature: uint16
|
Event monitoring has been disabled |
EVENTS
Signature: int
|
(Int32) Socket event state, see all: Polling |
FAIL_UNROUTABLE
Signature: int
|
Deprecated. Use ZMQ.ROUTER_MANDATORY |
FD
Signature: int
|
(IntPtr) native file descriptor |
FOREVER
Signature: int64
|
indicates polling should wait indefinitely |
GSSAPI_PLAINTEXT
Signature: int
|
(Int32) 1 means that GSSAPI communication will be plaintext, 0 means communications will be encrypted |
GSSAPI_PRINCIPAL
Signature: int
|
(String) The name of the pricipal for whom GSSAPI credentials should be acquired |
GSSAPI_SERVER
Signature: int
|
(Int32) 1 means the socket will act as GSSAPI server; 0 means the socket will act as GSSAPI client |
GSSAPI_SERVICE_PRINCIPAL
Signature: int
|
(String) The name of the pricipal of the GSSAPI server to which a GSSAPI client intends to connect |
HANDSHAKE_IVL
Signature: int
|
(Int32) The maximum handshake interval in milliseconds for the specified socket |
has(capability)
Signature: capability:string -> Capability
|
Tests if the underlying (native) ZMQ library supports a given capability CompiledName: |
IDENTITY
Signature: int
|
(Byte[]) Socket identifier |
IMMEDIATE
Signature: int
|
(Int32) 1 to limit queuing to only completed connections, 0 otherwise |
IO_THREADS
Signature: int
|
(Int32) Set number of OS-level I/O threads |
IO_THREADS_DFLT
Signature: int
|
Default number of OS-level I/O threads (1) |
IPC_FILTER_GID
Signature: int
|
Deprecated. Do not use. |
IPC_FILTER_PID
Signature: int
|
Deprecated. Do not use. |
IPC_FILTER_UID
Signature: int
|
Deprecated. Do not use. |
IPV4ONLY
Signature: int
|
Deprecated. Do not use. |
IPV6
Signature: int
|
(Int32) 1 to enable IPv6 on the socket, 0 to restrict to only IPv4 |
LAST_ENDPOINT
Signature: int
|
(String) Last address bound to endpoint |
LINGER
Signature: int
|
(Int32) Pause before shutdown in milliseconds |
MAX_SOCKETS
Signature: int
|
(Int32) Set maximum number of sockets for a context |
MAX_SOCKETS_DFLT
Signature: int
|
Default maximum number of sockets (1024) |
MAXMSGSIZE
Signature: int
|
(Int64) Maximum inbound message size in bytes |
MECHANISM
Signature: int
|
(Int32) Returns the current security mechanism |
MORE
Signature: int
|
(Int32) 1 if more message frames are available, 0 otherwise |
MULTICAST_HOPS
Signature: int
|
(Int32) Time-to-live for each multicast packet in network-hops |
NO_LINGER
Signature: int
|
(Int32) the value needed to disable lingering on a socket's outbound queue |
NOBLOCK
Signature: int
|
Deprecated. Use ZMQ.DONTWAIT |
NOW
Signature: int64
|
indicates polling should exit immediately |
PAIR
Signature: int<MeasureProduct<SocketType,MeasureOne>>
|
An exclusive pair of two sockets (primarily for use with inproc transport) |
PAUSE
Signature: byte []
|
Command used to temporarily suspend a steerable proxy |
PLAIN_PASSWORD
Signature: int
|
(String) Sets the password for outgoing connections over TCP or IPC |
PLAIN_SERVER
Signature: int
|
(Int32) 1 to make socket act as server for PLAIN security, 0 otherwise |
PLAIN_USERNAME
Signature: int
|
(String) Sets the user name for outgoing connections over TCP or IPC |
POLLERR
Signature: int16
|
poll for messages on stderr (for use with file descriptors) |
POLLIN
Signature: int16
|
poll for inbound messages |
POLLOUT
Signature: int16
|
poll for outbound messages |
PROBE_ROUTER
Signature: int
|
(Int32) 1 to automatically send an empty message on new connection, 0 otherwise |
PUB
Signature: int<MeasureProduct<SocketType,MeasureOne>>
|
A publisher which broadcasts topic-prefixed messages |
PULL
Signature: int<MeasureProduct<SocketType,MeasureOne>>
|
Collects messages in a fair-queued fashion from across all upstream (i.e. ZMQ.PUSH) nodes |
PUSH
Signature: int<MeasureProduct<SocketType,MeasureOne>>
|
Delivers messages in a round-robin fashion to across all downstream (i.e. ZMQ.PULL) nodes |
RATE
Signature: int
|
(Int32) Multicast data rate in kilobits per second |
RCVBUF
Signature: int
|
(Int32) Receive-message buffer size in bytes |
RCVHWM
Signature: int
|
(Int32) Maximum number of inbound queued messages |
RCVMORE
Signature: int
|
(Int32) 1 if more message frames are available, 0 otherwise |
RCVTIMEO
Signature: int
|
(Int32) Timeout period for inbound messages in milliseconds |
RECONNECT_IVL
Signature: int
|
(Int32) Pause before reconnect in milliseconds |
RECONNECT_IVL_MAX
Signature: int
|
(Int32) Maximum reconnection interval in milliseconds |
RECOVERY_IVL
Signature: int
|
(Int32) Multicast recovery period in milliseconds |
REP
Signature: int<MeasureProduct<SocketType,MeasureOne>>
|
Awaits synchronous requests of a client (i.e. ZMQ.REQ, ZMQ.DEALER), makes replies |
REQ
Signature: int<MeasureProduct<SocketType,MeasureOne>>
|
Makes synchronous requests of a server (i.e. ZMQ.REP, ZMQ.ROUTER), awaits replies |
REQ_CORRELATE
Signature: int
|
(Int32) 1 to prefix messages with explicit request ID, 0 otherwise |
REQ_RELAXED
Signature: int
|
(Int32) 1 to relax strict alternation between ZMQ.REQ and ZMQ.REP, 0 otherwise |
RESUME
Signature: byte []
|
Command used to resume a suspended steerable proxy |
ROUTER
Signature: int<MeasureProduct<SocketType,MeasureOne>>
|
Participates in asynchronous request/reply exchanges with compatible peers (i.e. ZMQ.REQ, ZMQ.DEALER, ZMQ.ROUTER) |
ROUTER_BEHAVIOR
Signature: int
|
Deprecated. Use ZMQ.ROUTER_MANDATORY |
ROUTER_HANDOVER
Signature: int
|
(Int32) 0 to reject clients which use an existing identity, 1 to transfer the connection |
ROUTER_MANDATORY
Signature: int
|
(Int32) 1 to error on unroutable messages, 0 to silently ignore |
ROUTER_RAW
Signature: int
|
Deprecated. Use ZMQ.STREAM socket instead |
SECURITY_CURVE
Signature: int
|
Indicates CURVE security mechanism is currently in use |
SECURITY_GSSAPI
Signature: int
|
Indicates GSSAPI security mechanism is currently in use |
SECURITY_NULL
Signature: int
|
Indicates there is currently no security mechanism in use |
SECURITY_PLAIN
Signature: int
|
Indicates PLAIN security mechanism is currently in use |
SHARED
Signature: int
|
(Int32) 1 indicates that a message MAY share underlying storage, 0 otherwise |
SNDBUF
Signature: int
|
(Int32) Send-message buffer size in bytes |
SNDHWM
Signature: int
|
(Int32) Maximum number of outbound queued messages |
SNDMORE
Signature: int
|
More message frames will follow the current frame |
SNDTIMEO
Signature: int
|
(Int32) Timeout period for outbound messages in milliseconds |
SOCKET_LIMIT
Signature: int
|
(Int32) Get largest configurable number of sockets |
SOCKS_PROXY
Signature: int
|
(String) SOCKS5 proxy |
SRCFD
Signature: int
|
(IntPtr) The file descriptor of the socket from which the 'message' was read |
STREAM
Signature: int<MeasureProduct<SocketType,MeasureOne>>
|
Exchanges raw data with a non-ZeroMQ peer via the tcp transport |
SUB
Signature: int<MeasureProduct<SocketType,MeasureOne>>
|
A subscribe which receives topic-prefixed messages |
SUBSCRIBE
Signature: int
|
(Byte[]) Add subscription filter |
TCP_ACCEPT_FILTER
Signature: int
|
Deprecated. Do not use. |
TCP_KEEPALIVE
Signature: int
|
(Int32) Override OS-level TCP keep-alive |
TCP_KEEPALIVE_CNT
Signature: int
|
(Int32) Override OS-level TCP keep-alive |
TCP_KEEPALIVE_IDLE
Signature: int
|
(Int32) Override OS-level TCP keep-alive |
TCP_KEEPALIVE_INTVL
Signature: int
|
(Int32) Override OS-level TCP keep-alive |
TERMINATE
Signature: byte []
|
Command used to cleanly shutdown a steerable proxy |
THREAD_PRIORITY
Signature: int
|
(Int32) Change thread scheduling priority (only valid on systems which use pthread) |
THREAD_PRIORITY_DFLT
Signature: int
|
Default thread scheduling priority (-1) |
THREAD_SCHED_POLICY
Signature: int
|
(Int32) Set thread scheduling policy (only valid on systems which use pthread) |
THREAD_SCHED_POLICY_DFLT
Signature: int
|
Default thread scheduling policy (-1) |
TOS
Signature: int
|
(Int32) ToS field is typically used to specify a packets priority; The availability of this option is dependent on intermediate network equipment |
TYPE
Signature: int
|
(Int32) Socket type |
UNSUBSCRIBE
Signature: int
|
(Byte[]) Remove subscription filter |
version
Signature: Version
|
Version of the underlying (native) ZMQ library CompiledName: |
WAIT
Signature: int
|
Block thread until message frame is sent |
XPUB
Signature: int<MeasureProduct<SocketType,MeasureOne>>
|
A publisher like ZMQ.PUB, but does not automatically receive forwarded topic subscriptions |
XPUB_NODROP
Signature: int
|
(Int32) 0 drops the message silently when the peers SNDHWM is reached, 1 returns an 'EAGAIN' error code (if ZMQ_DONTWAIT was used) |
XPUB_VERBOSE
Signature: int
|
(Int32) 1 will resend duplicate messages |
XREP
Signature: int<MeasureProduct<SocketType,MeasureOne>>
|
Deprecated. Use ZMQ.ROUTER |
XREQ
Signature: int<MeasureProduct<SocketType,MeasureOne>>
|
Deprecated. Use ZMQ.DEALER |
XSUB
Signature: int<MeasureProduct<SocketType,MeasureOne>>
|
A publisher like ZMQ.SUB, but does not automatically forward topic subscriptions |
ZAP_DOMAIN
Signature: int
|
(String) Sets authentication domain |
Active patterns
| Active pattern | Description |
( |EAGAIN|_| )(errno)
Signature: errno:int -> unit option
|
Non-blocking mode was requested and the message cannot be sent at the moment CompiledName: |
