ZMQ

Table of Contents

Introduction
Installing/Configuring
- Requirements
ZMQ — The ZMQ class
- ZMQ::__construct — ZMQ constructor
ZMQContext — The ZMQContext class
- ZMQContext::__construct — Construct a new ZMQContext object
- ZMQContext::getOpt — Get context option
- ZMQContext::getSocket — Create a new socket
- ZMQContext::isPersistent — Whether the context is persistent
- ZMQContext::setOpt — Set a socket option
ZMQSocket — The ZMQSocket class
- ZMQSocket::bind — Bind the socket
- ZMQSocket::connect — Connect the socket
- ZMQSocket::__construct — Construct a new ZMQSocket
- ZMQSocket::disconnect — Disconnect a socket
- ZMQSocket::getEndpoints — Get list of endpoints
- ZMQSocket::getPersistentId — Get the persistent id
- ZMQSocket::getSocketType — Get the socket type
- ZMQSocket::getSockOpt — Get socket option
- ZMQSocket::isPersistent — Whether the socket is persistent
- ZMQSocket::recv — Receives a message
- ZMQSocket::recvMulti — Receives a multipart message
- ZMQSocket::send — Sends a message
- ZMQSocket::sendmulti — Sends a multipart message
- ZMQSocket::setSockOpt — Set a socket option
- ZMQSocket::unbind — Unbind the socket
ZMQPoll — The ZMQPoll class
- ZMQPoll::add — Add item to the poll set
- ZMQPoll::clear — Clear the poll set
- ZMQPoll::count — Count items in the poll set
- ZMQPoll::getLastErrors — Get poll errors
- ZMQPoll::poll — Poll the items
- ZMQPoll::remove — Remove item from poll set
ZMQDevice — The ZMQDevice class
- ZMQDevice::__construct — Construct a new device
- ZMQDevice::getIdleTimeout — Get the idle timeout
- ZMQDevice::getTimerTimeout — Get the timer timeout
- ZMQDevice::run — Run the new device
- ZMQDevice::setIdleCallback — Set the idle callback function
- ZMQDevice::setIdleTimeout — Set the idle timeout
- ZMQDevice::setTimerCallback — Set the timer callback function
- ZMQDevice::setTimerTimeout — Set the timer timeout

The ZMQ class

Introduction

Class synopsis

ZMQ

