Broker handler
SupportedBroker
¶
Bases: Enum
Enum for the supported brokers.
UnsupportedBrokerError(broker_name)
¶
Bases: Exception
Exception if a broker isn't implemented yet.
get_broker(data_stream, is_publisher=False)
¶
Derive the broker for the given data stream.
| PARAMETER | DESCRIPTION |
|---|---|
data_stream |
Data stream instance from which the broker is inferred
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
broker
|
The corresponding broker instance derived from data stream.
TYPE:
|
| RAISES | DESCRIPTION |
|---|---|
UnsupportedBrokerError
|
Is raised when the given data stream belongs to a broker that is currently not supported by StreamPipes Python. |
get_broker_description(data_stream)
¶
Derive the decription of the broker for the given data stream.
| PARAMETER | DESCRIPTION |
|---|---|
data_stream |
Data stream instance from which the broker is inferred
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
broker
|
The corresponding broker description derived from data stream.
TYPE:
|
| RAISES | DESCRIPTION |
|---|---|
UnsupportedBrokerError
|
Is raised when the given data stream belongs to a broker that is currently not supported by StreamPipes Python. |