pyrtma.client

pyrtma.client module

Includes Client class and associated exception classes

Functions

cast	Cast a value to a type.
client_context	Context manager function to simplify initializing a pyrtma Client
contextmanager	@contextmanager decorator.
get_header_cls	Get the correct header class depending on whether timecode is used
get_msg_cls	get msg class for a given message type ID
requires_connection	Decorator wrapper for Client methods that require a connection
warn	Issue a warning, or maybe ignore it or raise an exception.
wraps	Decorator factory to apply update_wrapper() to a wrapper function

Classes

Client	RTMA Client interface
Message	Message class
MessageData	MessageData base class
MessageHeader	RTMA Message Header class
TypeVar	Type variable.

Exceptions

AcknowledgementTimeout	Raised when client does not receive ack from message manager.
ClientError	Base exception for all Client Errors.
ConnectionLost	Raised when there is a connection error with the server.
InvalidDestinationHost	Raised when client tries to send to an invalid host.
InvalidDestinationModule	Raised when client tries to send to an invalid module.
InvalidMessageDefinition	Raised when there is message definition is out of sync with sent data.
MessageManagerNotFound	Raised when unable to connect to message manager.
NotConnectedError	Raised when the client tries to read/write while not connected.
SocketOptionError	Raised when unable to set socket options.
UnknownMessageType	Raised when there is no message definition.