summaryrefslogtreecommitdiff
path: root/README.md
blob: 49f75d1b45e16d688d3e771c712a4b1852baf43f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
### Introduction
`QtWebSockets` is a pure Qt implementation of WebSockets - both client and server.
It is implemented as a Qt add-on module, that can easily be embedded into existing Qt projects. It has no other dependencies than Qt.

### Features
* Client and server capable
* Text and binary sockets
* Frame-based and message-based signals
* Strict Unicode checking
* WSS and proxy support

### Requirements
Qt 5.x

### Build And Usage
Checkout the source code from code.qt.io
Go into the source directory and execute:

    qmake
    make
    make install


The last command will install `QtWebSockets` as a Qt module.

To use, add `websockets` to the QT variable.

`QT += websockets`

### Compliance
`QtWebSockets` is compliant with [RFC6455](http://datatracker.ietf.org/doc/rfc6455/?include_text=1) and has been tested with the [Autobahn Testsuite](http://autobahn.ws/testsuite).

### Missing Features
* Extensions and sub-protocols