Revision 0:10b6eaafc2da, committed 2012-08-10

Comitter:

samux

Date:

Fri Aug 10 11:08:44 2012 +0000

Child:

1:de85cd4ec77b

Commit message:

websocket client with new official mbed tcp/ip stack

Changed in this revision

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Websocket.cpp	Fri Aug 10 11:08:44 2012 +0000
@@ -0,0 +1,302 @@
+#include "Websocket.h"
+#include <string>
+
+#define MAX_TRY_WRITE 5
+#define MAX_TRY_READ 3
+
+//#define DEBUG
+
+Websocket::Websocket(char * url) {
+    fillFields(url);
+    socket.set_blocking(false, 2000);
+}
+
+void Websocket::fillFields(char * url) {
+    char *res = NULL;
+    char *res1 = NULL;
+
+    char buf[50];
+    strcpy(buf, url);
+
+    res = strtok(buf, ":");
+    if (strcmp(res, "ws")) {
+#ifdef DEBUG
+        printf("\r\nFormat printfor: please use: \"ws://ip-or-domain[:port]/path\"\r\n\r\n");
+#endif
+    } else {
+        //ip_domain and port
+        res = strtok(NULL, "/");
+
+        //path
+        res1 = strtok(NULL, " ");
+        if (res1 != NULL) {
+            path = res1;
+        }
+
+        //ip_domain
+        res = strtok(res, ":");
+
+        //port
+        res1 = strtok(NULL, " ");
+        if (res1 != NULL) {
+            port = res1;
+        } else {
+            port = "80";
+        }
+
+        if (res != NULL) {
+            ip_domain = res;
+        }
+    }
+}
+
+
+bool Websocket::connect() {
+    char cmd[192];
+    
+    while (socket.connect(ip_domain.c_str(), atoi(port.c_str())) < 0) {
+        printf("Unable to connect to (%s) on port (%d)\r\n", ip_domain.c_str(), atoi(port.c_str()));
+        wait(0.2);
+    }
+
+    // sent http header to upgrade to the ws protocol
+    sprintf(cmd, "GET /%s HTTP/1.1\r\n", path.c_str());
+    write(cmd, strlen(cmd));
+
+    sprintf(cmd, "Host: %s:%s\r\n", ip_domain.c_str(), port.c_str());
+    write(cmd, strlen(cmd));
+
+    sprintf(cmd, "Upgrade: WebSocket\r\n");
+    write(cmd, strlen(cmd));
+
+    sprintf(cmd, "Connection: Upgrade\r\n");
+    write(cmd, strlen(cmd));
+
+    sprintf(cmd, "Sec-WebSocket-Key: L159VM0TWUzyDxwJEIEzjw==\r\n");
+    write(cmd, strlen(cmd));
+
+    sprintf(cmd, "Sec-WebSocket-Version: 13\r\n\r\n");
+    int ret = write(cmd, strlen(cmd));
+    if(ret != strlen(cmd))
+    {
+      close();
+      printf("Could not send request");
+      return false;
+    }
+    
+    while(socket.receive(cmd, 1) != 1);
+
+    ret = read(cmd, 512);
+    if(ret < 0)
+    {
+      close();
+      printf("Could not receive answer\r\n");
+      return false;
+    }
+    
+    cmd[ret] = '\0';
+#ifdef DEBUG
+    printf("recv: %s\r\n", cmd);
+#endif
+
+    if( strstr(cmd, "DdLWT/1JcX+nQFHebYP+rqEx5xI=") == NULL )
+    {
+      printf("Wrong answer from server, got \"%s\" instead\r\n", cmd);
+      do{
+        ret = read(cmd, 512);
+        if(ret < 0)
+        {
+          printf("Could not receive answer\r\n");
+          return false;
+        }
+        cmd[ret] = '\0';
+        printf("%s",cmd);
+      } while(ret > 0);
+      close();
+      return false;
+    }
+    
+    printf("\r\nip_domain: %s\r\npath: /%s\r\nport: %s\r\n\r\n", ip_domain.c_str(), path.c_str(), port.c_str());
+    return true;
+}
+
+int Websocket::sendLength(uint32_t len) {
+
+    if (len < 126) {
+        sendChar(len | (1<<7));
+        return 1;
+    } else if (len < 65535) {
+        sendChar(126 | (1<<7));
+        sendChar((len >> 8) & 0xff);
+        sendChar(len & 0xff);
+        return 3;
+    } else {
+        sendChar(127 | (1<<7));
+        for (int i = 0; i < 8; i++) {
+            sendChar((len >> i*8) & 0xff);
+        }
+        return 9;
+    }
+}
+
+int Websocket::sendChar(char c) {
+    return write(&c, 1);
+}
+
+int Websocket::readChar(char * pC, bool block)
+{
+    return read(pC, 1, block);
+}
+
+int Websocket::sendOpcode(uint8_t opcode) {
+    return sendChar(0x80 | (opcode & 0x0f));
+}
+
+int Websocket::sendMask() {
+    for (int i = 0; i < 4; i++) {
+        sendChar(0);
+    }
+    return 4;
+}
+
+int Websocket::send(char * str) {
+    sendOpcode(0x01);
+    sendLength(strlen(str));
+    sendMask();
+    int res = write(str, strlen(str));
+    return res;
+}
+
+
+bool Websocket::read(char * message) {
+    int i = 0;
+    uint32_t len_msg;
+    char opcode = 0;
+    char c;
+    char mask[4] = {0, 0, 0, 0};
+    bool is_masked = false;
+    Timer tmr;
+    
+    // read the opcode
+    tmr.start();
+    while (true) {
+        if (tmr.read() > 3) {
+            printf("timeout ws\r\n");
+            return false;
+        }
+        
+        if (socket.receive(&opcode, 1) != 1) {
+            return false;
+        }
+
+        if (opcode == 0x81)
+            break;
+    }
+#ifdef DEBUG
+    printf("opcode: 0x%X\r\n", opcode);
+#endif
+
+    readChar(&c);
+    len_msg = c & 0x7f;
+    is_masked = c & 0x80;
+    if (len_msg == 126) {
+        readChar(&c);
+        len_msg = c << 8;
+        readChar(&c);
+        len_msg += c;
+    } else if (len_msg == 127) {
+        len_msg = 0;
+        for (int i = 0; i < 8; i++) {
+            readChar(&c);
+            len_msg += (c << (7-i)*8);
+        }
+    }
+    
+    if(len_msg == 0) {
+        return false;
+    }
+#ifdef DEBUG
+    printf("length: %d\r\n", len_msg);
+#endif
+    if (is_masked) {
+        for (i = 0; i < 4; i++)
+            readChar(&c);
+            mask[i] = c;
+    }
+    
+    int nb = read(message, len_msg, false);
+    if (nb != len_msg)
+        return false;
+
+    for (i = 0; i < len_msg; i++) {
+        message[i] = message[i] ^ mask[i % 4];
+    }
+    
+    message[len_msg] = '\0';
+    
+    return true;
+}
+
+bool Websocket::close() {
+    if(!is_connected())
+      return false;
+      
+    int ret = socket.close();
+    if (ret < 0)
+    {
+      printf("Could not disconnect");
+      return false;
+    }
+    return true;
+}
+
+bool Websocket::is_connected() {
+    return socket.is_connected();
+}
+
+std::string Websocket::getPath() {
+    return path;
+}
+
+int Websocket::write(char * str, int len, uint32_t timeout) {
+    int res = 0, idx = 0;
+    for (int j = 0; j < MAX_TRY_WRITE; j++) {
+        if (idx == len)
+            return len;
+        for(int i = 0; i < MAX_TRY_WRITE; i++) {
+            if ((res = socket.send_all(str + idx, len - idx)) != -1)
+                break;
+            
+            if (i == MAX_TRY_WRITE - 1)
+                return -1;
+        }
+        idx += res;
+    }
+    return idx;
+}
+
+int Websocket::read(char * str, int len, bool block) {
+    int res = 0, idx = 0;
+    for (int j = 0; j < MAX_TRY_READ; j++) {
+    
+        if (idx == len)
+            return len;
+            
+        for(int i = 0; i < MAX_TRY_READ; i++) {
+        
+            if (block) {
+                if ((res = socket.receive_all(str + idx, len - idx)) != -1)
+                    break;
+            } else {
+                if ((res = socket.receive(str + idx, len - idx)) != -1)
+                    break;
+            }
+            
+            if (i == MAX_TRY_READ - 1 || !block)
+                return (idx == 0) ? -1 : idx;
+        }
+        
+        idx += res;
+    }
+    return idx;
+}

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Websocket.h	Fri Aug 10 11:08:44 2012 +0000
@@ -0,0 +1,144 @@
+/**
+* @author Samuel Mokrani
+*
+* @section LICENSE
+*
+* Copyright (c) 2011 mbed
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+* copies of the Software, and to permit persons to whom the Software is
+* furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included in
+* all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+* THE SOFTWARE.
+*
+* @section DESCRIPTION
+*    Simple websocket client
+*
+*/
+
+#ifndef WEBSOCKET_H
+#define WEBSOCKET_H
+
+#include "mbed.h"
+#include <string>
+
+#include "TCPSocketConnection.h"
+
+/** Websocket client Class.
+ *
+ * Example (ethernet network):
+ * @code
+ * #include "mbed.h"
+ * #include "EthernetInterface.h"
+ * #include "Websocket.h"
+ *
+ * int main() {
+ *    EthernetInterface eth;
+ *    eth.init(); //Use DHCP
+ *    eth.connect();
+ *    printf("IP Address is %s\n\r", eth.getIPAddress());
+ *   
+ *    Websocket ws("ws://sockets.mbed.org:443/ws/demo/rw");
+ *    ws.connect();
+ *   
+ *    while (1) {
+ *        int res = ws.send("WebSocket Hello World!");
+ *
+ *        if (ws.read(recv)) {
+ *            printf("rcv: %s\r\n", recv);
+ *        }
+ *
+ *        wait(0.1);
+ *    }
+ * }
+ * @endcode
+ */
+ 
+class Websocket
+{
+    public:
+        /**
+        * Constructor
+        *
+        * @param url The Websocket url in the form "ws://ip_domain[:port]/path" (by default: port = 80)
+        */
+        Websocket(char * url);
+
+        /**
+        * Connect to the websocket url
+        *
+        *@return true if the connection is established, false otherwise
+        */
+        bool connect();
+
+        /**
+        * Send a string according to the websocket format (see rfc 6455)
+        *
+        * @param str string to be sent
+        *
+        * @returns the number of bytes sent
+        */
+        int send(char * str);
+
+        /**
+        * Read a websocket message
+        *
+        * @param message pointer to the string to be read (null if drop frame)
+        *
+        * @return true if a websocket frame has been read
+        */
+        bool read(char * message);
+
+        /**
+        * To see if there is a websocket connection active
+        *
+        * @return true if there is a connection active
+        */
+        bool is_connected();
+
+        /**
+        * Close the websocket connection
+        *
+        * @return true if the connection has been closed, false otherwise
+        */
+        bool close();
+
+        /*
+        * Accessor: get path from the websocket url
+        *
+        * @return path
+        */
+        std::string getPath();
+
+    private:
+
+        void fillFields(char * url);
+        int sendOpcode(uint8_t opcode);
+        int sendLength(uint32_t len);
+        int sendMask();
+        int sendChar(char c);
+        int readChar(char * pC, bool block = true);
+
+        std::string ip_domain;
+        std::string path;
+        std::string port;
+        
+        TCPSocketConnection socket;
+
+        int read(char * buf, int len, bool block = true);
+        int write(char * buf, int len, uint32_t timeout=5000);
+};
+
+#endif