Skip to content

← network package

ZMQOutput

Write arbitrary data to a ZeroMQ socket.

This node should not be mistaken for a general-purpose network I/O node. This node is usually preceded by a Multiplex Packets node in order to send multiple data packets, each of which may have one or more streams. Note: The ZeroMQ socket type is DEALER. The node is designed to operate as the receiver in an exclusive pair topology. Topologies other than exclusive pair are unsupported and will likely produce undefined behavior. More Info... Version 1.0.0

Ports/Properties

data

Data to send.

verbose name
Data
default value
None
port type
DataPort
value type
object (can be None)
data direction
IN

endpoint

Endpoint on which to connect the ZeroMQ socket to write outgoing messages. This is specified as a unique combination of protocol, host and port. For more information, see the ZeroMQ documentation.

verbose name
Endpoint
default value
tcp://127.0.0.1:10001
port type
StringPort
value type
str (can be None)

encoding

Encoding type. Messages written to the connected ZeroMQ socket are encoded based on the value of this setting.

verbose name
Encoding
default value
pickle
port type
EnumPort
value type
str (can be None)

endpoint_override

If set, this will override the value stored in endpoint. Can optionally contain the placeholder %(CPE_ZMQ_TARGET_HOST)s, which will be substituted with the value of the environment variable of same name, or the default string 'worker'.

verbose name
Endpoint Override
default value
tcp://%(CPE_ZMQ_TARGET_HOST)s:10001
port type
StringPort
value type
str (can be None)

use_shared_socket

Use a ZeroMQ socket that can be shared with an instance of the ZMQOutput node.

verbose name
Use Shared Socket
default value
True
port type
BoolPort
value type
bool (can be None)

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

verbose name
Set Breakpoint (Debug Only)
default value
False
port type
BoolPort
value type
bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

verbose name
Metadata
default value
{}
port type
DictPort
value type
dict (can be None)