morpheus.pipeline.receiver.Receiver

class Receiver(parent, port_number)[source]

Bases: object

The Receiver object represents a downstream port on a StreamWrapper object that gets messages from a Sender.

Parameters

parent<bsp-code-inline code="morpheus.pipeline.pipeline.StreamWrapper">morpheus.pipeline.pipeline.StreamWrapper</bsp-code-inline>: Parent StreamWrapper object.
port_numberint: Receiver port number.

Attributes

in_pair
in_stream
in_type
is_complete: A receiver is complete if all input senders are also complete.
is_partial: A receiver is partially complete if any input sender is complete.
parent

Methods

`get_input_pair`()	Returns the input `StreamPair` which is a tuple consisting of the parent node and the parent node's output type.
`link`()	The linking phase determines the final type of the `Receiver` and connects all underlying stages.

get_input_pair()[source]

Returns the input StreamPair which is a tuple consisting of the parent node and the parent node’s output type.

property is_complete: A receiver is complete if all input senders are also complete.

property is_partial: A receiver is partially complete if any input sender is complete. Receivers are usually partially complete if there is a circular pipeline.

The linking phase determines the final type of the Receiver and connects all underlying stages.

Raises:: RuntimeError: Throws a RuntimeError if the predicted input port type determined during the build phase is different than the current port type.