kapitan/IXWebSocket
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Benjamin Sergeant 2019-08-06 20:55:44 -07:00
parent 64cfbe9514
commit 5c13cbb08f
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -16,7 +16,7 @@
The [*ws*](https://github.com/machinezone/IXWebSocket/tree/master/ws) folder countains many interactive programs for chat, [file transfers](https://github.com/machinezone/IXWebSocket/blob/master/ws/ws_send.cpp), [curl like](https://github.com/machinezone/IXWebSocket/blob/master/ws/ws_http_client.cpp) http clients, demonstrating client and server usage. The [*ws*](https://github.com/machinezone/IXWebSocket/tree/master/ws) folder countains many interactive programs for chat, [file transfers](https://github.com/machinezone/IXWebSocket/blob/master/ws/ws_send.cpp), [curl like](https://github.com/machinezone/IXWebSocket/blob/master/ws/ws_http_client.cpp) http clients, demonstrating client and server usage.
Here is what the client API looks like. ### WebSocket client API
``` ```
ix::WebSocket webSocket; ix::WebSocket webSocket;
@ -56,7 +56,7 @@ webSocket.sendBinary("some serialized binary data");
webSocket.stop() webSocket.stop()
``` ```
Here is what the server API looks like. Note that server support is very recent and subject to changes. ### WebSocket server API
``` ```
// Run a server on localhost at a given port. // Run a server on localhost at a given port.
@ -117,7 +117,7 @@ server.wait();
``` ```
Here is what the HTTP client API looks like. ### HTTP client API
``` ```
// //
@ -196,7 +196,7 @@ bool ok = httpClient.performRequest(args, [](const HttpResponsePtr& response)
// ok will be false if your httpClient is not async // ok will be false if your httpClient is not async
``` ```
Here is what the HTTP server API looks like. Note that HTTP server support is very, very recent and subject to changes. ### HTTP server API
``` ```
ix::HttpServer server(port, hostname); ix::HttpServer server(port, hostname);