gevent-websocket /

Filename Size Date modified Message
examples
geventwebsocket
tests
80 B
470 B
150 B
1.5 KB
146 B
2.2 KB
946 B

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.5 or newer and Gevent and its dependencies. The latest release can be download from PyPi or by cloning the repository and running:

$ python setup.py install

The easiest way to install gevent-websocket is directly from PyPi using pip or setuptools by running the commands below:

$ pip install gevent-websocket

or:

$ easy_install gevent-websocket

This also installs the dependencies automatically.

Usage

Gevent Server

At the moment gevent-websocket has one handler based on the Pywsgi gevent Hook up the WebSocketHandler to the Pywsgi Server by setting the handler_class when creating the server instance.

from gevent import pywsgi
from geventwebsocket.handler import WebSocketHandler

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

The handler enhances your WSGI app with a Websocket environment variable when the browser requests a Websocket connection.

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

Gunicorn Server

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 to enable Websocket funtionality for the application.

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

Backwards incompatible changes

  • The wait() method was renamed to receive().
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.