Links2004/arduinoWebSockets
1
0
Fork 1
mirror of https://github.com/Links2004/arduinoWebSockets.git synced 2025-07-30 23:57:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

Syntax highlighting in README.md

Browse Source
This commit is contained in:
Nufflee
2019-07-15 23:13:38 +02:00
committed by GitHub
parent 06a7bb177b
commit 771831c57e
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -57,22 +57,22 @@ The mode can be activated in the ```WebSockets.h``` (see WEBSOCKETS_NETWORK_TYPE
### High Level Client API ### ### High Level Client API ###
- `begin` : Initiate connection sequence to the websocket host. - `begin` : Initiate connection sequence to the websocket host.
``` ```c++
void begin(const char *host, uint16_t port, const char * url = "/", const char * protocol = "arduino"); void begin(const char *host, uint16_t port, const char * url = "/", const char * protocol = "arduino");
void begin(String host, uint16_t port, String url = "/", String protocol = "arduino"); void begin(String host, uint16_t port, String url = "/", String protocol = "arduino");
``` ```
- `onEvent`: Callback to handle for websocket events - `onEvent`: Callback to handle for websocket events
``` ```c++
void onEvent(WebSocketClientEvent cbEvent); void onEvent(WebSocketClientEvent cbEvent);
``` ```
- `WebSocketClientEvent`: Handler for websocket events - `WebSocketClientEvent`: Handler for websocket events
``` ```c++
void (*WebSocketClientEvent)(WStype_t type, uint8_t * payload, size_t length) void (*WebSocketClientEvent)(WStype_t type, uint8_t * payload, size_t length)
``` ```
Where `WStype_t type` is defined as: Where `WStype_t type` is defined as:
``` ```c++
typedef enum { typedef enum {
WStype_ERROR, WStype_ERROR,
WStype_DISCONNECTED, WStype_DISCONNECTED,