Skip to content
This repository was archived by the owner on Apr 29, 2022. It is now read-only.

Commit 6154ea6

Browse files
author
Kenneth Reitz
committed
websocket interface
1 parent 7335ce8 commit 6154ea6

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,15 @@ Production services are provided by `gevent <http://www.gevent.org>`_
3636
and `gevent-websocket <http://www.gelens.org/code/gevent-websocket/>`_.
3737

3838
Anything that inserts ``wsgi.websocket`` into the WSGI environ is
39-
supported, but gevent-websocket is recommended.
39+
supported, but gevent-websocket is recommended.
40+
41+
42+
WebSocket Interface
43+
-------------------
44+
45+
The websocket interface that is passed into your routes is
46+
`provided by gevent-websocket <https://bitbucket.org/Jeffrey/gevent-websocket/src/6da9851586843a655851b1b196c0d90599de091d/geventwebsocket/websocket.py?at=v0.3.6>`_.
47+
The basic methods are fairly straitforward — 
48+
``send``, ``receive``, ``send_fname``, and ``close``.
49+
50+
Hopefully, more documentation will be available soon.

0 commit comments

Comments
 (0)