|
| def | __init__ (self, host=None, port=None, route=None, ssl=None) |
| |
| def | close (self) |
| |
| def | create_client (self) |
| |
| def | emit (self, message) |
| |
| def | on (self, event_name, func) |
| |
| def | on_close (self) |
| |
| def | on_error (self, error) |
| |
| def | on_message (self, message) |
| |
| def | on_open (self) |
| |
| def | once (self, event_name, func) |
| |
| def | remove (self, event_name, func) |
| |
| def | remove_all_listeners (self, event_name) |
| |
| def | run_forever (self) |
| |
| def | wait_for_response (self, message, reply_type=None, timeout=None) |
| |
Definition at line 30 of file client/ws.py.
| def mycroft.messagebus.client.ws.WebsocketClient.__init__ |
( |
|
self, |
|
|
|
host = None, |
|
|
|
port = None, |
|
|
|
route = None, |
|
|
|
ssl = None |
|
) |
| |
| def mycroft.messagebus.client.ws.WebsocketClient.build_url |
( |
|
host, |
|
|
|
port, |
|
|
|
route, |
|
|
|
ssl |
|
) |
| |
|
static |
| def mycroft.messagebus.client.ws.WebsocketClient.close |
( |
|
self | ) |
|
| def mycroft.messagebus.client.ws.WebsocketClient.create_client |
( |
|
self | ) |
|
| def mycroft.messagebus.client.ws.WebsocketClient.emit |
( |
|
self, |
|
|
|
message |
|
) |
| |
| def mycroft.messagebus.client.ws.WebsocketClient.on |
( |
|
self, |
|
|
|
event_name, |
|
|
|
func |
|
) |
| |
| def mycroft.messagebus.client.ws.WebsocketClient.on_close |
( |
|
self | ) |
|
| def mycroft.messagebus.client.ws.WebsocketClient.on_error |
( |
|
self, |
|
|
|
error |
|
) |
| |
On error start trying to reconnect to the websocket.
Definition at line 69 of file client/ws.py.
| def mycroft.messagebus.client.ws.WebsocketClient.on_message |
( |
|
self, |
|
|
|
message |
|
) |
| |
| def mycroft.messagebus.client.ws.WebsocketClient.on_open |
( |
|
self | ) |
|
| def mycroft.messagebus.client.ws.WebsocketClient.once |
( |
|
self, |
|
|
|
event_name, |
|
|
|
func |
|
) |
| |
| def mycroft.messagebus.client.ws.WebsocketClient.remove |
( |
|
self, |
|
|
|
event_name, |
|
|
|
func |
|
) |
| |
| def mycroft.messagebus.client.ws.WebsocketClient.remove_all_listeners |
( |
|
self, |
|
|
|
event_name |
|
) |
| |
Remove all listeners connected to event_name.
Args:
event_name: event from which to remove listeners
Definition at line 184 of file client/ws.py.
| def mycroft.messagebus.client.ws.WebsocketClient.run_forever |
( |
|
self | ) |
|
| def mycroft.messagebus.client.ws.WebsocketClient.wait_for_response |
( |
|
self, |
|
|
|
message, |
|
|
|
reply_type = None, |
|
|
|
timeout = None |
|
) |
| |
Send a message and wait for a response.
Args:
message (Message): message to send
reply_type (str): the message type of the expected reply.
Defaults to "<message.type>.response".
timeout: seconds to wait before timeout, defaults to 3
Returns:
The received message or None if the response timed out
Definition at line 114 of file client/ws.py.
| mycroft.messagebus.client.ws.WebsocketClient.client |
| mycroft.messagebus.client.ws.WebsocketClient.connected_event |
| mycroft.messagebus.client.ws.WebsocketClient.emitter |
| mycroft.messagebus.client.ws.WebsocketClient.retry |
| mycroft.messagebus.client.ws.WebsocketClient.started_running |
| mycroft.messagebus.client.ws.WebsocketClient.url |
The documentation for this class was generated from the following file: