Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
examples
geventwebsocket
tests
AUTHORS
LICENSE
MANIFEST.in
README
README.rst
setup.py

README.rst

gevent-websocket

gevent-websocket is a websocket library for the gevent networking library written written and maintained by Jeffrey Gelens It is licensed under the BSD license.

Installation

Install Python 2.4 or newer and gevent and its dependencies. The latest release can be download from PyPi or by cloning the repository.

Usage

Native Gevent

At the moment gevent-websocket has one handler based on the Pywsgi gevent server. Set the handler_class when creating a pywsgi server instance to make use of the Websocket functionality:

from gevent import pywsgi
from geventwebsocket.handler import WebSocketHandler

server = pywsgi.WSGIServer(('127.0.0.1', 8000), websocket_app,
    handler_class=WebSocketHandler)
server.serve_forever()

Afterwards write a WSGI application with a 3rd parameter, namely a websocket instance:

def websocket_app(environ, start_response):
    if environ["PATH_INFO"] == '/echo':
        ws = environ["wsgi.websocket"]
        message = ws.wait()
        ws.send(message)

Gunicorn

Using Gunicorn it is even more easy to start a server. Only the websocket_app from the previous example is required to start the server. Start Gunicorn using the following command and worker class:

gunicorn -k "geventwebsocket.gunicorn.workers.GeventWebSocketWorker" gunicorn_websocket:websocket_app
Something went wrong with that request. Please try again.