lukmangrd/platypush
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Keep-alive logic implemented for websocket backend

Browse source
This commit is contained in:
Fabio Manganiello 2018-10-27 01:09:09 +02:00
parent 92a3759721
commit b365e7d126
1 changed files with 34 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
platypush/backend/websocket.py
View file

@ -19,7 +19,11 @@ class WebsocketBackend(Backend):
* **websockets** (``pip install websockets``) * **websockets** (``pip install websockets``)
""" """
def __init__(self, port=8765, bind_address='0.0.0.0', ssl_cert=None, **kwargs): # Websocket client message recv timeout in seconds
_websocket_client_timeout = 60
def __init__(self, port=8765, bind_address='0.0.0.0', ssl_cert=None,
client_timeout=_websocket_client_timeout, **kwargs):
""" """
:param port: Listen port for the websocket server (default: 8765) :param port: Listen port for the websocket server (default: 8765)
:type port: int :type port: int
@ -29,6 +33,9 @@ class WebsocketBackend(Backend):
:param ssl_cert: Path to the PEM certificate file if you want to enable SSL (default: None) :param ssl_cert: Path to the PEM certificate file if you want to enable SSL (default: None)
:type ssl_cert: str :type ssl_cert: str
:param client_timeout: Timeout without any messages being received before closing a client connection. A zero timeout keeps the websocket open until an error occurs (default: 60 seconds)
:type ping_timeout: int
""" """
super().__init__(**kwargs) super().__init__(**kwargs)
@ -36,6 +43,7 @@ class WebsocketBackend(Backend):
self.port = port self.port = port
self.bind_address = bind_address self.bind_address = bind_address
self.ssl_context = None self.ssl_context = None
self.client_timeout = client_timeout
if ssl_cert: if ssl_cert:
self.ssl_context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER) self.ssl_context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
@ -62,11 +70,17 @@ class WebsocketBackend(Backend):
super().run() super().run()
async def serve_client(websocket, path): async def serve_client(websocket, path):
self.logger.info('New websocket connection from {}'. self.logger.debug('New websocket connection from {}'.
format(websocket.remote_address[0])) format(websocket.remote_address[0]))
try: try:
while True:
if self.client_timeout:
msg = await asyncio.wait_for(websocket.recv(),
timeout=self.client_timeout)
else:
msg = await websocket.recv() msg = await websocket.recv()
msg = Message.build(msg) msg = Message.build(msg)
self.logger.info('Received message from {}: {}'. self.logger.info('Received message from {}: {}'.
format(websocket.remote_address[0], msg)) format(websocket.remote_address[0], msg))
@ -75,15 +89,19 @@ class WebsocketBackend(Backend):
if isinstance(msg, Request): if isinstance(msg, Request):
response = self.get_message_response(msg) response = self.get_message_response(msg)
assert response is not None
if response:
self.logger.info('Processing response on the websocket backend: {}'. self.logger.info('Processing response on the websocket backend: {}'.
format(response)) format(response))
await websocket.send(str(response)) await websocket.send(str(response))
except Exception as e: except Exception as e:
if isinstance(e, websockets.exceptions.ConnectionClosed): if isinstance(e, websockets.exceptions.ConnectionClosed):
self.logger.info('Websocket client {} closed connection'. self.logger.debug('Websocket client {} closed connection'.
format(websocket.remote_address[0]))
elif isinstance(e, asyncio.TimeoutError):
self.logger.debug('Websocket connection to {} timed out'.
format(websocket.remote_address[0])) format(websocket.remote_address[0]))
else: else:
self.logger.exception(e) self.logger.exception(e)
@ -96,7 +114,9 @@ class WebsocketBackend(Backend):
websocket_args['ssl'] = self.ssl_context websocket_args['ssl'] = self.ssl_context
loop = get_or_create_event_loop() loop = get_or_create_event_loop()
server = websockets.serve(serve_client, self.bind_address, self.port, **websocket_args) server = websockets.serve(serve_client, self.bind_address, self.port,
**websocket_args)
loop.run_until_complete(server) loop.run_until_complete(server)
loop.run_forever() loop.run_forever()