class ZMQ {

/* Constants */

const integer ZMQ::SOCKET_PAIR ;

const integer ZMQ::SOCKET_PUB ;

const integer ZMQ::SOCKET_SUB ;

const integer ZMQ::SOCKET_REQ ;

const integer ZMQ::SOCKET_REP ;

const integer ZMQ::SOCKET_XREQ ;

const integer ZMQ::SOCKET_XREP ;

const integer ZMQ::SOCKET_PUSH ;

const integer ZMQ::SOCKET_PULL ;

const integer ZMQ::SOCKET_ROUTER ;

const integer ZMQ::SOCKET_DEALER ;

const integer ZMQ::SOCKET_XPUB ;

const integer ZMQ::SOCKET_XSUB ;

const integer ZMQ::SOCKET_STREAM ;

const integer ZMQ::SOCKOPT_HWM ;

const integer ZMQ::SOCKOPT_SNDHWM ;

const integer ZMQ::SOCKOPT_RCVHWM ;

const integer ZMQ::SOCKOPT_AFFINITY ;

const integer ZMQ::SOCKOPT_IDENTITY ;

const integer ZMQ::SOCKOPT_SUBSCRIBE ;

const integer ZMQ::SOCKOPT_UNSUBSCRIBE ;

const integer ZMQ::SOCKOPT_RATE ;

const integer ZMQ::SOCKOPT_RECOVERY_IVL ;

const integer ZMQ::SOCKOPT_RECONNECT_IVL ;

const integer ZMQ::SOCKOPT_RECONNECT_IVL_MAX ;

const integer ZMQ::SOCKOPT_MCAST_LOOP ;

const integer ZMQ::SOCKOPT_SNDBUF ;

const integer ZMQ::SOCKOPT_RCVBUF ;

const integer ZMQ::SOCKOPT_RCVMORE ;

const integer ZMQ::SOCKOPT_TYPE ;

const integer ZMQ::SOCKOPT_LINGER ;

const integer ZMQ::SOCKOPT_BACKLOG ;

const integer ZMQ::SOCKOPT_MAXMSGSIZE ;

const integer ZMQ::SOCKOPT_SNDTIMEO ;

const integer ZMQ::SOCKOPT_RCVTIMEO ;

const integer ZMQ::SOCKOPT_IPV4ONLY ;

const integer ZMQ::SOCKOPT_LAST_ENDPOINT ;

const integer ZMQ::SOCKOPT_TCP_KEEPALIVE_IDLE ;

const integer ZMQ::SOCKOPT_TCP_KEEPALIVE_CNT ;

const integer ZMQ::SOCKOPT_TCP_KEEPALIVE_INTVL ;

const integer ZMQ::SOCKOPT_TCP_ACCEPT_FILTER ;

const integer ZMQ::SOCKOPT_DELAY_ATTACH_ON_CONNECT ;

const integer ZMQ::SOCKOPT_XPUB_VERBOSE ;

const integer ZMQ::SOCKOPT_ROUTER_RAW ;

const integer ZMQ::SOCKOPT_IPV6 ;

const integer ZMQ::CTXOPT_MAX_SOCKETS ;

const integer ZMQ::POLL_IN ;

const integer ZMQ::POLL_OUT ;

const integer ZMQ::MODE_NOBLOCK ;

const integer ZMQ::MODE_DONTWAIT ;

const integer ZMQ::MODE_SNDMORE ;

const integer ZMQ::ERR_INTERNAL ;

const integer ZMQ::ERR_EAGAIN ;

const integer ZMQ::ERR_ENOTSUP ;

const integer ZMQ::ERR_EFSM ;

const integer ZMQ::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

The ZMQContext class

Introduction

Class synopsis

ZMQContext

class ZMQContext {

/* Methods */

__construct ([ integer $io_threads = 1 [, boolean $is_persistent = true ]] )

public mixed getOpt ( string $key )

public ZMQSocket getSocket ( integer $type [, string $persistent_id = null [, callback $on_new_socket = null ]] )

public boolean isPersistent ( void )

public ZMQContext setOpt ( integer $key , mixed $value )

}

The ZMQSocket class

Introduction

Class synopsis

ZMQSocket

class ZMQSocket {

/* Methods */

public ZMQSocket bind ( string $dsn [, boolean $force = false ] )

public ZMQSocket connect ( string $dsn [, boolean $force = false ] )

__construct ( ZMQContext $context , int $type [, string $persistent_id = null [, callback $on_new_socket = null ]] )

public ZMQSocket disconnect ( string $dsn )

public array getEndpoints ( void )

public string getPersistentId ( void )

public integer getSocketType ( void )

public mixed getSockOpt ( string $key )

public boolean isPersistent ( void )

public string recv ([ integer $mode = 0 ] )

public string recvMulti ([ integer $mode = 0 ] )

public ZMQSocket send ( string $message [, integer $mode = 0 ] )

public ZMQSocket send ( array $message [, integer $mode = 0 ] )

public ZMQSocket setSockOpt ( integer $key , mixed $value )

public ZMQSocket unbind ( string $dsn )

}

The ZMQPoll class

Introduction

Class synopsis

ZMQPoll

class ZMQPoll {

/* Methods */

public string add ( mixed $entry , integer $type )

public ZMQPoll clear ( void )

public integer count ( void )

public array getLastErrors ( void )

public integer poll ( array &$readable , array &$writable [, integer $timeout = -1 ] )

public boolean remove ( mixed $item )

}

The ZMQDevice class

Introduction

Class synopsis

ZMQDevice

class ZMQDevice {

/* Methods */

__construct ( ZMQSocket $frontend , ZMQSocket $backend [, ZMQSocket $listener ] )

public ZMQDevice getIdleTimeout ( void )

public ZMQDevice getTimerTimeout ( void )

public void run ( void )

public ZMQDevice setIdleCallback ( callable $cb_func , integer $timeout [, mixed $user_data ] )

public ZMQDevice setIdleTimeout ( integer $timeout )

public ZMQDevice setTimerCallback ( callable $cb_func , integer $timeout [, mixed $user_data ] )

public ZMQDevice setTimerTimeout ( integer $timeout )

}