Samuel Mokrani
WebSocket client library
Websocket.h@13:3b058372cad9, 2011-08-30 (annotated)
- Committer:
- samux
- Date:
- Tue Aug 30 09:25:28 2011 +0000
- Revision:
- 13:3b058372cad9
- Parent:
- 12:1f6b9451a608
- Child:
- 16:d4518b50f653
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| samux | 0:21fe3b05249f | 1 | /** |
| samux | 0:21fe3b05249f | 2 | * @author Samuel Mokrani |
| samux | 0:21fe3b05249f | 3 | * |
| samux | 0:21fe3b05249f | 4 | * @section LICENSE |
| samux | 0:21fe3b05249f | 5 | * |
| samux | 0:21fe3b05249f | 6 | * Copyright (c) 2011 mbed |
| samux | 0:21fe3b05249f | 7 | * |
| samux | 0:21fe3b05249f | 8 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| samux | 0:21fe3b05249f | 9 | * of this software and associated documentation files (the "Software"), to deal |
| samux | 0:21fe3b05249f | 10 | * in the Software without restriction, including without limitation the rights |
| samux | 0:21fe3b05249f | 11 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| samux | 0:21fe3b05249f | 12 | * copies of the Software, and to permit persons to whom the Software is |
| samux | 0:21fe3b05249f | 13 | * furnished to do so, subject to the following conditions: |
| samux | 0:21fe3b05249f | 14 | * |
| samux | 0:21fe3b05249f | 15 | * The above copyright notice and this permission notice shall be included in |
| samux | 0:21fe3b05249f | 16 | * all copies or substantial portions of the Software. |
| samux | 0:21fe3b05249f | 17 | * |
| samux | 0:21fe3b05249f | 18 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| samux | 0:21fe3b05249f | 19 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| samux | 0:21fe3b05249f | 20 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| samux | 0:21fe3b05249f | 21 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| samux | 0:21fe3b05249f | 22 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| samux | 0:21fe3b05249f | 23 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| samux | 0:21fe3b05249f | 24 | * THE SOFTWARE. |
| samux | 0:21fe3b05249f | 25 | * |
| samux | 0:21fe3b05249f | 26 | * @section DESCRIPTION |
| samux | 0:21fe3b05249f | 27 | * Simple websocket client |
| samux | 0:21fe3b05249f | 28 | * |
| samux | 0:21fe3b05249f | 29 | */ |
| samux | 0:21fe3b05249f | 30 | |
| samux | 0:21fe3b05249f | 31 | #ifndef WEBSOCKET_H |
| samux | 0:21fe3b05249f | 32 | #define WEBSOCKET_H |
| samux | 0:21fe3b05249f | 33 | |
| samux | 0:21fe3b05249f | 34 | #include "mbed.h" |
| samux | 0:21fe3b05249f | 35 | #include "Wifly.h" |
| samux | 6:01a1eb7c0145 | 36 | #include "EthernetNetIf.h" |
| samux | 6:01a1eb7c0145 | 37 | #include "TCPSocket.h" |
| samux | 6:01a1eb7c0145 | 38 | #include "dnsresolve.h" |
| samux | 6:01a1eb7c0145 | 39 | |
| samux | 0:21fe3b05249f | 40 | /** Websocket client Class. |
| samux | 0:21fe3b05249f | 41 | * |
| samux | 13:3b058372cad9 | 42 | * Warning: you must use a wifi module (Wifly RN131-C) or an ethernet network to use this class |
| samux | 0:21fe3b05249f | 43 | * |
| samux | 13:3b058372cad9 | 44 | * Example (wifi network): |
| samux | 0:21fe3b05249f | 45 | * @code |
| samux | 0:21fe3b05249f | 46 | * #include "mbed.h" |
| samux | 0:21fe3b05249f | 47 | * #include "Wifly.h" |
| samux | 0:21fe3b05249f | 48 | * #include "Websocket.h" |
| samux | 0:21fe3b05249f | 49 | * |
| samux | 0:21fe3b05249f | 50 | * Serial pc(USBTX, USBRX); |
| samux | 0:21fe3b05249f | 51 | * Wifly * wifly; |
| samux | 0:21fe3b05249f | 52 | * Websocket * ws; |
| samux | 0:21fe3b05249f | 53 | * |
| samux | 0:21fe3b05249f | 54 | * int main() |
| samux | 0:21fe3b05249f | 55 | * { |
| samux | 0:21fe3b05249f | 56 | * wifly = new Wifly(p9, p10, p20, "network", "password", true); |
| samux | 13:3b058372cad9 | 57 | * ws = new Websocket("ws://ip_domain/path", wifly); |
| samux | 0:21fe3b05249f | 58 | * |
| samux | 0:21fe3b05249f | 59 | * if(wifly->Join()) |
| samux | 0:21fe3b05249f | 60 | * { |
| samux | 0:21fe3b05249f | 61 | * if(ws->connect()) |
| samux | 0:21fe3b05249f | 62 | * { |
| samux | 0:21fe3b05249f | 63 | * pc.printf("ws connected\r\n"); |
| samux | 0:21fe3b05249f | 64 | * while(1) |
| samux | 0:21fe3b05249f | 65 | * { |
| samux | 0:21fe3b05249f | 66 | * wait(0.1); |
| samux | 0:21fe3b05249f | 67 | * ws->Send("test"); |
| samux | 0:21fe3b05249f | 68 | * } |
| samux | 0:21fe3b05249f | 69 | * } |
| samux | 0:21fe3b05249f | 70 | * else |
| samux | 0:21fe3b05249f | 71 | * pc.printf("ws not connected\r\n"); |
| samux | 0:21fe3b05249f | 72 | * } |
| samux | 0:21fe3b05249f | 73 | * else |
| samux | 0:21fe3b05249f | 74 | * pc.printf("join network failed\r\n"); |
| samux | 0:21fe3b05249f | 75 | * |
| samux | 0:21fe3b05249f | 76 | * } |
| samux | 0:21fe3b05249f | 77 | * @endcode |
| samux | 13:3b058372cad9 | 78 | * |
| samux | 13:3b058372cad9 | 79 | * |
| samux | 13:3b058372cad9 | 80 | * |
| samux | 13:3b058372cad9 | 81 | * Example (ethernet network): |
| samux | 13:3b058372cad9 | 82 | * @code |
| samux | 13:3b058372cad9 | 83 | * #include "mbed.h" |
| samux | 13:3b058372cad9 | 84 | * #include "Websocket.h" |
| samux | 13:3b058372cad9 | 85 | * |
| samux | 13:3b058372cad9 | 86 | * Serial pc(USBTX, USBRX); |
| samux | 13:3b058372cad9 | 87 | * Websocket * ws; |
| samux | 13:3b058372cad9 | 88 | * |
| samux | 13:3b058372cad9 | 89 | * int main() |
| samux | 13:3b058372cad9 | 90 | * { |
| samux | 13:3b058372cad9 | 91 | * ws = new Websocket("ws://ip_domain/path"); |
| samux | 13:3b058372cad9 | 92 | * |
| samux | 13:3b058372cad9 | 93 | * if(ws->connect()) |
| samux | 13:3b058372cad9 | 94 | * { |
| samux | 13:3b058372cad9 | 95 | * pc.printf("ws connected\r\n"); |
| samux | 13:3b058372cad9 | 96 | * while(1) |
| samux | 13:3b058372cad9 | 97 | * { |
| samux | 13:3b058372cad9 | 98 | * wait(0.1); |
| samux | 13:3b058372cad9 | 99 | * ws->Send("test"); |
| samux | 13:3b058372cad9 | 100 | * } |
| samux | 13:3b058372cad9 | 101 | * } |
| samux | 13:3b058372cad9 | 102 | * else |
| samux | 13:3b058372cad9 | 103 | * pc.printf("ws not connected\r\n"); |
| samux | 13:3b058372cad9 | 104 | * } |
| samux | 13:3b058372cad9 | 105 | * @endcode |
| samux | 0:21fe3b05249f | 106 | */ |
| samux | 0:21fe3b05249f | 107 | class Websocket |
| samux | 0:21fe3b05249f | 108 | { |
| samux | 0:21fe3b05249f | 109 | public: |
| samux | 0:21fe3b05249f | 110 | /** |
| samux | 6:01a1eb7c0145 | 111 | * Constructor for a wifi module |
| samux | 0:21fe3b05249f | 112 | * |
| samux | 6:01a1eb7c0145 | 113 | * @param url The Websocket url in the form "ws://ip_domain[:port]/path" (by default: port = 80) |
| samux | 0:21fe3b05249f | 114 | * @param wifi pointer to a wifi module (the communication will be establish by this module) |
| samux | 0:21fe3b05249f | 115 | */ |
| samux | 6:01a1eb7c0145 | 116 | Websocket(char * url, Wifly * wifi); |
| samux | 6:01a1eb7c0145 | 117 | |
| samux | 6:01a1eb7c0145 | 118 | /** |
| samux | 6:01a1eb7c0145 | 119 | * Constructor for an ethernet communication |
| samux | 6:01a1eb7c0145 | 120 | * |
| samux | 6:01a1eb7c0145 | 121 | * @param url The Websocket url in the form "ws://ip_domain[:port]/path" (by default: port = 80) |
| samux | 6:01a1eb7c0145 | 122 | */ |
| samux | 6:01a1eb7c0145 | 123 | Websocket(char * url); |
| samux | 0:21fe3b05249f | 124 | |
| samux | 0:21fe3b05249f | 125 | /** |
| samux | 9:9fa055ed54b4 | 126 | * Connect to the websocket url |
| samux | 0:21fe3b05249f | 127 | * |
| samux | 1:0bb1153de91e | 128 | *@return true if the connection is established, false otherwise |
| samux | 0:21fe3b05249f | 129 | */ |
| samux | 0:21fe3b05249f | 130 | bool connect(); |
| samux | 0:21fe3b05249f | 131 | |
| samux | 0:21fe3b05249f | 132 | /** |
| samux | 5:0f3422b6ca44 | 133 | * Send a string according to the websocket format: \x00 str \xff |
| samux | 0:21fe3b05249f | 134 | * |
| samux | 5:0f3422b6ca44 | 135 | * @param str string to be sent |
| samux | 0:21fe3b05249f | 136 | */ |
| samux | 0:21fe3b05249f | 137 | void Send(char * str); |
| samux | 0:21fe3b05249f | 138 | |
| samux | 0:21fe3b05249f | 139 | /** |
| samux | 0:21fe3b05249f | 140 | * Read a websocket message |
| samux | 0:21fe3b05249f | 141 | * |
| samux | 0:21fe3b05249f | 142 | * @param message pointer to the string to be read (null if drop frame) |
| samux | 0:21fe3b05249f | 143 | * |
| samux | 0:21fe3b05249f | 144 | * @return true if a string has been read, false otherwise |
| samux | 0:21fe3b05249f | 145 | */ |
| samux | 0:21fe3b05249f | 146 | bool read(char * message); |
| samux | 0:21fe3b05249f | 147 | |
| samux | 0:21fe3b05249f | 148 | /** |
| samux | 12:1f6b9451a608 | 149 | * To see if there is a websocket connection active |
| samux | 0:21fe3b05249f | 150 | * |
| samux | 12:1f6b9451a608 | 151 | * @return true if there is a connection active |
| samux | 0:21fe3b05249f | 152 | */ |
| samux | 0:21fe3b05249f | 153 | bool connected(); |
| samux | 0:21fe3b05249f | 154 | |
| samux | 0:21fe3b05249f | 155 | /** |
| samux | 0:21fe3b05249f | 156 | * Close the websocket connection |
| samux | 0:21fe3b05249f | 157 | * |
| samux | 1:0bb1153de91e | 158 | * @return true if the connection has been closed, false otherwise |
| samux | 0:21fe3b05249f | 159 | */ |
| samux | 0:21fe3b05249f | 160 | bool close(); |
| samux | 6:01a1eb7c0145 | 161 | |
| samux | 6:01a1eb7c0145 | 162 | |
| samux | 0:21fe3b05249f | 163 | |
| samux | 0:21fe3b05249f | 164 | private: |
| samux | 6:01a1eb7c0145 | 165 | |
| samux | 6:01a1eb7c0145 | 166 | void fillFields(bool wifi, char * url); |
| samux | 6:01a1eb7c0145 | 167 | void onTCPSocketEvent(TCPSocketEvent e); |
| samux | 6:01a1eb7c0145 | 168 | |
| samux | 0:21fe3b05249f | 169 | char * ip_domain; |
| samux | 0:21fe3b05249f | 170 | char * path; |
| samux | 6:01a1eb7c0145 | 171 | char * port; |
| samux | 6:01a1eb7c0145 | 172 | |
| samux | 0:21fe3b05249f | 173 | Wifly * wifi; |
| samux | 6:01a1eb7c0145 | 174 | |
| samux | 6:01a1eb7c0145 | 175 | bool eth_connected; |
| samux | 12:1f6b9451a608 | 176 | bool eth_readable; |
| samux | 12:1f6b9451a608 | 177 | bool eth_writeable; |
| samux | 9:9fa055ed54b4 | 178 | char eth_rx[512]; |
| samux | 9:9fa055ed54b4 | 179 | bool response_server_eth; |
| samux | 6:01a1eb7c0145 | 180 | |
| samux | 6:01a1eb7c0145 | 181 | bool wifi_use; |
| samux | 6:01a1eb7c0145 | 182 | bool eth_use; |
| samux | 6:01a1eb7c0145 | 183 | |
| samux | 6:01a1eb7c0145 | 184 | EthernetNetIf eth; |
| samux | 6:01a1eb7c0145 | 185 | TCPSocket sock; |
| samux | 6:01a1eb7c0145 | 186 | IpAddr server_ip; |
| samux | 0:21fe3b05249f | 187 | |
| samux | 0:21fe3b05249f | 188 | }; |
| samux | 0:21fe3b05249f | 189 | |
| samux | 0:21fe3b05249f | 190 | #endif |