Merge branch 'master' of github.com:Links2004/arduinoWebSockets

Author: Links2004

README.md

@@ -53,6 +53,38 @@ The mode can be activated in the ```WebSockets.h``` (see WEBSOCKETS_NETWORK_TYPE
 [ESPAsyncTCP](https://github.com/me-no-dev/ESPAsyncTCP) libary is required.
 
 
+### High Level Client API ###
+
+ - `begin` : Initiate connection sequence to the websocket host.
+```
+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");
+ ```
+ - `onEvent`: Callback to handle for websocket events
+
+ ```
+ void onEvent(WebSocketClientEvent cbEvent);
+ ```
+
+ - `WebSocketClientEvent`: Handler for websocket events
+ ```
+ void (*WebSocketClientEvent)(WStype_t type, uint8_t * payload, size_t length)
+ ```
+Where `WStype_t type` is defined as:
+ ```
+ typedef enum {
+ WStype_ERROR,
+ WStype_DISCONNECTED,
+ WStype_CONNECTED,
+ WStype_TEXT,
+ WStype_BIN,
+	WStype_FRAGMENT_TEXT_START,
+	WStype_FRAGMENT_BIN_START,
+	WStype_FRAGMENT,
+	WStype_FRAGMENT_FIN,
+ } WStype_t;
+ ```
+
 ### Issues ###
 Submit issues to: https://github.com/Links2004/arduinoWebSockets/issues
 

examples/WebSocketClient/WebSocketClient.ino

@@ -20,7 +20,7 @@ WebSocketsClient webSocket;
 
 #define USE_SERIAL Serial1
 
-void webSocketEvent(WStype_t type, uint8_t * payload, size_t lenght) {
+void webSocketEvent(WStype_t type, uint8_t * payload, size_t length) {
 
 
  switch(type) {
@@ -42,11 +42,11 @@ void webSocketEvent(WStype_t type, uint8_t * payload, size_t lenght) {
 // webSocket.sendTXT("message here");
  break;
  case WStype_BIN:
- USE_SERIAL.printf("[WSc] get binary lenght: %u\n", lenght);
- hexdump(payload, lenght);
+ USE_SERIAL.printf("[WSc] get binary length: %u\n", length);
+ hexdump(payload, length);
 
  // send data to server
- // webSocket.sendBIN(payload, lenght);
+ // webSocket.sendBIN(payload, length);
  break;
  }
 

examples/WebSocketClientSocketIO/WebSocketClientSocketIO.ino

@@ -27,7 +27,7 @@ uint64_t messageTimestamp = 0;
 uint64_t heartbeatTimestamp = 0;
 bool isConnected = false;
 
-void webSocketEvent(WStype_t type, uint8_t * payload, size_t lenght) {
+void webSocketEvent(WStype_t type, uint8_t * payload, size_t length) {
 
 
  switch(type) {
@@ -52,11 +52,11 @@ void webSocketEvent(WStype_t type, uint8_t * payload, size_t lenght) {
 // webSocket.sendTXT("message here");
  break;
  case WStype_BIN:
- USE_SERIAL.printf("[WSc] get binary lenght: %u\n", lenght);
- hexdump(payload, lenght);
+ USE_SERIAL.printf("[WSc] get binary length: %u\n", length);
+ hexdump(payload, length);
 
  // send data to server
- // webSocket.sendBIN(payload, lenght);
+ // webSocket.sendBIN(payload, length);
  break;
  }
 

examples/WebSocketServer/WebSocketServer.ino

@@ -18,7 +18,7 @@ WebSocketsServer webSocket = WebSocketsServer(81);
 
 #define USE_SERIAL Serial1
 
-void webSocketEvent(uint8_t num, WStype_t type, uint8_t * payload, size_t lenght) {
+void webSocketEvent(uint8_t num, WStype_t type, uint8_t * payload, size_t length) {
 
  switch(type) {
  case WStype_DISCONNECTED:
@@ -43,11 +43,11 @@ void webSocketEvent(uint8_t num, WStype_t type, uint8_t * payload, size_t lenght
  // webSocket.broadcastTXT("message here");
  break;
  case WStype_BIN:
- USE_SERIAL.printf("[%u] get binary lenght: %u\n", num, lenght);
- hexdump(payload, lenght);
+ USE_SERIAL.printf("[%u] get binary length: %u\n", num, length);
+ hexdump(payload, length);
 
  // send message to client
- // webSocket.sendBIN(num, payload, lenght);
+ // webSocket.sendBIN(num, payload, length);
  break;
  }
 

examples/WebSocketServer/WebSocketServerFragmentation.ino

@@ -20,7 +20,7 @@ WebSocketsServer webSocket = WebSocketsServer(81);
 
 String fragmentBuffer = "";
 
-void webSocketEvent(uint8_t num, WStype_t type, uint8_t * payload, size_t lenght) {
+void webSocketEvent(uint8_t num, WStype_t type, uint8_t * payload, size_t length) {
 
 switch(type) {
 case WStype_DISCONNECTED:
@@ -38,8 +38,8 @@ void webSocketEvent(uint8_t num, WStype_t type, uint8_t * payload, size_t lenght
 USE_SERIAL.printf("[%u] get Text: %s\n", num, payload);
 break;
 case WStype_BIN:
-USE_SERIAL.printf("[%u] get binary lenght: %u\n", num, lenght);
-hexdump(payload, lenght);
+USE_SERIAL.printf("[%u] get binary length: %u\n", num, length);
+hexdump(payload, length);
 break;
 
 // Fragmentation / continuation opcode handling

examples/WebSocketServer_LEDcontrol/WebSocketServer_LEDcontrol.ino

@@ -26,7 +26,7 @@ ESP8266WiFiMulti WiFiMulti;
 ESP8266WebServer server = ESP8266WebServer(80);
 WebSocketsServer webSocket = WebSocketsServer(81);
 
-void webSocketEvent(uint8_t num, WStype_t type, uint8_t * payload, size_t lenght) {
+void webSocketEvent(uint8_t num, WStype_t type, uint8_t * payload, size_t length) {
 
  switch(type) {
  case WStype_DISCONNECTED:

src/WebSocketsClient.cpp

@@ -270,9 +270,9 @@ void WebSocketsClient::setAuthorization(const char * auth) {
  * @param client WSclient_t * ptr to the client struct
  * @param opcode WSopcode_t
  * @param payload uint8_t *
- * @param lenght size_t
+ * @param length size_t
  */
-void WebSocketsClient::messageReceived(WSclient_t * client, WSopcode_t opcode, uint8_t * payload, size_t lenght, bool fin) {
+void WebSocketsClient::messageReceived(WSclient_t * client, WSopcode_t opcode, uint8_t * payload, size_t length, bool fin) {
  WStype_t type = WStype_ERROR;
 
  switch(opcode) {
@@ -287,7 +287,7 @@ void WebSocketsClient::messageReceived(WSclient_t * client, WSopcode_t opcode, u
 break;
  }
 
- runCbEvent(type, payload, lenght);
+ runCbEvent(type, payload, length);
 
 }
 

src/WebSocketsServer.cpp

@@ -468,9 +468,9 @@ bool WebSocketsServer::newClient(WEBSOCKETS_NETWORK_CLASS * TCPclient) {
  * @param client WSclient_t * ptr to the client struct
  * @param opcode WSopcode_t
  * @param payload uint8_t *
- * @param lenght size_t
+ * @param length size_t
  */
-void WebSocketsServer::messageReceived(WSclient_t * client, WSopcode_t opcode, uint8_t * payload, size_t lenght, bool fin) {
+void WebSocketsServer::messageReceived(WSclient_t * client, WSopcode_t opcode, uint8_t * payload, size_t length, bool fin) {
  WStype_t type = WStype_ERROR;
 
  switch(opcode) {
@@ -485,7 +485,7 @@ void WebSocketsServer::messageReceived(WSclient_t * client, WSopcode_t opcode, u
  break;
  }
 
- runCbEvent(client->num, type, payload, lenght);
+ runCbEvent(client->num, type, payload, length);
 
 }