The ZMQ class

(No version information available, might only be in Git)

Introduction

Class synopsis

ZMQ {

/* Constants */

const integer SOCKET_PAIR ;

const integer SOCKET_PUB ;

const integer SOCKET_SUB ;

const integer SOCKET_REQ ;

const integer SOCKET_REP ;

const integer SOCKET_XREQ ;

const integer SOCKET_XREP ;

const integer SOCKET_PUSH ;

const integer SOCKET_PULL ;

const integer SOCKET_ROUTER ;

const integer SOCKET_DEALER ;

const integer SOCKET_XPUB ;

const integer SOCKET_XSUB ;

const integer SOCKET_STREAM ;

const integer SOCKOPT_HWM ;

const integer SOCKOPT_SNDHWM ;

const integer SOCKOPT_RCVHWM ;

const integer SOCKOPT_AFFINITY ;

const integer SOCKOPT_IDENTITY ;

const integer SOCKOPT_SUBSCRIBE ;

const integer SOCKOPT_UNSUBSCRIBE ;

const integer SOCKOPT_RATE ;

const integer SOCKOPT_RECOVERY_IVL ;

const integer SOCKOPT_RECONNECT_IVL ;

const integer SOCKOPT_RECONNECT_IVL_MAX ;

const integer SOCKOPT_MCAST_LOOP ;

const integer SOCKOPT_SNDBUF ;

const integer SOCKOPT_RCVBUF ;

const integer SOCKOPT_RCVMORE ;

const integer SOCKOPT_TYPE ;

const integer SOCKOPT_LINGER ;

const integer SOCKOPT_BACKLOG ;

const integer SOCKOPT_MAXMSGSIZE ;

const integer SOCKOPT_SNDTIMEO ;

const integer SOCKOPT_RCVTIMEO ;

const integer SOCKOPT_IPV4ONLY ;

const integer SOCKOPT_LAST_ENDPOINT ;

const integer SOCKOPT_TCP_KEEPALIVE_IDLE ;

const integer SOCKOPT_TCP_KEEPALIVE_CNT ;

const integer SOCKOPT_TCP_KEEPALIVE_INTVL ;

const integer SOCKOPT_TCP_ACCEPT_FILTER ;

const integer SOCKOPT_DELAY_ATTACH_ON_CONNECT ;

const integer SOCKOPT_XPUB_VERBOSE ;

const integer SOCKOPT_ROUTER_RAW ;

const integer SOCKOPT_IPV6 ;

const integer CTXOPT_MAX_SOCKETS ;

const integer POLL_IN ;

const integer POLL_OUT ;

const integer MODE_NOBLOCK ;

const integer MODE_DONTWAIT ;

const integer MODE_SNDMORE ;

const integer ERR_INTERNAL ;

const integer ERR_EAGAIN ;

const integer ERR_ENOTSUP ;

const integer ERR_EFSM ;

const integer ERR_ETERM ;

/* Methods */

private__construct ( void )

}

Predefined Constants

ZMQ Constant Types

