diff --git a/examples/sanic/README.rst b/examples/sanic/README.rst new file mode 100644 index 0000000..c748df7 --- /dev/null +++ b/examples/sanic/README.rst @@ -0,0 +1,42 @@ +Socket.IO sanic Examples +======================== + +This directory contains example Socket.IO applications that are compatible with +asyncio and the sanic framework. These applications require Python 3.5 or +later. + +Note that because sanic does not support the WebSocket protocol, the only +transport is long-polling at this time. + +app.py +------ + +A basic "kitchen sink" type application that allows the user to experiment +with most of the available features of the Socket.IO server. + +latency.py +---------- + +A port of the latency application included in the official Engine.IO +Javascript server. In this application the client sends *ping* messages to +the server, which are responded by the server with a *pong*. The client +measures the time it takes for each of these exchanges and plots these in real +time to the page. + +This is an ideal application to measure the performance of the different +asynchronous modes supported by the Socket.IO server. + +Running the Examples +-------------------- + +To run these examples, create a virtual environment, install the requirements +and then run:: + + $ python app.py + +or:: + + $ python latency.py + +You can then access the application from your web browser at +``http://localhost:8000``. diff --git a/examples/sanic/app.html b/examples/sanic/app.html new file mode 100755 index 0000000..1668814 --- /dev/null +++ b/examples/sanic/app.html @@ -0,0 +1,91 @@ + + + + Flask-SocketIO Test + + + + + +

Flask-SocketIO Test

+

Send:

+
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+ + + +
+
+ + +
+
+ +
+

Receive:

+

+ + diff --git a/examples/sanic/app.py b/examples/sanic/app.py new file mode 100755 index 0000000..712f0dd --- /dev/null +++ b/examples/sanic/app.py @@ -0,0 +1,89 @@ +import asyncio + +from sanic import Sanic +from sanic.response import html + +import socketio + +sio = socketio.AsyncServer(async_mode='sanic') +app = Sanic() +sio.attach(app) + + +async def background_task(): + """Example of how to send server generated events to clients.""" + count = 0 + while True: + await sio.sleep(10) + count += 1 + await sio.emit('my response', {'data': 'Server generated event'}, + namespace='/test') + + +@app.route('/') +async def index(request): + with open('app.html') as f: + return html(f.read()) + + +@sio.on('my event', namespace='/test') +async def test_message(sid, message): + await sio.emit('my response', {'data': message['data']}, room=sid, + namespace='/test') + + +@sio.on('my broadcast event', namespace='/test') +async def test_broadcast_message(sid, message): + await sio.emit('my response', {'data': message['data']}, namespace='/test') + + +@sio.on('join', namespace='/test') +async def join(sid, message): + sio.enter_room(sid, message['room'], namespace='/test') + await sio.emit('my response', {'data': 'Entered room: ' + message['room']}, + room=sid, namespace='/test') + + +@sio.on('leave', namespace='/test') +async def leave(sid, message): + sio.leave_room(sid, message['room'], namespace='/test') + await sio.emit('my response', {'data': 'Left room: ' + message['room']}, + room=sid, namespace='/test') + + +@sio.on('close room', namespace='/test') +async def close(sid, message): + await sio.emit('my response', + {'data': 'Room ' + message['room'] + ' is closing.'}, + room=message['room'], namespace='/test') + await sio.close_room(message['room'], namespace='/test') + + +@sio.on('my room event', namespace='/test') +async def send_room_message(sid, message): + await sio.emit('my response', {'data': message['data']}, + room=message['room'], namespace='/test') + + +@sio.on('disconnect request', namespace='/test') +async def disconnect_request(sid): + await sio.disconnect(sid, namespace='/test') + + +@sio.on('connect', namespace='/test') +async def test_connect(sid, environ): + await sio.emit('my response', {'data': 'Connected', 'count': 0}, room=sid, + namespace='/test') + + +@sio.on('disconnect', namespace='/test') +def test_disconnect(sid): + print('Client disconnected') + + +app.static('/static', './static') + + +if __name__ == '__main__': + sio.start_background_task(background_task) + app.run() diff --git a/examples/sanic/latency.html b/examples/sanic/latency.html new file mode 100755 index 0000000..769e9ef --- /dev/null +++ b/examples/sanic/latency.html @@ -0,0 +1,64 @@ + + + + Socket.IO Latency + + + +

Socket.IO Latency

+

(connecting)

+ + + + + + + + diff --git a/examples/sanic/latency.py b/examples/sanic/latency.py new file mode 100755 index 0000000..2e1712f --- /dev/null +++ b/examples/sanic/latency.py @@ -0,0 +1,25 @@ +from sanic import Sanic +from sanic.response import html + +import socketio + +sio = socketio.AsyncServer(async_mode='sanic') +app = Sanic() +sio.attach(app) + + +@app.route('/') +def index(request): + with open('latency.html') as f: + return html(f.read()) + + +@sio.on('ping_from_client') +async def ping(sid): + await sio.emit('pong_from_server', room=sid) + +app.static('/static', './static') + + +if __name__ == '__main__': + app.run() diff --git a/examples/sanic/requirements.txt b/examples/sanic/requirements.txt new file mode 100644 index 0000000..08e8972 --- /dev/null +++ b/examples/sanic/requirements.txt @@ -0,0 +1,8 @@ +aiofiles==0.3.0 +httptools==0.0.9 +python_engineio +python_socketio +sanic==0.3.1 +six==1.10.0 +ujson==1.35 +uvloop==0.8.0 diff --git a/examples/sanic/static/style.css b/examples/sanic/static/style.css new file mode 100644 index 0000000..d20bcad --- /dev/null +++ b/examples/sanic/static/style.css @@ -0,0 +1,4 @@ +body { margin: 0; padding: 0; font-family: Helvetica Neue; } +h1 { margin: 100px 100px 10px; } +h2 { color: #999; margin: 0 100px 30px; font-weight: normal; } +#latency { color: red; }