The PyZMQ API

Release:

25.1.0

Date:

May 26, 2023

• zmq
  • Basic Classes
    • Context
      • Context
        • Context.closed
        • Context.destroy()
        • Context.get()
        • Context.getsockopt()
        • Context.instance()
        • Context.set()
        • Context.setsockopt()
        • Context.shadow()
        • Context.shadow_pyczmq()
        • Context.socket()
        • Context.term()
        • Context.underlying
    • Socket
      • Socket
        • Socket.closed
        • Socket.copy_threshold
        • Socket.bind()
        • Socket.bind_to_random_port()
        • Socket.close()
        • Socket.connect()
        • Socket.disable_monitor()
        • Socket.disconnect()
        • Socket.fileno()
        • Socket.get()
        • Socket.get_hwm()
        • Socket.get_monitor_socket()
        • Socket.get_string()
        • Socket.getsockopt()
        • Socket.getsockopt_string()
        • Socket.hwm
        • Socket.join()
        • Socket.leave()
        • Socket.monitor()
        • Socket.poll()
        • Socket.recv()
        • Socket.recv_json()
        • Socket.recv_multipart()
        • Socket.recv_pyobj()
        • Socket.recv_serialized()
        • Socket.recv_string()
        • Socket.send()
        • Socket.send_json()
        • Socket.send_multipart()
        • Socket.send_pyobj()
        • Socket.send_serialized()
        • Socket.send_string()
        • Socket.set()
        • Socket.set_hwm()
        • Socket.set_string()
        • Socket.setsockopt()
        • Socket.setsockopt_string()
        • Socket.shadow()
        • Socket.subscribe()
        • Socket.unbind()
        • Socket.underlying
        • Socket.unsubscribe()
    • Frame
      • Frame
        • Frame.buffer
        • Frame.bytes
        • Frame.get()
        • Frame.group
        • Frame.routing_id
        • Frame.set()
    • MessageTracker
      • MessageTracker
        • MessageTracker.done
        • MessageTracker.wait()
  • Polling
    • Poller
      • Poller
        • Poller.modify()
        • Poller.poll()
        • Poller.register()
        • Poller.unregister()
      • select()
  • Constants
    • SocketType
      • SocketType.PAIR
      • SocketType.PUB
      • SocketType.SUB
      • SocketType.REQ
      • SocketType.REP
      • SocketType.DEALER
      • SocketType.ROUTER
      • SocketType.PULL
      • SocketType.PUSH
      • SocketType.XPUB
      • SocketType.XSUB
      • SocketType.STREAM
      • SocketType.SERVER
      • SocketType.CLIENT
      • SocketType.RADIO
      • SocketType.DISH
      • SocketType.GATHER
      • SocketType.SCATTER
      • SocketType.DGRAM
      • SocketType.PEER
      • SocketType.CHANNEL
    • SocketOption
      • SocketOption.HWM
      • SocketOption.AFFINITY
      • SocketOption.ROUTING_ID
      • SocketOption.SUBSCRIBE
      • SocketOption.UNSUBSCRIBE
      • SocketOption.RATE
      • SocketOption.RECOVERY_IVL
      • SocketOption.SNDBUF
      • SocketOption.RCVBUF
      • SocketOption.RCVMORE
      • SocketOption.FD
      • SocketOption.EVENTS
      • SocketOption.TYPE
      • SocketOption.LINGER
      • SocketOption.RECONNECT_IVL
      • SocketOption.BACKLOG
      • SocketOption.RECONNECT_IVL_MAX
      • SocketOption.MAXMSGSIZE
      • SocketOption.SNDHWM
      • SocketOption.RCVHWM
      • SocketOption.MULTICAST_HOPS
      • SocketOption.RCVTIMEO
      • SocketOption.SNDTIMEO
      • SocketOption.LAST_ENDPOINT
      • SocketOption.ROUTER_MANDATORY
      • SocketOption.TCP_KEEPALIVE
      • SocketOption.TCP_KEEPALIVE_CNT
      • SocketOption.TCP_KEEPALIVE_IDLE
      • SocketOption.TCP_KEEPALIVE_INTVL
      • SocketOption.IMMEDIATE
      • SocketOption.XPUB_VERBOSE
      • SocketOption.ROUTER_RAW
      • SocketOption.IPV6
      • SocketOption.MECHANISM
      • SocketOption.PLAIN_SERVER
      • SocketOption.PLAIN_USERNAME
      • SocketOption.PLAIN_PASSWORD
      • SocketOption.CURVE_SERVER
      • SocketOption.CURVE_PUBLICKEY
      • SocketOption.CURVE_SECRETKEY
      • SocketOption.CURVE_SERVERKEY
      • SocketOption.PROBE_ROUTER
      • SocketOption.REQ_CORRELATE
      • SocketOption.REQ_RELAXED
      • SocketOption.CONFLATE
      • SocketOption.ZAP_DOMAIN
      • SocketOption.ROUTER_HANDOVER
      • SocketOption.TOS
      • SocketOption.CONNECT_ROUTING_ID
      • SocketOption.GSSAPI_SERVER
      • SocketOption.GSSAPI_PRINCIPAL
      • SocketOption.GSSAPI_SERVICE_PRINCIPAL
      • SocketOption.GSSAPI_PLAINTEXT
      • SocketOption.HANDSHAKE_IVL
      • SocketOption.SOCKS_PROXY
      • SocketOption.XPUB_NODROP
      • SocketOption.BLOCKY
      • SocketOption.XPUB_MANUAL
      • SocketOption.XPUB_WELCOME_MSG
      • SocketOption.STREAM_NOTIFY
      • SocketOption.INVERT_MATCHING
      • SocketOption.HEARTBEAT_IVL
      • SocketOption.HEARTBEAT_TTL
      • SocketOption.HEARTBEAT_TIMEOUT
      • SocketOption.XPUB_VERBOSER
      • SocketOption.CONNECT_TIMEOUT
      • SocketOption.TCP_MAXRT
      • SocketOption.THREAD_SAFE
      • SocketOption.MULTICAST_MAXTPDU
      • SocketOption.VMCI_BUFFER_SIZE
      • SocketOption.VMCI_BUFFER_MIN_SIZE
      • SocketOption.VMCI_BUFFER_MAX_SIZE
      • SocketOption.VMCI_CONNECT_TIMEOUT
      • SocketOption.USE_FD
      • SocketOption.GSSAPI_PRINCIPAL_NAMETYPE
      • SocketOption.GSSAPI_SERVICE_PRINCIPAL_NAMETYPE
      • SocketOption.BINDTODEVICE
      • SocketOption.TCP_ACCEPT_FILTER
      • SocketOption.IPC_FILTER_PID
      • SocketOption.IPC_FILTER_UID
      • SocketOption.IPC_FILTER_GID
      • SocketOption.IPV4ONLY
      • SocketOption.ZAP_ENFORCE_DOMAIN
      • SocketOption.LOOPBACK_FASTPATH
      • SocketOption.METADATA
      • SocketOption.MULTICAST_LOOP
      • SocketOption.ROUTER_NOTIFY
      • SocketOption.XPUB_MANUAL_LAST_VALUE
      • SocketOption.SOCKS_USERNAME
      • SocketOption.SOCKS_PASSWORD
      • SocketOption.IN_BATCH_SIZE
      • SocketOption.OUT_BATCH_SIZE
      • SocketOption.WSS_KEY_PEM
      • SocketOption.WSS_CERT_PEM
      • SocketOption.WSS_TRUST_PEM
      • SocketOption.WSS_HOSTNAME
      • SocketOption.WSS_TRUST_SYSTEM
      • SocketOption.ONLY_FIRST_SUBSCRIBE
      • SocketOption.RECONNECT_STOP
      • SocketOption.HELLO_MSG
      • SocketOption.DISCONNECT_MSG
      • SocketOption.PRIORITY
    • Flag
      • Flag.DONTWAIT
      • Flag.SNDMORE
    • PollEvent
      • PollEvent.POLLIN
      • PollEvent.POLLOUT
      • PollEvent.POLLERR
      • PollEvent.POLLPRI
    • ContextOption
      • ContextOption.IO_THREADS
      • ContextOption.MAX_SOCKETS
      • ContextOption.SOCKET_LIMIT
      • ContextOption.THREAD_SCHED_POLICY
      • ContextOption.MAX_MSGSZ
      • ContextOption.MSG_T_SIZE
      • ContextOption.THREAD_AFFINITY_CPU_ADD
      • ContextOption.THREAD_AFFINITY_CPU_REMOVE
      • ContextOption.THREAD_NAME_PREFIX
    • MessageOption
      • MessageOption.MORE
      • MessageOption.SHARED
      • MessageOption.SRCFD
    • Event
      • Event.PROTOCOL_ERROR_ZMTP_UNSPECIFIED
      • Event.PROTOCOL_ERROR_ZAP_UNSPECIFIED
      • Event.CONNECTED
      • Event.CONNECT_DELAYED
      • Event.CONNECT_RETRIED
      • Event.LISTENING
      • Event.BIND_FAILED
      • Event.ACCEPTED
      • Event.ACCEPT_FAILED
      • Event.CLOSED
      • Event.CLOSE_FAILED
      • Event.DISCONNECTED
      • Event.MONITOR_STOPPED
      • Event.HANDSHAKE_FAILED_NO_DETAIL
      • Event.HANDSHAKE_SUCCEEDED
      • Event.HANDSHAKE_FAILED_PROTOCOL
      • Event.HANDSHAKE_FAILED_AUTH
      • Event.PIPES_STATS
    • SecurityMechanism
      • SecurityMechanism.NULL
      • SecurityMechanism.PLAIN
      • SecurityMechanism.CURVE
      • SecurityMechanism.GSSAPI
    • DeviceType
      • DeviceType.STREAMER
      • DeviceType.FORWARDER
      • DeviceType.QUEUE
    • Errno
      • Errno.EAGAIN
      • Errno.EFAULT
      • Errno.EINVAL
      • Errno.ENOTSUP
      • Errno.EPROTONOSUPPORT
      • Errno.ENOBUFS
      • Errno.ENETDOWN
      • Errno.EADDRINUSE
      • Errno.EADDRNOTAVAIL
      • Errno.ECONNREFUSED
      • Errno.EINPROGRESS
      • Errno.ENOTSOCK
      • Errno.EMSGSIZE
      • Errno.EAFNOSUPPORT
      • Errno.ENETUNREACH
      • Errno.ECONNABORTED
      • Errno.ECONNRESET
      • Errno.ENOTCONN
      • Errno.ETIMEDOUT
      • Errno.EHOSTUNREACH
      • Errno.ENETRESET
      • Errno.EFSM
      • Errno.ENOCOMPATPROTO
      • Errno.ETERM
      • Errno.EMTHREAD
  • Exceptions
    • ZMQError
      • ZMQError
        • ZMQError.add_note()
        • ZMQError.with_traceback()
    • ZMQVersionError
      • ZMQVersionError
        • ZMQVersionError.add_note()
        • ZMQVersionError.with_traceback()
    • Again
      • Again
    • ContextTerminated
      • ContextTerminated
    • NotDone
      • NotDone
    • ZMQBindError
      • ZMQBindError
  • Functions
    • zmq_version()
    • pyzmq_version()
    • zmq_version_info()
    • pyzmq_version_info()
    • has()
    • device()
    • proxy()
    • proxy_steerable()
    • curve_public()
    • curve_keypair()
    • get_includes()
    • get_library_dirs()
