FFWs#

class firefly_client.FFWs(channel, wsproto, location, auth_headers, header_cb)#

Bases: object

For use only by FireflyClient to manage web sockets and channel connections. This class should never be instantiated directly. It should only be used though the static methods

Attributes Summary

connections

Methods Summary

`add_listener`(wsproto, auth_headers, channel, ...)
`close_ws_connection`(channel, location)
`debug_header_event_message`(ev)
`debug_show_env`(socket_headers)
`disconnect`()	Disconnect the WebSocket.
`do_add_listener`(callback[, name])
`do_remove_listener`(callback[, name])
`do_run_forever`()
`execute_callbacks`(ev[, do_callback])
`get`(channel, location)
`get_listener_cnt`()
`has`(channel, location)
`received_message`(message, header_cb)
`remove_listener`(channel, location, callback)
`wait_for_events`(channel, location)

Attributes Documentation

connections = {}#

Methods Documentation

classmethod add_listener(wsproto, auth_headers, channel, location, callback, name='ALL_EVENTS_ENABLED', header_cb=None)#

classmethod close_ws_connection(channel, location)#

debug_header_event_message(ev)#

debug_show_env(socket_headers)#

disconnect()#: Disconnect the WebSocket.

do_add_listener(callback, name='ALL_EVENTS_ENABLED')#

do_remove_listener(callback, name='ALL_EVENTS_ENABLED')#

do_run_forever()#

execute_callbacks(ev, do_callback=True)#

classmethod get(channel, location)#

get_listener_cnt()#

classmethod has(channel, location)#

received_message(message, header_cb)#

classmethod remove_listener(channel, location, callback, name='ALL_EVENTS_ENABLED')#

classmethod wait_for_events(channel, location)#