Repository files navigation

gevent-websocket is a WebSocket library for thegevent networking library.

Features include:

• Integration on both socket level or using an abstract interface.
• RPC and PubSub framework usingWAMP (WebSocket ApplicationMessaging Protocol).
• Easily extendible using a simple WebSocket protocol plugin API

from geventwebsocket import WebSocketServer, WebSocketApplication, Resourcefrom collections import OrderedDictclass EchoApplication(WebSocketApplication):    def on_open(self):        print("Connection opened")    def on_message(self, message):        self.ws.send(message)    def on_close(self, reason):        print(reason)WebSocketServer(    ('', 8000),    Resource(OrderedDict([('/', EchoApplication)]))).serve_forever()

or a low level implementation:

from gevent import pywsgifrom geventwebsocket.handler import WebSocketHandlerdef websocket_app(environ, start_response):    if environ["PATH_INFO"] == '/echo':        ws = environ["wsgi.websocket"]        message = ws.receive()        ws.send(message)server = pywsgi.WSGIServer(("", 8000), websocket_app,    handler_class=WebSocketHandler)server.serve_forever()

More examples can be found in theexamples directory. Hopefully moredocumentation will be available soon.

The easiest way to install gevent-websocket is directly fromPyPi using pip orsetuptools by running the commands below:

$ pip install gevent-websocket

Using Gunicorn it is even more easy to start a server. Only thewebsocket_app from the previous example is required to start the server.Start Gunicorn using the following command and worker class to enable WebSocketfuntionality for the application.

gunicorn -k "geventwebsocket.gunicorn.workers.GeventWebSocketWorker" wsgi:websocket_app

gevent-websocket is pretty fast, but can be accelerated further byinstallingwsaccel and ujson or simplejson:

$ pip install wsaccel ujson

gevent-websocket automatically detectswsaccell and uses the Cythonimplementation for UTF8 validation and later also frame masking anddemasking.

Get in touch on IRC #gevent on Freenode or on the Geventmailinglist. Issues can be createdonBitbucket.