• devices
  • Functions
  • Module: zmq.devices
  • Base Devices
    • Device
      • Device
        • Device.daemon
        • Device.context_factory
        • Device.bind_in()
        • Device.bind_in_to_random_port()
        • Device.bind_out()
        • Device.bind_out_to_random_port()
        • Device.connect_in()
        • Device.connect_out()
        • Device.join()
        • Device.setsockopt_in()
        • Device.setsockopt_out()
        • Device.start()
    • ThreadDevice
      • ThreadDevice
    • ProcessDevice
      • ProcessDevice
        • ProcessDevice.context_factory
  • Proxy Devices
    • Proxy
      • Proxy
        • Proxy.bind_mon()
        • Proxy.connect_mon()
        • Proxy.setsockopt_mon()
    • ThreadProxy
      • ThreadProxy
    • ProcessProxy
      • ProcessProxy
    • ProxySteerable
      • ProxySteerable
        • ProxySteerable.bind_ctrl()
        • ProxySteerable.connect_ctrl()
        • ProxySteerable.setsockopt_ctrl()
    • ThreadProxySteerable
      • ThreadProxySteerable
    • ProcessProxySteerable
      • ProcessProxySteerable
  • MonitoredQueue Devices
    • monitored_queue()
    • MonitoredQueue
      • MonitoredQueue
    • ThreadMonitoredQueue
      • ThreadMonitoredQueue
    • ProcessMonitoredQueue
      • ProcessMonitoredQueue
• decorators
  • Module: zmq.decorators
  • Decorators
    • context()
    • socket()
• green
  • Module: green
    • Usage
• eventloop.ioloop
  • Module: eventloop.ioloop
• eventloop.future
  • Module: eventloop.future
  • Classes
    • Context
    • Socket
    • Poller
• asyncio
  • Module: zmq.asyncio
  • Classes
    • ZMQEventLoop
      • ZMQEventLoop
    • Context
    • Socket
    • Poller
• eventloop.zmqstream
  • Module: eventloop.zmqstream
  • ZMQStream
    • ZMQStream
      • ZMQStream.close()
      • ZMQStream.closed()
      • ZMQStream.flush()
      • ZMQStream.io_loop
      • ZMQStream.on_err()
      • ZMQStream.on_recv()
      • ZMQStream.on_recv_stream()
      • ZMQStream.on_send()
      • ZMQStream.on_send_stream()
      • ZMQStream.poller
      • ZMQStream.receiving()
      • ZMQStream.send()
      • ZMQStream.send_json()
      • ZMQStream.send_multipart()
      • ZMQStream.send_pyobj()
      • ZMQStream.send_string()
      • ZMQStream.send_unicode()
      • ZMQStream.sending()
      • ZMQStream.set_close_callback()
      • ZMQStream.socket
      • ZMQStream.stop_on_err()
      • ZMQStream.stop_on_recv()
      • ZMQStream.stop_on_send()
