wrapyfi.listeners package
Submodules
wrapyfi.listeners.ros module
- class wrapyfi.listeners.ros.ROSListener(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, queue_size: int = 5, ros_kwargs: dict | None = None, **kwargs)[source]
Bases:
Listener
- __init__(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, queue_size: int = 5, ros_kwargs: dict | None = None, **kwargs)[source]
Initialize the subscriber.
- Parameters:
name – str: Name of the subscriber
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
carrier – str: Carrier protocol. ROS currently only supports TCP for PUB/SUB pattern. Default is ‘tcp’
should_wait – bool: Whether the subscriber should wait for the publisher to transmit a message. Default is True
queue_size – int: Size of the queue for the subscriber. Default is 5
ros_kwargs – dict: Additional kwargs for the ROS middleware
kwargs – dict: Additional kwargs for the subscriber
- class wrapyfi.listeners.ros.ROSNativeObjectListener(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, queue_size: int = 5, deserializer_kwargs: dict | None = None, **kwargs)[source]
Bases:
ROSListener
- __init__(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, queue_size: int = 5, deserializer_kwargs: dict | None = None, **kwargs)[source]
The NativeObject listener using the ROS String message assuming the data is serialized as a JSON string. Deserializes the data (including plugins) using the decoder and parses it to a Python object.
- Parameters:
name – str: Name of the subscriber
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
carrier – str: Carrier protocol. ROS currently only supports TCP for PUB/SUB pattern. Default is ‘tcp’
should_wait – bool: Whether the subscriber should wait for the publisher to transmit a message. Default is True
queue_size – int: Size of the queue for the subscriber. Default is 5
deserializer_kwargs – dict: Additional kwargs for the deserializer
- class wrapyfi.listeners.ros.ROSImageListener(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, queue_size: int = 5, width: int = -1, height: int = -1, rgb: bool = True, fp: bool = False, jpg: bool = False, **kwargs)[source]
Bases:
ROSListener
- __init__(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, queue_size: int = 5, width: int = -1, height: int = -1, rgb: bool = True, fp: bool = False, jpg: bool = False, **kwargs)[source]
The Image listener using the ROS Image message parsed to a numpy array.
- Parameters:
name – str: Name of the subscriber
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
carrier – str: Carrier protocol. ROS currently only supports TCP for PUB/SUB pattern. Default is ‘tcp’
should_wait – bool: Whether the subscriber should wait for the publisher to transmit a message. Default is True
queue_size – int: Size of the queue for the subscriber. Default is 5
width – int: Width of the image. Default is -1 (use the width of the received image)
height – int: Height of the image. Default is -1 (use the height of the received image)
rgb – bool: True if the image is RGB, False if it is grayscale. Default is True
fp – bool: True if the image is floating point, False if it is integer. Default is False
jpg – bool: True if the image should be decompressed from JPG. Default is False
- class wrapyfi.listeners.ros.ROSAudioChunkListener(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, queue_size: int = 5, channels: int = 1, rate: int = 44100, chunk: int = -1, **kwargs)[source]
Bases:
ROSListener
- __init__(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, queue_size: int = 5, channels: int = 1, rate: int = 44100, chunk: int = -1, **kwargs)[source]
The AudioChunk listener using the ROS Image message parsed to a numpy array.
- Parameters:
name – str: Name of the subscriber
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
carrier – str: Carrier protocol. ROS currently only supports TCP for PUB/SUB pattern. Default is ‘tcp’
should_wait – bool: Whether the subscriber should wait for the publisher to transmit a message. Default is True
queue_size – int: Size of the queue for the subscriber. Default is 5
channels – int: Number of channels in the audio. Default is 1
rate – int: Sampling rate of the audio. Default is 44100
chunk – int: Number of samples in the audio chunk. Default is -1 (use the chunk size of the received audio)
- class wrapyfi.listeners.ros.ROSPropertiesListener(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, queue_size: int = 5, **kwargs)[source]
Bases:
ROSListener
Gets rospy parameters. Behaves differently from other data types by directly acquiring ROS parameters. Note that the listener is not guaranteed to receive the updated signal, since the listener can trigger before property is set. The property decorated method returns accept native python objects (excluding None), but care should be taken when using dictionaries, since they are analogous with node namespaces: http://wiki.ros.org/rospy/Overview/Parameter%20Server
- __init__(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, queue_size: int = 5, **kwargs)[source]
The PropertiesListener using the ROS Parameter Server.
- Parameters:
name – str: Name of the subscriber
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
carrier – str: Carrier protocol. ROS currently only supports TCP for PUB/SUB pattern. Default is ‘tcp’
should_wait – bool: Whether the subscriber should wait for a parameter to be set. Default is True
queue_size – int: Size of the queue for the subscriber. Default is 5
- await_connection(in_topic: int | None = None, repeats: int | None = None)[source]
Wait for a parameter to be set.
- Parameters:
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
repeats – int: Number of times to check for the parameter. None for infinite. Default is None
- class wrapyfi.listeners.ros.ROSMessageListener(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, queue_size: int = 5, **kwargs)[source]
Bases:
ROSListener
- __init__(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, queue_size: int = 5, **kwargs)[source]
The ROSMessageListener using the ROS message type inferred from the message type. Supports standard ROS msgs.
- Parameters:
name – str: Name of the subscriber
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
carrier – str: Carrier protocol. ROS currently only supports TCP for PUB/SUB pattern. Default is ‘tcp’
should_wait – bool: Whether the subscriber should wait for a message to be published. Default is True
queue_size – int: Size of the queue for the subscriber. Default is 5
wrapyfi.listeners.ros2 module
- class wrapyfi.listeners.ros2.ROS2Listener(name: str, in_topic: str, should_wait: bool = True, queue_size: int = 5, ros2_kwargs: dict | None = None, **kwargs)[source]
Bases:
Listener
,Node
- __init__(name: str, in_topic: str, should_wait: bool = True, queue_size: int = 5, ros2_kwargs: dict | None = None, **kwargs)[source]
Initialize the subscriber.
- Parameters:
name – str: Name of the subscriber
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
should_wait – bool: Whether the subscriber should wait for the publisher to transmit a message. Default is True
queue_size – int: Size of the queue for the subscriber. Default is 5
ros2_kwargs – dict: Additional kwargs for the ROS 2 middleware
kwargs – dict: Additional kwargs for the subscriber
- class wrapyfi.listeners.ros2.ROS2NativeObjectListener(name: str, in_topic: str, should_wait: bool = True, queue_size: int = 5, deserializer_kwargs: dict | None = None, **kwargs)[source]
Bases:
ROS2Listener
- __init__(name: str, in_topic: str, should_wait: bool = True, queue_size: int = 5, deserializer_kwargs: dict | None = None, **kwargs)[source]
The NativeObject listener using the ROS 2 String message assuming the data is serialized as a JSON string. Deserializes the data (including plugins) using the decoder and parses it to a native object.
- Parameters:
name – str: Name of the subscriber
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
should_wait – bool: Whether the subscriber should wait for the publisher to transmit a message. Default is True
queue_size – int: Size of the queue for the subscriber. Default is 5
deserializer_kwargs – dict: Additional kwargs for the deserializer
- class wrapyfi.listeners.ros2.ROS2ImageListener(name: str, in_topic: str, should_wait: bool = True, queue_size: int = 5, width: int = -1, height: int = -1, rgb: bool = True, fp: bool = False, jpg: bool = False, **kwargs)[source]
Bases:
ROS2Listener
- __init__(name: str, in_topic: str, should_wait: bool = True, queue_size: int = 5, width: int = -1, height: int = -1, rgb: bool = True, fp: bool = False, jpg: bool = False, **kwargs)[source]
The Image listener using the ROS 2 Image message parsed to a numpy array.
- Parameters:
name – str: Name of the subscriber
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
should_wait – bool: Whether the subscriber should wait for the publisher to transmit a message. Default is True
queue_size – int: Size of the queue for the subscriber. Default is 5
width – int: Width of the image. Default is -1 (use the width of the received image)
height – int: Height of the image. Default is -1 (use the height of the received image)
rgb – bool: True if the image is RGB, False if it is grayscale. Default is True
fp – bool: True if the image is floating point, False if it is integer. Default is False
jpg – bool: True if the image should be decompressed from JPG. Default is False
- class wrapyfi.listeners.ros2.ROS2AudioChunkListener(name: str, in_topic: str, should_wait: bool = True, queue_size: int = 5, channels: int = 1, rate: int = 44100, chunk: int = -1, **kwargs)[source]
Bases:
ROS2Listener
- __init__(name: str, in_topic: str, should_wait: bool = True, queue_size: int = 5, channels: int = 1, rate: int = 44100, chunk: int = -1, **kwargs)[source]
The AudioChunk listener using the ROS 2 Audio message parsed to a numpy array.
- Parameters:
name – str: Name of the subscriber
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
should_wait – bool: Whether the subscriber should wait for the publisher to transmit a message. Default is True
queue_size – int: Size of the queue for the subscriber. Default is 5
channels – int: Number of channels in the audio. Default is 1
rate – int: Sampling rate of the audio. Default is 44100
chunk – int: Number of samples in the audio chunk. Default is -1 (use the chunk size of the received audio)
- class wrapyfi.listeners.ros2.ROS2PropertiesListener(name, in_topic, **kwargs)[source]
Bases:
ROS2Listener
- __init__(name, in_topic, **kwargs)[source]
Initialize the subscriber.
- Parameters:
name – str: Name of the subscriber
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
should_wait – bool: Whether the subscriber should wait for the publisher to transmit a message. Default is True
queue_size – int: Size of the queue for the subscriber. Default is 5
ros2_kwargs – dict: Additional kwargs for the ROS 2 middleware
kwargs – dict: Additional kwargs for the subscriber
- class wrapyfi.listeners.ros2.ROS2MessageListener(name: str, in_topic: str, should_wait: bool = True, queue_size: int = 5, **kwargs)[source]
Bases:
ROS2Listener
- __init__(name: str, in_topic: str, should_wait: bool = True, queue_size: int = 5, **kwargs)[source]
The ROS2MessageListener using the ROS 2 message type inferred from the message type. Supports standard ROS 2 msgs.
- Parameters:
name – str: Name of the subscriber
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
should_wait – bool: Whether the subscriber should wait for the publisher to transmit a message. Default is True
queue_size – int: Size of the queue for the subscriber. Default is 5
wrapyfi.listeners.yarp module
- class wrapyfi.listeners.yarp.YarpListener(name: str, in_topic: str, carrier: Literal['tcp', 'udp', 'mcast'] = 'tcp', should_wait: bool = True, persistent: bool = True, yarp_kwargs: dict | None = None, **kwargs)[source]
Bases:
Listener
- __init__(name: str, in_topic: str, carrier: Literal['tcp', 'udp', 'mcast'] = 'tcp', should_wait: bool = True, persistent: bool = True, yarp_kwargs: dict | None = None, **kwargs)[source]
Initialize the subscriber.
- Parameters:
name – str: Name of the publisher
in_topic – str: Name of the output topic preceded by ‘/’ (e.g. ‘/topic’)
carrier – str: Carrier protocol (e.g. ‘tcp’). Default is ‘tcp’
should_wait – bool: Whether the subscriber should wait for the publisher to transmit a message. Default is True
persistent – bool: Whether the subscriber port should remain connected after closure. Default is True
yarp_kwargs – dict: Additional kwargs for the Yarp middleware
kwargs – dict: Additional kwargs for the subscriber
- await_connection(in_topic: str | None = None, repeats: int | None = None)[source]
Wait for the publisher to connect to the subscriber.
- Parameters:
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
repeats – int: Number of times to check for the parameter. None for infinite. Default is None
- Returns:
bool: True if connection established, False otherwise
- class wrapyfi.listeners.yarp.YarpNativeObjectListener(name: str, in_topic: str, carrier: Literal['tcp', 'udp', 'mcast'] = 'tcp', should_wait: bool = True, persistent: bool = True, deserializer_kwargs: dict | None = None, **kwargs)[source]
Bases:
YarpListener
- __init__(name: str, in_topic: str, carrier: Literal['tcp', 'udp', 'mcast'] = 'tcp', should_wait: bool = True, persistent: bool = True, deserializer_kwargs: dict | None = None, **kwargs)[source]
The NativeObject listener using the BufferedPortBottle string construct assuming the data is serialized as a JSON string. Deserializes the data (including plugins) using the decoder and parses it to a Python object.
- Parameters:
name – str: Name of the subscriber
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
carrier – str: Carrier protocol (e.g. ‘tcp’). Default is ‘tcp’
should_wait – bool: Whether the subscriber should wait for the publisher to transmit a message. Default is True
persistent – bool: Whether the subscriber port should remain connected after closure. Default is True
deserializer_kwargs – dict: Additional kwargs for the deserializer
- class wrapyfi.listeners.yarp.YarpImageListener(name: str, in_topic: str, carrier: Literal['tcp', 'udp', 'mcast'] = 'tcp', should_wait: bool = True, persistent: bool = True, width: int = -1, height: int = -1, rgb: bool = True, fp: bool = False, jpg: bool = False, **kwargs)[source]
Bases:
YarpListener
- __init__(name: str, in_topic: str, carrier: Literal['tcp', 'udp', 'mcast'] = 'tcp', should_wait: bool = True, persistent: bool = True, width: int = -1, height: int = -1, rgb: bool = True, fp: bool = False, jpg: bool = False, **kwargs)[source]
The Image listener using the BufferedPortImage construct parsed to a numpy array.
- Parameters:
name – str: Name of the subscriber
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
carrier – str: Carrier protocol (e.g. ‘tcp’). Default is ‘tcp’
should_wait – bool: Whether the subscriber should wait for the publisher to transmit a message. Default is True
persistent – bool: Whether the subscriber port should remain connected after closure. Default is True
width – int: Width of the image. Default is -1 (use the width of the received image)
height – int: Height of the image. Default is -1 (use the height of the received image)
rgb – bool: True if the image is RGB, False if it is grayscale. Default is True
fp – bool: True if the image is floating point, False if it is integer. Default is False
jpg – bool: True if the image should be decompressed from JPG. Default is False
- class wrapyfi.listeners.yarp.YarpAudioChunkListener(name: str, in_topic: str, carrier: Literal['tcp', 'udp', 'mcast'] = 'tcp', should_wait: bool = True, persistent: bool = True, channels: int = 1, rate: int = 44100, chunk: int = -1, **kwargs)[source]
Bases:
YarpListener
- __init__(name: str, in_topic: str, carrier: Literal['tcp', 'udp', 'mcast'] = 'tcp', should_wait: bool = True, persistent: bool = True, channels: int = 1, rate: int = 44100, chunk: int = -1, **kwargs)[source]
The AudioChunk listener using the Sound construct parsed as a numpy array.
- Parameters:
name – str: Name of the subscriber
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
carrier – str: Carrier protocol (e.g. ‘tcp’). Default is ‘tcp’
should_wait – bool: Whether the subscriber should wait for the publisher to transmit a message. Default is True
persistent – bool: Whether the subscriber port should remain connected after closure. Default is True
channels – int: Number of channels in the audio. Default is 1
rate – int: Sampling rate of the audio. Default is 44100
chunk – int: Number of samples in the audio chunk. Default is -1 (use the chunk size of the received audio)
- class wrapyfi.listeners.yarp.YarpPropertiesListener(name, in_topic, **kwargs)[source]
Bases:
YarpListener
- __init__(name, in_topic, **kwargs)[source]
Initialize the subscriber.
- Parameters:
name – str: Name of the publisher
in_topic – str: Name of the output topic preceded by ‘/’ (e.g. ‘/topic’)
carrier – str: Carrier protocol (e.g. ‘tcp’). Default is ‘tcp’
should_wait – bool: Whether the subscriber should wait for the publisher to transmit a message. Default is True
persistent – bool: Whether the subscriber port should remain connected after closure. Default is True
yarp_kwargs – dict: Additional kwargs for the Yarp middleware
kwargs – dict: Additional kwargs for the subscriber
wrapyfi.listeners.zeromq module
- class wrapyfi.listeners.zeromq.ZeroMQListener(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, socket_ip: str = '127.0.0.1', socket_pub_port: int = 5555, pubsub_monitor_topic: str = 'ZEROMQ/CONNECTIONS', pubsub_monitor_listener_spawn: str | None = 'process', zeromq_kwargs: dict | None = None, **kwargs)[source]
Bases:
Listener
- __init__(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, socket_ip: str = '127.0.0.1', socket_pub_port: int = 5555, pubsub_monitor_topic: str = 'ZEROMQ/CONNECTIONS', pubsub_monitor_listener_spawn: str | None = 'process', zeromq_kwargs: dict | None = None, **kwargs)[source]
Initialize the subscriber.
- Parameters:
name – str: Name of the subscriber
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
carrier – str: Carrier protocol. ZeroMQ currently only supports TCP for PUB/SUB pattern. Default is ‘tcp’
should_wait – bool: Whether the subscriber should wait for the publisher to transmit a message. Default is True
socket_ip – str: IP address of the socket. Default is ‘127.0.0.1
socket_pub_port – int: Port of the socket for publishing. Note that the subscriber listens directly to this port which is proxied . Default is 5555
pubsub_monitor_topic – str: Topic to monitor the connections. Default is ‘ZEROMQ/CONNECTIONS’
pubsub_monitor_listener_spawn – str: Whether to spawn the PUB/SUB monitor listener as a process or thread. Default is ‘process’
zeromq_kwargs – dict: Additional kwargs for the ZeroMQ middleware
kwargs – dict: Additional kwargs for the subscriber
- await_connection(socket=None, in_topic: str | None = None, repeats: int | None = None)[source]
Wait for the connection to be established.
- Parameters:
socket – zmq.Socket: Socket to await connection to
in_topic – str: Name of the input topic
repeats – int: Number of repeats to await connection. None for infinite. Default is None
- Returns:
bool: True if connection established, False otherwise
- class wrapyfi.listeners.zeromq.ZeroMQNativeObjectListener(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, deserializer_kwargs: dict | None = None, **kwargs)[source]
Bases:
ZeroMQListener
- __init__(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, deserializer_kwargs: dict | None = None, **kwargs)[source]
The NativeObject listener using the ZeroMQ message construct assuming the data is serialized as a JSON string. Deserializes the data (including plugins) using the decoder and parses it to a native object.
- Parameters:
name – str: Name of the subscriber
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
carrier – str: Carrier protocol. ZeroMQ currently only supports TCP for PUB/SUB pattern. Default is ‘tcp’
should_wait – bool: Whether the subscriber should wait for the publisher to transmit a message. Default is True
deserializer_kwargs – dict: Additional kwargs for the deserializer
- class wrapyfi.listeners.zeromq.ZeroMQImageListener(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, width: int = -1, height: int = -1, rgb: bool = True, fp: bool = False, jpg: bool = False, **kwargs)[source]
Bases:
ZeroMQNativeObjectListener
- __init__(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, width: int = -1, height: int = -1, rgb: bool = True, fp: bool = False, jpg: bool = False, **kwargs)[source]
The Image listener using the ZeroMQ message construct parsed to a numpy array.
- Parameters:
name – str: Name of the subscriber
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
carrier – str: Carrier protocol (e.g. ‘tcp’). Default is ‘tcp’
should_wait – bool: Whether the subscriber should wait for the publisher to transmit a message. Default is True
width – int: Width of the image. Default is -1 (use the width of the received image)
height – int: Height of the image. Default is -1 (use the height of the received image)
rgb – bool: True if the image is RGB, False if it is grayscale. Default is True
fp – bool: True if the image is floating point, False if it is integer. Default is False
jpg – bool: True if the image should be decompressed from JPG. Default is False
- class wrapyfi.listeners.zeromq.ZeroMQAudioChunkListener(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, channels: int = 1, rate: int = 44100, chunk: int = -1, **kwargs)[source]
Bases:
ZeroMQImageListener
- __init__(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, channels: int = 1, rate: int = 44100, chunk: int = -1, **kwargs)[source]
The AudioChunk listener using the ZeroMQ message construct parsed to a numpy array.
- Parameters:
name – str: Name of the subscriber
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
carrier – str: Carrier protocol. ZeroMQ currently only supports TCP for PUB/SUB pattern. Default is ‘tcp’
should_wait – bool: Whether the subscriber should wait for the publisher to transmit a message. Default is True
queue_size – int: Size of the queue for the subscriber. Default is 5
channels – int: Number of channels in the audio. Default is 1
rate – int: Sampling rate of the audio. Default is 44100
chunk – int: Number of samples in the audio chunk. Default is -1 (use the chunk size of the received audio)
- class wrapyfi.listeners.zeromq.ZeroMQPropertiesListener(name, in_topic, **kwargs)[source]
Bases:
ZeroMQListener
- __init__(name, in_topic, **kwargs)[source]
Initialize the subscriber.
- Parameters:
name – str: Name of the subscriber
in_topic – str: Name of the input topic preceded by ‘/’ (e.g. ‘/topic’)
carrier – str: Carrier protocol. ZeroMQ currently only supports TCP for PUB/SUB pattern. Default is ‘tcp’
should_wait – bool: Whether the subscriber should wait for the publisher to transmit a message. Default is True
socket_ip – str: IP address of the socket. Default is ‘127.0.0.1
socket_pub_port – int: Port of the socket for publishing. Note that the subscriber listens directly to this port which is proxied . Default is 5555
pubsub_monitor_topic – str: Topic to monitor the connections. Default is ‘ZEROMQ/CONNECTIONS’
pubsub_monitor_listener_spawn – str: Whether to spawn the PUB/SUB monitor listener as a process or thread. Default is ‘process’
zeromq_kwargs – dict: Additional kwargs for the ZeroMQ middleware
kwargs – dict: Additional kwargs for the subscriber
Module contents
- class wrapyfi.listeners.FallbackListener(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, missing_middleware_object: str = '', **kwargs)[source]
Bases:
Listener
- __init__(name: str, in_topic: str, carrier: str = 'tcp', should_wait: bool = True, missing_middleware_object: str = '', **kwargs)[source]
Initialize the Listener.
- Parameters:
name – str: The name of the listener
in_topic – str: The topic to listen to
carrier – str: The middleware carrier to use
should_wait – bool: Whether to wait for the listener to be established or not