twisted Package

twisted Package

base Module

node Module

websocket Module

class ebu_tt_live.twisted.websocket.BroadcastClientFactory(url, consumer=None, producer=None, *args, **kwargs)

Bases: ebu_tt_live.twisted.websocket.BroadcastFactoryCommon, autobahn.twisted.websocket.WebSocketClientFactory

connect()

register(client)

unregister(client)

class ebu_tt_live.twisted.websocket.BroadcastClientProtocol

Bases: ebu_tt_live.twisted.websocket.EBUWebsocketProtocolMixin, autobahn.twisted.websocket.WebSocketClientProtocol

connectionLost(reason)

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

@type reason: L{twisted.python.failure.Failure}

onMessage(payload, isBinary)

Implements autobahn.websocket.interfaces.IWebSocketChannel.onMessage()

onOpen()

Implements autobahn.websocket.interfaces.IWebSocketChannel.onOpen()

sendSequenceMessage(sequence_identifier, payload, isBinary=False, fragmentSize=None, sync=False, doNotCompress=False)

class ebu_tt_live.twisted.websocket.BroadcastFactoryCommon

Bases: object

consumer

producer

class ebu_tt_live.twisted.websocket.BroadcastServerFactory(url=None, producer=None, consumer=None)

Bases: ebu_tt_live.twisted.websocket.BroadcastFactoryCommon, autobahn.twisted.websocket.WebSocketServerFactory

listen()

real_port_number = None

register(client)

stopFactory()

This will be called before I stop listening on all Ports/Connectors.

This can be overridden to perform ‘shutdown’ tasks such as disconnecting database connections, closing files, etc.

It will be called, for example, before an application shuts down, if it was connected to a port. User code should not call this function directly.

unregister(client)

class ebu_tt_live.twisted.websocket.BroadcastServerProtocol

Bases: ebu_tt_live.twisted.websocket.EBUWebsocketProtocolMixin, autobahn.twisted.websocket.WebSocketServerProtocol

connectionLost(reason)

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

@type reason: L{twisted.python.failure.Failure}

onMessage(payload, isBinary)

Implements autobahn.websocket.interfaces.IWebSocketChannel.onMessage()

onOpen()

Implements autobahn.websocket.interfaces.IWebSocketChannel.onOpen()

sendSequenceMessage(sequence_identifier, payload, isBinary=False, fragmentSize=None, sync=False, doNotCompress=False)

class ebu_tt_live.twisted.websocket.EBUWebsocketProtocolMixin

Bases: object

This mixin exists because the WS protocol suggested in EBU-3370s1 is agnostic of client-server relationship in the sense that data can be streamed from client to server or the other way around. Based on which action a server/client is doing different functions should be available. This class holds the common logic.

action

consumer

class ebu_tt_live.twisted.websocket.LegacyBroadcastClientFactory(url, consumer, channels=None, *args, **kwargs)

Bases: autobahn.twisted.websocket.WebSocketClientFactory

channels

connect()

dataReceived(data)

pauseProducing()

resumeProducing()

stopProducing()

class ebu_tt_live.twisted.websocket.LegacyBroadcastClientProtocol

Bases: autobahn.twisted.websocket.WebSocketClientProtocol

onMessage(payload, isBinary)

Implements autobahn.websocket.interfaces.IWebSocketChannel.onMessage()

onOpen()

Implements autobahn.websocket.interfaces.IWebSocketChannel.onOpen()

subscribeChannel(channel)

unsubscribeChannel(channel)

class ebu_tt_live.twisted.websocket.LegacyBroadcastServerFactory(url)

Bases: autobahn.twisted.websocket.WebSocketServerFactory

broadcast(channel, msg)

listen()

pull()

register(client)

registerProducer(producer, streaming)

stopFactory()

This will be called before I stop listening on all Ports/Connectors.

This can be overridden to perform ‘shutdown’ tasks such as disconnecting database connections, closing files, etc.

It will be called, for example, before an application shuts down, if it was connected to a port. User code should not call this function directly.

unregister(client)

unregisterProducer()

write(channel, data)

class ebu_tt_live.twisted.websocket.LegacyBroadcastServerProtocol

Bases: autobahn.twisted.websocket.WebSocketServerProtocol

connectionLost(reason)

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

@type reason: L{twisted.python.failure.Failure}

onMessage(payload, isBinary)

Implements autobahn.websocket.interfaces.IWebSocketChannel.onMessage()

onOpen()

Implements autobahn.websocket.interfaces.IWebSocketChannel.onOpen()

sendMessageOnChannel(channel, payload, isBinary=False, fragmentSize=None, sync=False, doNotCompress=False)

class ebu_tt_live.twisted.websocket.TwistedConsumer(custom_consumer)

Bases: object

registerProducer(producer, streaming)

unregisterProducer()

write(data)

class ebu_tt_live.twisted.websocket.TwistedPullProducer(consumer, custom_producer)

Bases: object

emit_data(channel, data, delay=None)

resumeProducing()

stopProducing()

class ebu_tt_live.twisted.websocket.TwistedWSConsumer(custom_consumer)

Bases: object

This class wraps the protocol objects.

real_port_number = None

register(connection)

registerProducer(producer, streaming)

unregister(connection)

unregisterProducer()

write(data, **kwargs)

class ebu_tt_live.twisted.websocket.TwistedWSPushProducer(custom_producer)

Bases: object

This is a Twisted Push producer. The concept is related to twisted and it is not the same as our producer and consumer nodes.

emit_data(sequence_identifier, data, delay=None)

pauseProducing()

real_port_number = None

register(connection)

resumeProducing()

stopProducing()

unregister(connection)

class ebu_tt_live.twisted.websocket.UserInputServerFactory(url, consumer)

Bases: autobahn.twisted.websocket.WebSocketServerFactory

listen()

register(client)

resumeProducing()

unregister(client)

write(data)

class ebu_tt_live.twisted.websocket.UserInputServerProtocol

Bases: autobahn.twisted.websocket.WebSocketServerProtocol

connectionLost(reason)

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

@type reason: L{twisted.python.failure.Failure}

onMessage(payload, isBinary)

Implements autobahn.websocket.interfaces.IWebSocketChannel.onMessage()

onOpen()

Implements autobahn.websocket.interfaces.IWebSocketChannel.onOpen()

sendMessage(payload, isBinary=False, fragmentSize=None, sync=False, doNotCompress=False)

Implements autobahn.websocket.interfaces.IWebSocketChannel.sendMessage()