Pass WebSocket server options in the configuration (Fixes #7)

docs/quickstart.rst

@@ -5,6 +5,30 @@ Installation
 
     pip install flask-sock
 
+Configuration
+-------------
+
+The only configuration option is ``SOCK_SERVER_OPTIONS``. If this option is
+present in the application instance's ``config`` object, it must be a
+dictionary with configuration options for the WebSocket server. Notable
+options include:
+
+- ``ping_interval``: Send ping packets to clients at the requested interval in
+  seconds. Set to ``None`` (the default) to disable ping/pong logic. Enable to
+  prevent disconnections when the line is idle for a certain amount of time, or
+  to detect unresponsive clients and disconnect them. A recommended interval is
+  25 seconds.
+- ``max_message_size``: The maximum size allowed for a message, in bytes, or
+  ``None`` for no limit. The default is ``None``.
+
+Example::
+
+    app.config['SOCK_SERVER_OPTIONS'] = {'ping_interval': 25}
+
+The complete list of available options is documented in the constructor of the
+`simple_websocket.Server <https://simple-websocket.readthedocs.io/en/latest/api.html#the-server-class>`_
+class.
+
 Example
 -------
 

example/echo-eventlet.py

@@ -5,6 +5,7 @@
 from flask import Flask, render_template
 from flask_sock import Sock
 app = Flask(__name__)
+app.config['SOCK_SERVER_OPTIONS'] = {'ping_interval': 25}
 
 sock = Sock(app)
 

example/echo-gevent.py

@@ -5,6 +5,7 @@
 from flask import Flask, render_template
 from flask_sock import Sock
 app = Flask(__name__)
+app.config['SOCK_SERVER_OPTIONS'] = {'ping_interval': 25}
 
 sock = Sock(app)
 

example/echo.py

@@ -2,6 +2,8 @@
 from flask_sock import Sock
 
 app = Flask(__name__)
+app.config['SOCK_SERVER_OPTIONS'] = {'ping_interval': 25}
+
 sock = Sock(app)
 
 

src/flask_sock/__init__.py

@@ -1,5 +1,5 @@
 from functools import wraps
-from flask import Blueprint, request, Response
+from flask import Blueprint, request, Response, current_app
 from simple_websocket import Server, ConnectionClosed
 
 
@@ -53,7 +53,8 @@ def websocket_route(ws):
         def decorator(f):
             @wraps(f)
             def websocket_route(*args, **kwargs):  # pragma: no cover
-                ws = Server(request.environ)
+                ws = Server(request.environ, **current_app.config.get(
+                    'SOCK_SERVER_OPTIONS', {}))
                 try:
                     f(ws, *args, **kwargs)
                 except ConnectionClosed: