README.rst 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. Wslay - The WebSocket library
  2. =============================
  3. Project Web: https://github.com/tatsuhiro-t/wslay
  4. Wslay is a WebSocket library written in C.
  5. It implements the protocol version 13 described in
  6. `RFC 6455 <http://tools.ietf.org/html/rfc6455>`_.
  7. This library offers 2 levels of API:
  8. event-based API and frame-based low-level API. For event-based API, it
  9. is suitable for non-blocking reactor pattern style. You can set
  10. callbacks in various events. For frame-based API, you can send
  11. WebSocket frame directly. Wslay only supports data transfer part of
  12. WebSocket protocol and does not perform opening handshake in HTTP.
  13. Wslay supports:
  14. * Text/Binary messages.
  15. * Automatic ping reply.
  16. * Callback interface.
  17. * External event loop.
  18. Wslay does not perform any I/O operations for its own. Instead, it
  19. offers callbacks for them. This makes Wslay independent on any I/O
  20. frameworks, SSL, sockets, etc. This makes Wslay portable across
  21. various platforms and the application authors can choose freely I/O
  22. frameworks.
  23. See Autobahn test reports:
  24. `server <http://wslay.sourceforge.net/autobahn/reports/servers/index.html>`_
  25. and
  26. `client <http://wslay.sourceforge.net/autobahn/reports/clients/index.html>`_.
  27. Requirements
  28. ------------
  29. `Sphinx <http://www.sphinx-doc.org/en/stable/>`_ is used to generate
  30. man pages.
  31. To build and run the unit test programs, the following packages are
  32. needed:
  33. * cunit >= 2.1
  34. To build and run the example programs, the following packages are
  35. needed:
  36. * nettle >= 2.4
  37. Build from git
  38. --------------
  39. Building from git is easy, but please be sure that at least autoconf 2.68 is
  40. used.::
  41. $ autoreconf -i
  42. $ automake
  43. $ autoconf
  44. $ ./configure
  45. $ make