openstack/deb-python-websocket-client
Code Issues Proposed changes

fixed #198

Browse Source 
introduce on_data callback to pass data type.
This commit is contained in:
liris
2015-07-30 09:17:24 +09:00
parent 821808f229
commit 0dcebf652b
2 changed files with 14 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
ChangeLog
View File

@@ -10,6 +10,7 @@ ChangeLog
- add support for ssl cert chains to support client certs (#195) - add support for ssl cert chains to support client certs (#195)
- fix string formatting in exception (#196) - fix string formatting in exception (#196)
- fix typo in README.rst (#197) - fix typo in README.rst (#197)
- introduce on_data callback to pass data type. (#198)
- 0.32.0 - 0.32.0

14
websocket/_app.py
View File

@@ -48,7 +48,8 @@ class WebSocketApp(object):
on_close=None, on_ping=None, on_pong=None, on_close=None, on_ping=None, on_pong=None,
on_cont_message=None, on_cont_message=None,
keep_running=True, get_mask_key=None, cookie=None, keep_running=True, get_mask_key=None, cookie=None,
subprotocols=None): subprotocols=None,
on_data=None):
""" """
url: websocket url. url: websocket url.
header: custom header for websocket handshake. header: custom header for websocket handshake.
@@ -71,6 +72,14 @@ class WebSocketApp(object):
The passing 2nd arugment is utf-8 string which we get from the server. The passing 2nd arugment is utf-8 string which we get from the server.
The 3rd arugment is continue flag. if 0, the data continue The 3rd arugment is continue flag. if 0, the data continue
to next frame data to next frame data
on_data: callback object which is called when a message recieved.
This is called before on_message or on_cont_message,
and then on_message or on_cont_message is called.
on_data has 4 argument.
The 1st arugment is this class object.
The passing 2nd arugment is utf-8 string which we get from the server.
The 3rd argument is data type. ABNF.OPCODE_TEXT or ABNF.OPCODE_BINARY will be came.
The 4rd arugment is continue flag. if 0, the data continue
keep_running: a boolean flag indicating whether the app's main loop keep_running: a boolean flag indicating whether the app's main loop
should keep running, defaults to True should keep running, defaults to True
get_mask_key: a callable to produce new mask keys, get_mask_key: a callable to produce new mask keys,
@@ -82,6 +91,7 @@ class WebSocketApp(object):
self.cookie = cookie self.cookie = cookie
self.on_open = on_open self.on_open = on_open
self.on_message = on_message self.on_message = on_message
self.on_data = on_data
self.on_error = on_error self.on_error = on_error
self.on_close = on_close self.on_close = on_close
self.on_ping = on_ping self.on_ping = on_ping
@@ -192,11 +202,13 @@ class WebSocketApp(object):
elif op_code == ABNF.OPCODE_PONG: elif op_code == ABNF.OPCODE_PONG:
self._callback(self.on_pong, frame.data) self._callback(self.on_pong, frame.data)
elif op_code == ABNF.OPCODE_CONT and self.on_cont_message: elif op_code == ABNF.OPCODE_CONT and self.on_cont_message:
self._callback(self.on_data, data, frame.opcode, frame.fin)
self._callback(self.on_cont_message, frame.data, frame.fin) self._callback(self.on_cont_message, frame.data, frame.fin)
else: else:
data = frame.data data = frame.data
if six.PY3 and frame.opcode == ABNF.OPCODE_TEXT: if six.PY3 and frame.opcode == ABNF.OPCODE_TEXT:
data = data.decode("utf-8") data = data.decode("utf-8")
self._callback(self.on_data, data, frame.opcode, True)
self._callback(self.on_message, data) self._callback(self.on_message, data)
except Exception as e: except Exception as e:
self._callback(self.on_error, e) self._callback(self.on_error, e)