• auth
  • Module: auth
  • Authenticator
    • Authenticator
      • Authenticator.allow()
      • Authenticator.allow_any
      • Authenticator.certs
      • Authenticator.configure_curve()
      • Authenticator.configure_curve_callback()
      • Authenticator.configure_gssapi()
      • Authenticator.configure_plain()
      • Authenticator.context
      • Authenticator.credentials_providers
      • Authenticator.curve_user_id()
      • Authenticator.deny()
      • Authenticator.encoding
      • Authenticator.handle_zap_message()
      • Authenticator.log
      • Authenticator.passwords
      • Authenticator.start()
      • Authenticator.stop()
      • Authenticator.zap_socket
  • Functions
    • create_certificates()
    • load_certificate()
    • load_certificates()
• auth.asyncio
  • Module: auth.asyncio
  • Classes
    • AsyncioAuthenticator
      • AsyncioAuthenticator
        • AsyncioAuthenticator.allow()
        • AsyncioAuthenticator.allow_any
        • AsyncioAuthenticator.certs
        • AsyncioAuthenticator.configure_curve()
        • AsyncioAuthenticator.configure_curve_callback()
        • AsyncioAuthenticator.configure_gssapi()
        • AsyncioAuthenticator.configure_plain()
        • AsyncioAuthenticator.context
        • AsyncioAuthenticator.credentials_providers
        • AsyncioAuthenticator.curve_user_id()
        • AsyncioAuthenticator.deny()
        • AsyncioAuthenticator.encoding
        • AsyncioAuthenticator.handle_zap_message()
        • AsyncioAuthenticator.log
        • AsyncioAuthenticator.passwords
        • AsyncioAuthenticator.start()
        • AsyncioAuthenticator.stop()
        • AsyncioAuthenticator.zap_socket
