Armin Felder / WebSocketClient

fork of WebSocketClient with some fixes

Fork of WebSocketClient by mbed_example

Websocket.h@6:86e89a0369b9, 2012-08-29 (annotated)

Committer:
donatien
Date:
Wed Aug 29 15:27:51 2012 +0000
Revision:
6:86e89a0369b9
Parent:
4:466f90b7849a
Child:
8:ccedee13be8d
removed useof std::string

Who changed what in which revision?

UserRevisionLine numberNew contents of line
samux 4:466f90b7849a 1 /**
samux 4:466f90b7849a 2 * @author Samuel Mokrani
samux 4:466f90b7849a 3 *
samux 4:466f90b7849a 4 * @section LICENSE
samux 4:466f90b7849a 5 *
samux 4:466f90b7849a 6 * Copyright (c) 2011 mbed
samux 4:466f90b7849a 7 *
samux 4:466f90b7849a 8 * Permission is hereby granted, free of charge, to any person obtaining a copy
samux 4:466f90b7849a 9 * of this software and associated documentation files (the "Software"), to deal
samux 4:466f90b7849a 10 * in the Software without restriction, including without limitation the rights
samux 4:466f90b7849a 11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
samux 4:466f90b7849a 12 * copies of the Software, and to permit persons to whom the Software is
samux 4:466f90b7849a 13 * furnished to do so, subject to the following conditions:
samux 4:466f90b7849a 14 *
samux 4:466f90b7849a 15 * The above copyright notice and this permission notice shall be included in
samux 4:466f90b7849a 16 * all copies or substantial portions of the Software.
samux 4:466f90b7849a 17 *
samux 4:466f90b7849a 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
samux 4:466f90b7849a 19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
samux 4:466f90b7849a 20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
samux 4:466f90b7849a 21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
samux 4:466f90b7849a 22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
samux 4:466f90b7849a 23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
samux 4:466f90b7849a 24 * THE SOFTWARE.
samux 4:466f90b7849a 25 *
samux 4:466f90b7849a 26 * @section DESCRIPTION
samux 4:466f90b7849a 27 * Simple websocket client
samux 4:466f90b7849a 28 *
samux 4:466f90b7849a 29 */
samux 4:466f90b7849a 30
samux 4:466f90b7849a 31 #ifndef WEBSOCKET_H
samux 4:466f90b7849a 32 #define WEBSOCKET_H
samux 4:466f90b7849a 33
samux 4:466f90b7849a 34 #include "mbed.h"
samux 4:466f90b7849a 35
samux 4:466f90b7849a 36 #include "TCPSocketConnection.h"
samux 4:466f90b7849a 37
samux 4:466f90b7849a 38 /** Websocket client Class.
samux 4:466f90b7849a 39 *
samux 4:466f90b7849a 40 * Example (ethernet network):
samux 4:466f90b7849a 41 * @code
samux 4:466f90b7849a 42 * #include "mbed.h"
samux 4:466f90b7849a 43 * #include "EthernetInterface.h"
samux 4:466f90b7849a 44 * #include "Websocket.h"
samux 4:466f90b7849a 45 *
samux 4:466f90b7849a 46 * int main() {
samux 4:466f90b7849a 47 * EthernetInterface eth;
samux 4:466f90b7849a 48 * eth.init(); //Use DHCP
samux 4:466f90b7849a 49 * eth.connect();
samux 4:466f90b7849a 50 * printf("IP Address is %s\n\r", eth.getIPAddress());
samux 4:466f90b7849a 51 *
samux 4:466f90b7849a 52 * Websocket ws("ws://sockets.mbed.org:443/ws/demo/rw");
samux 4:466f90b7849a 53 * ws.connect();
samux 4:466f90b7849a 54 *
samux 4:466f90b7849a 55 * while (1) {
samux 4:466f90b7849a 56 * int res = ws.send("WebSocket Hello World!");
samux 4:466f90b7849a 57 *
samux 4:466f90b7849a 58 * if (ws.read(recv)) {
samux 4:466f90b7849a 59 * printf("rcv: %s\r\n", recv);
samux 4:466f90b7849a 60 * }
samux 4:466f90b7849a 61 *
samux 4:466f90b7849a 62 * wait(0.1);
samux 4:466f90b7849a 63 * }
samux 4:466f90b7849a 64 * }
samux 4:466f90b7849a 65 * @endcode
samux 4:466f90b7849a 66 */
samux 4:466f90b7849a 67
samux 4:466f90b7849a 68 class Websocket
samux 4:466f90b7849a 69 {
samux 4:466f90b7849a 70 public:
samux 4:466f90b7849a 71 /**
samux 4:466f90b7849a 72 * Constructor
samux 4:466f90b7849a 73 *
samux 4:466f90b7849a 74 * @param url The Websocket url in the form "ws://ip_domain[:port]/path" (by default: port = 80)
samux 4:466f90b7849a 75 */
samux 4:466f90b7849a 76 Websocket(char * url);
samux 4:466f90b7849a 77
samux 4:466f90b7849a 78 /**
samux 4:466f90b7849a 79 * Connect to the websocket url
samux 4:466f90b7849a 80 *
samux 4:466f90b7849a 81 *@return true if the connection is established, false otherwise
samux 4:466f90b7849a 82 */
samux 4:466f90b7849a 83 bool connect();
samux 4:466f90b7849a 84
samux 4:466f90b7849a 85 /**
samux 4:466f90b7849a 86 * Send a string according to the websocket format (see rfc 6455)
samux 4:466f90b7849a 87 *
samux 4:466f90b7849a 88 * @param str string to be sent
samux 4:466f90b7849a 89 *
samux 4:466f90b7849a 90 * @returns the number of bytes sent
samux 4:466f90b7849a 91 */
samux 4:466f90b7849a 92 int send(char * str);
samux 4:466f90b7849a 93
samux 4:466f90b7849a 94 /**
samux 4:466f90b7849a 95 * Read a websocket message
samux 4:466f90b7849a 96 *
samux 4:466f90b7849a 97 * @param message pointer to the string to be read (null if drop frame)
samux 4:466f90b7849a 98 *
samux 4:466f90b7849a 99 * @return true if a websocket frame has been read
samux 4:466f90b7849a 100 */
samux 4:466f90b7849a 101 bool read(char * message);
samux 4:466f90b7849a 102
samux 4:466f90b7849a 103 /**
samux 4:466f90b7849a 104 * To see if there is a websocket connection active
samux 4:466f90b7849a 105 *
samux 4:466f90b7849a 106 * @return true if there is a connection active
samux 4:466f90b7849a 107 */
samux 4:466f90b7849a 108 bool is_connected();
samux 4:466f90b7849a 109
samux 4:466f90b7849a 110 /**
samux 4:466f90b7849a 111 * Close the websocket connection
samux 4:466f90b7849a 112 *
samux 4:466f90b7849a 113 * @return true if the connection has been closed, false otherwise
samux 4:466f90b7849a 114 */
samux 4:466f90b7849a 115 bool close();
samux 4:466f90b7849a 116
samux 4:466f90b7849a 117 /*
samux 4:466f90b7849a 118 * Accessor: get path from the websocket url
samux 4:466f90b7849a 119 *
samux 4:466f90b7849a 120 * @return path
samux 4:466f90b7849a 121 */
donatien 6:86e89a0369b9 122 char* getPath();
samux 4:466f90b7849a 123
samux 4:466f90b7849a 124 private:
samux 4:466f90b7849a 125
samux 4:466f90b7849a 126 void fillFields(char * url);
donatien 6:86e89a0369b9 127 int parseURL(const char* url, char* scheme, size_t maxSchemeLen, char* host, size_t maxHostLen, uint16_t* port, char* path, size_t maxPathLen); //Parse URL
samux 4:466f90b7849a 128 int sendOpcode(uint8_t opcode, char * msg);
samux 4:466f90b7849a 129 int sendLength(uint32_t len, char * msg);
samux 4:466f90b7849a 130 int sendMask(char * msg);
samux 4:466f90b7849a 131 int readChar(char * pC, bool block = true);
donatien 6:86e89a0369b9 132
donatien 6:86e89a0369b9 133 char scheme[8];
donatien 6:86e89a0369b9 134 uint16_t port;
donatien 6:86e89a0369b9 135 char host[32];
donatien 6:86e89a0369b9 136 char path[64];
samux 4:466f90b7849a 137
samux 4:466f90b7849a 138 TCPSocketConnection socket;
samux 4:466f90b7849a 139
samux 4:466f90b7849a 140 int read(char * buf, int len, int min_len = -1);
samux 4:466f90b7849a 141 int write(char * buf, int len);
samux 4:466f90b7849a 142 };
samux 4:466f90b7849a 143
samux 4:466f90b7849a 144 #endif