Cutlery/calibre
1
0
Fork 0
mirror of https://github.com/kovidgoyal/calibre.git synced 2025-07-09 03:04:10 -04:00
Code Issues Packages Projects Releases Wiki Activity

Notify the handler on a PONG

Browse Source
This commit is contained in:
Kovid Goyal 2015-10-26 18:38:01 +05:30
parent 8fc0a9f3c4
commit 747f1012e0
1 changed files with 24 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/calibre/srv/web_socket.py
View File

@ -378,6 +378,11 @@ class WebSocketConnection(HTTPConnection):
f.is_close_frame = opcode == CLOSE f.is_close_frame = opcode == CLOSE
with self.cf_lock: with self.cf_lock:
self.control_frames.append(f) self.control_frames.append(f)
elif opcode == PONG:
try:
self.websocket_handler.handle_websocket_pong(self.websocket_connection_id, data)
except Exception:
self.log.exception('Error in PONG handler:')
self.set_ws_state() self.set_ws_state()
def websocket_close(self, code=NORMAL_CLOSE, reason=b''): def websocket_close(self, code=NORMAL_CLOSE, reason=b''):
@ -452,12 +457,22 @@ class WebSocketConnection(HTTPConnection):
with self.cf_lock: with self.cf_lock:
self.control_frames.append(BytesIO(frame)) self.control_frames.append(BytesIO(frame))
def send_websocket_ping(self, data=b''):
''' Send a PING to the remote client, it should reply with a PONG which
will be sent to the handle_websocket_pong callback in your handler. '''
if isinstance(data, type('')):
data = data.encode('utf-8')
frame = create_frame(True, PING, data)
with self.cf_lock:
self.control_frames.append(BytesIO(frame))
def handle_websocket_data(self, data, message_starting, message_finished): def handle_websocket_data(self, data, message_starting, message_finished):
''' Called when some data is received from the remote client. In general the ''' Called when some data is received from the remote client. In general the
data may not constitute a complete "message", use the message_starting data may not constitute a complete "message", use the message_starting
and message_finished flags to re-assemble it into a complete message in and message_finished flags to re-assemble it into a complete message in
the handler. ''' the handler. '''
self.websocket_handler.handle_websocket_data(data, message_starting, message_finished, self.websocket_connection_id) self.websocket_handler.handle_websocket_data(self.websocket_connection_id, data, message_starting, message_finished)
class DummyHandler(object): class DummyHandler(object):
@ -465,7 +480,10 @@ class DummyHandler(object):
conn = connection_ref() conn = connection_ref()
conn.websocket_close(NORMAL_CLOSE, 'No WebSocket handler available') conn.websocket_close(NORMAL_CLOSE, 'No WebSocket handler available')
def handle_websocket_data(self, data, message_starting, message_finished, connection_id): def handle_websocket_data(self, connection_id, data, message_starting, message_finished):
pass
def handle_websocket_pong(self, connection_id, data):
pass pass
def handle_websocket_close(self, connection_id): def handle_websocket_close(self, connection_id):
@ -490,9 +508,12 @@ class EchoHandler(object):
def handle_websocket_upgrade(self, connection_id, connection_ref, inheaders): def handle_websocket_upgrade(self, connection_id, connection_ref, inheaders):
self.ws_connections[connection_id] = connection_ref self.ws_connections[connection_id] = connection_ref
def handle_websocket_data(self, data, message_starting, message_finished, connection_id): def handle_websocket_data(self, connection_id, data, message_starting, message_finished):
self.conn(connection_id).send_websocket_frame(data, message_starting, message_finished) self.conn(connection_id).send_websocket_frame(data, message_starting, message_finished)
def handle_websocket_pong(self, connection_id, data):
pass
def handle_websocket_close(self, connection_id): def handle_websocket_close(self, connection_id):
self.ws_connections.pop(connection_id, None) self.ws_connections.pop(connection_id, None)