aria2/deps/wslay/README.rst
Tatsuhiro Tsujikawa 86ecf36abb Added wslay WebSocket library.
I made following modifications to the original library: The doc
directory was removed. Made shared library disabled by
configure. Removed doc from SUBDIRS in Makefile.am.
2012-03-21 00:46:16 +09:00

33 lines
1.2 KiB
ReStructuredText

Wslay - The WebSocket library
=============================
Project Web: http://wslay.sourceforge.net/
Wslay is a WebSocket library written in C.
It implements the protocol version 13 described in
`RFC 6455 <http://tools.ietf.org/html/rfc6455>`_.
This library offers 2 levels of API:
event-based API and frame-based low-level API. For event-based API, it
is suitable for non-blocking reactor pattern style. You can set
callbacks in various events. For frame-based API, you can send
WebSocket frame directly. Wslay only supports data transfer part of
WebSocket protocol and does not perform opening handshake in HTTP.
Wslay supports:
* Text/Binary messages.
* Automatic ping reply.
* Callback interface.
* External event loop.
Wslay does not perform any I/O operations for its own. Instead, it
offers callbacks for them. This makes Wslay independent on any I/O
frameworks, SSL, sockets, etc. This makes Wslay protable across
various platforms and the application authors can choose freely I/O
frameworks.
See Autobahn test reports:
`server <http://wslay.sourceforge.net/autobahn/reports/servers/index.html>`_
and
`client <http://wslay.sourceforge.net/autobahn/reports/clients/index.html>`_.