• auth.thread
  • Module: auth.thread
  • Classes
    • ThreadAuthenticator
      • ThreadAuthenticator
        • ThreadAuthenticator.allow()
        • ThreadAuthenticator.allow_any
        • ThreadAuthenticator.certs
        • ThreadAuthenticator.configure_curve()
        • ThreadAuthenticator.configure_curve_callback()
        • ThreadAuthenticator.configure_gssapi()
        • ThreadAuthenticator.configure_plain()
        • ThreadAuthenticator.context
        • ThreadAuthenticator.credentials_providers
        • ThreadAuthenticator.curve_user_id()
        • ThreadAuthenticator.deny()
        • ThreadAuthenticator.encoding
        • ThreadAuthenticator.handle_zap_message()
        • ThreadAuthenticator.is_alive()
        • ThreadAuthenticator.log
        • ThreadAuthenticator.passwords
        • ThreadAuthenticator.pipe
        • ThreadAuthenticator.pipe_endpoint
        • ThreadAuthenticator.start()
        • ThreadAuthenticator.stop()
        • ThreadAuthenticator.thread
        • ThreadAuthenticator.zap_socket
• auth.ioloop
  • Module: auth.ioloop
• log.handlers
  • Module: log.handlers
  • Classes
    • PUBHandler
      • PUBHandler
        • PUBHandler.acquire()
        • PUBHandler.addFilter()
        • PUBHandler.close()
        • PUBHandler.createLock()
        • PUBHandler.ctx
        • PUBHandler.emit()
        • PUBHandler.filter()
        • PUBHandler.flush()
        • PUBHandler.format()
        • PUBHandler.get_name()
        • PUBHandler.handle()
        • PUBHandler.handleError()
        • PUBHandler.name
        • PUBHandler.release()
        • PUBHandler.removeFilter()
        • PUBHandler.root_topic
        • PUBHandler.setFormatter()
        • PUBHandler.setLevel()
        • PUBHandler.setRootTopic()
        • PUBHandler.set_name()
        • PUBHandler.socket
    • TopicLogger
      • TopicLogger
        • TopicLogger.addFilter()
        • TopicLogger.addHandler()
        • TopicLogger.callHandlers()
        • TopicLogger.critical()
        • TopicLogger.debug()
        • TopicLogger.error()
        • TopicLogger.exception()
        • TopicLogger.fatal()
        • TopicLogger.filter()
        • TopicLogger.findCaller()
        • TopicLogger.getChild()
        • TopicLogger.getEffectiveLevel()
        • TopicLogger.handle()
        • TopicLogger.hasHandlers()
        • TopicLogger.info()
        • TopicLogger.isEnabledFor()
        • TopicLogger.log()
        • TopicLogger.makeRecord()
        • TopicLogger.manager
        • TopicLogger.removeFilter()
        • TopicLogger.removeHandler()
        • TopicLogger.root
        • TopicLogger.setLevel()
        • TopicLogger.warn()
        • TopicLogger.warning()
• ssh.tunnel
  • Module: ssh.tunnel
  • Functions
    • open_tunnel()
    • openssh_tunnel()
    • paramiko_tunnel()
    • select_random_ports()
    • try_passwordless_ssh()
    • tunnel_connection()
• utils.jsonapi
  • Module: utils.jsonapi
  • Functions
    • dumps()
    • loads()
• utils.monitor
  • Module: utils.monitor
  • Functions
    • parse_monitor_message()
    • recv_monitor_message()
• utils.z85
  • Module: utils.z85
  • Functions
    • decode()
    • encode()
• utils.win32
  • Module: zmq.utils.win32
  • allow_interrupt
    • allow_interrupt