Zeromq Toolkit - Functions


The following functions are available:

ZeroMQ overview

zeromqThe zeromq package provides GNU Octave bindings to the ZeroMQ library to prov...

ZeroMQ functions

iszmqDetermine whether H is a zeromq socket object.
zmq_bindBind a zeromq socket to a endpoint.
zmq_closeClose a zeromq socket.
zmq_connectConnect a zeromq socket to a endpoint.
zmq_curve_keypairGenerate a random private/public keypair
zmq_curve_publicDerive the public key from a private key
zmq_disconnectDisconnect a zeromq socket from an endpoint.
zmq_errnoGet the value of errno from zeromq.
zmq_getsockoptGet the current value of an option.
zmq_hasCheck if the zmq library supports a given feature.
zmq_pollWait up to timeout time for received data on socket.
zmq_recvAttempt to receive up to LEN bytes of data from zeromq socket.
zmq_sendAttempt to send to DATA bytes of data to zeromq socket.
zmq_setsockoptSet a socket option on a zeromq socket.
zmq_socketCreate a zeromq socket.
zmq_strerrorGet the last error from zeromq.
zmq_unbindUnbind a previously bound zeromq socket from a endpoint.
zmq_versionGet the ZeroMQ library version.
zmq_z85_decodeDecode a z85 encoded string to a binary key.
zmq_z85_encodeEncode a binary key as Z85 printable text.

ZeroMQ socket type constants

ZMQ_DEALERConstant for dealer socket type.
ZMQ_PAIRConstant for pair socket type.
ZMQ_PUBConstant for publisher type.
ZMQ_PULLConstant for pull socket type.
ZMQ_PUSHConstant for push socket type.
ZMQ_REPConstant for reply socket type.
ZMQ_REQConstant for request socket type.
ZMQ_ROUTERConstant for router socket type.
ZMQ_STREAMConstant for stream socket type.
ZMQ_SUBConstant for subscriber type.
ZMQ_XPUBConstant for publisher type.
ZMQ_XSUBConstant for subscriber type.

ZeroMQ get/setsockopt constants

ZMQ_EVENTSConstant for getsockopt EVENTS value option
ZMQ_SUBSCRIBEConstant for setsockopt subscribe option
ZMQ_UNSUBSCRIBEConstant for setsockopt unsubscribe option
ZMQ_RCVMOREConstant for getsockopt RCVMORE value option
ZMQ_TYPEConstant for getsockopt TYPE value option
ZMQ_IDENTITYConstant for getsockopt and setsockopt IDENTITY value option
ZMQ_LAST_ENDPOINTConstant for getsockopt last endpoint value option
ZMQ_CONNECT_TIMEOUTConstant for get/setsockopt connect timeout value
ZMQ_CURVE_PUBLICKEYConstant for getsockopt and setsockopt CURVE_PUBLICKEY value option
ZMQ_CURVE_SECRETKEYConstant for getsockopt and setsockopt CURVE_PRIVATEKEY value option
ZMQ_CURVE_SERVERKEYConstant for getsockopt and setsockopt CURVE_SERVERKEY value option
ZMQ_CURVE_SERVERConstant for getsockopt and setsockopt CURVE_SERVER value option
ZMQ_PLAIN_SERVERConstant for getsockopt and setsockopt PLAIN_SERVER value option
ZMQ_PLAIN_USERNAMEConstant for getsockopt and setsockopt PLAIN_USERNAME value option
ZMQ_PLAIN_PASSWORDConstant for getsockopt and setsockopt PLAIN_PASSWORD value option
ZMQ_MECHANISMConstant for getsockopt and setsockopt MECHANISM value option
ZMQ_SOCKS_PROXYConstant for getsockopt and setsockopt SOCKS_PROXY value option
ZMQ_GSSAPI_PLAINTEXTConstant for getsockopt and setsockopt GSSAPI_PLAINTEXT value option
ZMQ_GSSAPI_PRINCIPALConstant for getsockopt and setsockopt GSSAPI_PRINCIPAL value option
ZMQ_GSSAPI_SERVERConstant for getsockopt and setsockopt GSSAPI_SERVER value option
ZMQ_GSSAPI_SERVICE_PRINCIPALConstant for getsockopt and setsockopt GSSAPI_SERVICE_PRINCIPAL value option
ZMQ_PRIORITYConstant for getsockopt and setsockopt SO_PRIORITY value option in linux only.
ZMQ_RATEConstant for getsockopt and setsockopt value option
ZMQ_ROUTING_IDConstant for getsockopt and setsockopt IDENTITY value option
ZMQ_BACKLOGConstant for getsockopt and setsockopt to set backlog for pending connections

ZeroMQ ZMQ_EVENTS flags

ZMQ_POLLINConstant bitmask value for getsockopt EVENTS value option
ZMQ_POLLOUTConstant bitmask value for getsockopt EVENTS value option

ZeroMQ receive send options

ZMQ_DONTWAITConstant for recv flag DONTWAIT
ZMQ_SNDMOREConstant for send flag SNDMORE

ZeroMQ ZMQ_MECHANISM values

ZMQ_NULLConstant value for getsockopt MECHANISM value option
ZMQ_PLAINConstant value for getsockopt MECHANISM value option
ZMQ_CURVEConstant value for getsockopt MECHANISM value option
ZMQ_GSSAPIConstant value for getsockopt MECHANISM value option