Skip to content

Latest commit

 

History

History
97 lines (71 loc) · 3.47 KB

README.md

File metadata and controls

97 lines (71 loc) · 3.47 KB
Raw

libws (alpha)

Build Status Coverage Status

libws is a multi-platform, non-blocking C websocket client library based on Libevent.

Note This project is currently in an Alpha state. A work in progess. Any bug reports are welcome.

Project aim

The aim of this project is to create a non-blocking portable websocket client library in C. Currently there are no plans to implement the server part of the protocol. There are lots

Some design goals:

  • Full RFC6455 compatability.
  • Use the C89 standard for best portability.
  • CMake build system with system introspection.
  • Intuitive and stable API.
  • Message based, frame based and streaming API.
  • Full unit test suite.
  • Both WS and WSS support.
  • Should pass the entire Autobahn Test Suite.
  • Support for Windows, Linux and OSX, as well as other Unix OS versions.

Building

To build the project using CMake.

Unix

$ mkdir build && cd build
$ cmake ..
$ ctest # Run all tests, use --help for extra settings
$ bin/libws_tests # Get a menu and run a specific test manually.

Windows

From the git bash console:

$ git submodule update --init deps/libevent # Make sure we have Libevent.
$ ./build_deps.sh
$ mkdir build && cd build
$ cmake -DLibevent_DIR=deps/libevent .. # We must specify the Libevent location.

Test suite

Both the regression tests and Autobahn Test Suite are run continously on Linux/OSX using Travis-CI on any push or pull request done on this repository. Statistics about the coverage of the unit tests is uploaded to Coveralls on each build as well.

Regression tests

libws has a set of regression tests that can be run using CTest. If valgrind is detected, these tests are by default run using valgrind to detect any memory leaks (this can be turned off by setting cmake -DLIBWS_WITH_MEMCHECK=OFF ..).

$ mkdir build && cd build
$ cmake ..
$ ctest # Run all tests, use --help for extra settings
$ bin/libws_tests # Or get a menu and run a specific test manually.

Autobahn Test Suite

The Autobahn Test Suite is a set of tests that verifies that a websocket endpoint is behaving according to the websocket standard. Libws implements a client that can run towards the Autobahn fuzzingserver.

Currently libws passes all tests (excluding the extension tests, which are optional).

To build and run these tests first you need to install the test suite itself and start the fuzzing server:

$ sudo pip install autobahntestsuite
$ wstest -m fuzzingserver --debug & # Start in the background (or a separate screen if you like).

Then you can run the autobahn client:

$ git submodule update --init # We need some extra dependencies.
$ mkdir build && cd build
$ cmake -DLIBWS_WITH_AUTOBAHN=ON ..
$ bin/autobahntest --config ../test/autobahn/libws.cfg # Use the default config.
$ bin/autobahntest --help

To see detailed results for all tests surf to http://localhost:8080