ZMQ::SOCKET_PAIR: Exclusive pair pattern
ZMQ::SOCKET_PUB: Publisher socket
ZMQ::SOCKET_SUB: Subscriber socket
ZMQ::SOCKET_REQ: Request socket
ZMQ::SOCKET_REP: Reply socket
ZMQ::SOCKET_XREQ: Alias for SOCKET_DEALER
ZMQ::SOCKET_XREP: Alias for SOCKET_ROUTER
ZMQ::SOCKET_PUSH: Pipeline upstream push socket
ZMQ::SOCKET_PULL: Pipeline downstream pull socket
ZMQ::SOCKET_ROUTER: Extended REP socket that can route replies to requesters
ZMQ::SOCKET_DEALER: Extended REQ socket that load balances to all connected peers
ZMQ::SOCKET_XPUB: Similar to SOCKET_PUB, except you can receive subscriptions as messages. The subscription message is 0 (unsubscribe) or 1 (subscribe) followed by the topic.
ZMQ::SOCKET_XSUB: Similar to SOCKET_SUB, except you can send subscriptions as messages. See SOCKET_XPUB for format.
ZMQ::SOCKET_STREAM: Used to send and receive TCP data from a non-ØMQ peer. Available if compiled against ZeroMQ 4.x or higher (Value: integer).
ZMQ::SOCKOPT_HWM: The high water mark for inbound and outbound messages 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. Setting this option on a socket will only affect connections made after the option has been set. On ZeroMQ 3.x this is a wrapper for setting both SNDHWM and RCVHWM. (Value: integer).
ZMQ::SOCKOPT_SNDHWM: The ZMQ_SNDHWM option shall set the high water mark for outbound messages on the specified socket. Available if compiled against ZeroMQ 3.x or higher (Value: integer).
ZMQ::SOCKOPT_RCVHWM: The SOCKOPT_RCVHWM option shall set the high water mark for inbound messages on the specified socket. Available if compiled against ZeroMQ 3.x or higher (Value: integer).
ZMQ::SOCKOPT_AFFINITY: Set I/O thread affinity (Value: integer)
ZMQ::SOCKOPT_IDENTITY: Set socket identity (Value: string)
ZMQ::SOCKOPT_SUBSCRIBE: Establish message filter. Valid for subscriber socket (Value: string)
ZMQ::SOCKOPT_UNSUBSCRIBE: Remove message filter. Valid for subscriber socket (Value: string)
ZMQ::SOCKOPT_RATE: Set rate for multicast sockets (pgm) (Value: integer >= 0)
ZMQ::SOCKOPT_RECOVERY_IVL: Set multicast recovery interval (Value: integer >= 0)
ZMQ::SOCKOPT_RECONNECT_IVL: Set the initial reconnection interval (Value: integer >= 0)
ZMQ::SOCKOPT_RECONNECT_IVL_MAX: Set the max reconnection interval (Value: integer >= 0)
ZMQ::SOCKOPT_MCAST_LOOP: Control multicast loopback (Value: integer >= 0)
ZMQ::SOCKOPT_SNDBUF: Set kernel transmit buffer size (Value: integer >= 0)
ZMQ::SOCKOPT_RCVBUF: Set kernel receive buffer size (Value: integer >= 0)
ZMQ::SOCKOPT_RCVMORE: Receive multi-part messages (Value: integer)
ZMQ::SOCKOPT_TYPE: Get the socket type. Valid for getSockOpt (Value: integer)
ZMQ::SOCKOPT_LINGER: The linger value of the socket. Specifies how long the socket blocks trying flush messages after it has been closed (Value: integer)
ZMQ::SOCKOPT_BACKLOG: The SOCKOPT_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. (Value: integer)
ZMQ::SOCKOPT_MAXMSGSIZE: Limits the maximum size of the inbound message. Value -1 means no limit. Available if compiled against ZeroMQ 3.x or higher (Value: integer)
ZMQ::SOCKOPT_SNDTIMEO: Sets the timeout for send operation on the socket. Value -1 means no limit. Available if compiled against ZeroMQ 3.x or higher (Value: integer)
ZMQ::SOCKOPT_RCVTIMEO: Sets the timeout for receive operation on the socket. Value -1 means no limit. Available if compiled against ZeroMQ 3.x or higher (Value: integer)
ZMQ::SOCKOPT_IPV4ONLY: Disable IPV6 support if 1. Available if compiled against ZeroMQ 3.x (Value: integer)
ZMQ::SOCKOPT_LAST_ENDPOINT: Retrieve the last connected endpoint - for use with * wildcard ports. Available if compiled against ZeroMQ 3.x or higher (Value: string)
ZMQ::SOCKOPT_TCP_KEEPALIVE_IDLE: Idle time for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: integer)
ZMQ::SOCKOPT_TCP_KEEPALIVE_CNT: Count time for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: integer)
ZMQ::SOCKOPT_TCP_KEEPALIVE_INTVL: Interval for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: integer)
ZMQ::SOCKOPT_DELAY_ATTACH_ON_CONNECT: Set a CIDR string to match against incoming TCP connections. Available if compiled against ZeroMQ 3.x or higher (Value: string)
ZMQ::SOCKOPT_TCP_ACCEPT_FILTER: Set a CIDR string to match against incoming TCP connections. Available if compiled against ZeroMQ 3.x or higher (Value: string)
ZMQ::SOCKOPT_XPUB_VERBOSE: Set the XPUB to receive an application message on each instance of a subscription. Available if compiled against ZeroMQ 3.x or higher (Value: string)
ZMQ::SOCKOPT_ROUTER_RAW: Sets the raw mode on the ROUTER, when set to 1. In raw mode when using tcp:// transport the socket will read and write without ZeroMQ framing. Available if compiled against ZeroMQ 4.0 or higher (Value: string)
ZMQ::SOCKOPT_IPV6: Enable IPV6. Available if compiled against ZeroMQ 4.0 or higher (Value: string)
ZMQ::CTXOPT_MAX_SOCKETS: The socket limit for this context. Available if compiled against ZeroMQ 3.x or higher (Value: integer)
ZMQ::POLL_IN: Poll for incoming data
ZMQ::POLL_OUT: Poll for outgoing data
ZMQ::MODE_NOBLOCK: Non-blocking operation. Deprecated, use ZMQ::MODE_DONTWAIT instead
ZMQ::MODE_DONTWAIT: Non-blocking operation
ZMQ::MODE_SNDMORE: Send multi-part message
ZMQ::DEVICE_FORWARDER: Forwarder device
ZMQ::DEVICE_QUEUE: Queue device
ZMQ::DEVICE_STREAMER: Streamer device
ZMQ::ERR_INTERNAL: ZMQ extension internal error
ZMQ::ERR_EAGAIN: Implies that the operation would block when ZMQ::MODE_DONTWAIT is used
ZMQ::ERR_ENOTSUP: The operation is not supported by the socket type
ZMQ::ERR_EFSM: The operation can not be executed because the socket is not in correct state
ZMQ::ERR_ETERM: The context has been terminated

ZMQ::__construct — ZMQ constructor

The ZMQ class

Introduction

Class synopsis

Predefined Constants

ZMQ Constant Types

Table of Contents