Skip to content

← network package

ZMQInput

Read arbitrary data from a ZeroMQ socket.

This node should not be mistaken for a general-purpose network I/O node. This node is usually followed by a Demultiplex Packets node in order to receive 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.1.0

Ports/Properties

data

Output signal.

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

endpoint

Endpoint on which to bind the ZeroMQ socket to listen for incoming messages to read. 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:10002
  • port type: StringPort
  • value type: str (can be None)

encoding

Encoding type. Messages read from the bound ZeroMQ socket are decoded 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.

  • verbose name: Endpoint Override
  • default value: tcp://*:10002
  • 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)

check_duplicate_messages

Check for duplicate messages.

  • verbose name: Check Duplicate Messages
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

blocking_read

Block until data is available. By If False, the node returns an empty packet whenever no data is available on a given update. If set to True, this node will block, which allows to run NeuroPype in lock-step with the data sender.

  • verbose name: Blocking Read
  • default value: True
  • port type: BoolPort
  • value type: bool (can be None)

timeout

Socket timeout threshold for receiving data after which None is emitted.

  • verbose name: Timeout
  • default value: 1.0
  • port type: FloatPort
  • value type: float (can be None)

verbose

Verbose output.

  • verbose name: Verbose
  • default value: False
  • 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)