AMETEK Powervar / WebSocketClient

Web Socket Client

Fork of WebSocketClient by Samuel Mokrani

Websocket.h@8:860d3b8e21f9, 2017-06-15 (annotated)

Committer:
dgriffin65
Date:
Thu Jun 15 20:18:14 2017 +0000
Revision:
8:860d3b8e21f9
Parent:
6:86e89a0369b9 
Updated to mbed-os

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 /** Websocket client Class.
samux 4:466f90b7849a 37 *
samux 4:466f90b7849a 38 * Example (ethernet network):
samux 4:466f90b7849a 39 * @code
samux 4:466f90b7849a 40 * #include "mbed.h"
samux 4:466f90b7849a 41 * #include "EthernetInterface.h"
samux 4:466f90b7849a 42 * #include "Websocket.h"
samux 4:466f90b7849a 43 *
samux 4:466f90b7849a 44 * int main() {
samux 4:466f90b7849a 45 * EthernetInterface eth;
samux 4:466f90b7849a 46 * eth.init(); //Use DHCP
samux 4:466f90b7849a 47 * eth.connect();
samux 4:466f90b7849a 48 * printf("IP Address is %s\n\r", eth.getIPAddress());
samux 4:466f90b7849a 49 *
samux 4:466f90b7849a 50 * Websocket ws("ws://sockets.mbed.org:443/ws/demo/rw");
samux 4:466f90b7849a 51 * ws.connect();
samux 4:466f90b7849a 52 *
samux 4:466f90b7849a 53 * while (1) {
samux 4:466f90b7849a 54 * int res = ws.send("WebSocket Hello World!");
samux 4:466f90b7849a 55 *
samux 4:466f90b7849a 56 * if (ws.read(recv)) {
samux 4:466f90b7849a 57 * printf("rcv: %s\r\n", recv);
samux 4:466f90b7849a 58 * }
samux 4:466f90b7849a 59 *
samux 4:466f90b7849a 60 * wait(0.1);
samux 4:466f90b7849a 61 * }
samux 4:466f90b7849a 62 * }
samux 4:466f90b7849a 63 * @endcode
samux 4:466f90b7849a 64 */
samux 4:466f90b7849a 65
samux 4:466f90b7849a 66 class Websocket
samux 4:466f90b7849a 67 {
samux 4:466f90b7849a 68 public:
samux 4:466f90b7849a 69 /**
samux 4:466f90b7849a 70 * Constructor
samux 4:466f90b7849a 71 *
samux 4:466f90b7849a 72 * @param url The Websocket url in the form "ws://ip_domain[:port]/path" (by default: port = 80)
samux 4:466f90b7849a 73 */
dgriffin65 8:860d3b8e21f9 74 Websocket(NetworkStack *ns, char * url);
samux 4:466f90b7849a 75
samux 4:466f90b7849a 76 /**
samux 4:466f90b7849a 77 * Connect to the websocket url
samux 4:466f90b7849a 78 *
samux 4:466f90b7849a 79 *@return true if the connection is established, false otherwise
samux 4:466f90b7849a 80 */
samux 4:466f90b7849a 81 bool connect();
samux 4:466f90b7849a 82
samux 4:466f90b7849a 83 /**
samux 4:466f90b7849a 84 * Send a string according to the websocket format (see rfc 6455)
samux 4:466f90b7849a 85 *
samux 4:466f90b7849a 86 * @param str string to be sent
samux 4:466f90b7849a 87 *
samux 4:466f90b7849a 88 * @returns the number of bytes sent
samux 4:466f90b7849a 89 */
samux 4:466f90b7849a 90 int send(char * str);
samux 4:466f90b7849a 91
samux 4:466f90b7849a 92 /**
samux 4:466f90b7849a 93 * Read a websocket message
samux 4:466f90b7849a 94 *
samux 4:466f90b7849a 95 * @param message pointer to the string to be read (null if drop frame)
samux 4:466f90b7849a 96 *
samux 4:466f90b7849a 97 * @return true if a websocket frame has been read
samux 4:466f90b7849a 98 */
samux 4:466f90b7849a 99 bool read(char * message);
samux 4:466f90b7849a 100
samux 4:466f90b7849a 101 /**
samux 4:466f90b7849a 102 * To see if there is a websocket connection active
samux 4:466f90b7849a 103 *
samux 4:466f90b7849a 104 * @return true if there is a connection active
samux 4:466f90b7849a 105 */
samux 4:466f90b7849a 106 bool is_connected();
samux 4:466f90b7849a 107
samux 4:466f90b7849a 108 /**
samux 4:466f90b7849a 109 * Close the websocket connection
samux 4:466f90b7849a 110 *
samux 4:466f90b7849a 111 * @return true if the connection has been closed, false otherwise
samux 4:466f90b7849a 112 */
samux 4:466f90b7849a 113 bool close();
samux 4:466f90b7849a 114
samux 4:466f90b7849a 115 /*
samux 4:466f90b7849a 116 * Accessor: get path from the websocket url
samux 4:466f90b7849a 117 *
samux 4:466f90b7849a 118 * @return path
samux 4:466f90b7849a 119 */
donatien 6:86e89a0369b9 120 char* getPath();
samux 4:466f90b7849a 121
samux 4:466f90b7849a 122 private:
samux 4:466f90b7849a 123
samux 4:466f90b7849a 124 void fillFields(char * url);
donatien 6:86e89a0369b9 125 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 126 int sendOpcode(uint8_t opcode, char * msg);
samux 4:466f90b7849a 127 int sendLength(uint32_t len, char * msg);
samux 4:466f90b7849a 128 int sendMask(char * msg);
samux 4:466f90b7849a 129 int readChar(char * pC, bool block = true);
donatien 6:86e89a0369b9 130
donatien 6:86e89a0369b9 131 char scheme[8];
donatien 6:86e89a0369b9 132 uint16_t port;
donatien 6:86e89a0369b9 133 char host[32];
donatien 6:86e89a0369b9 134 char path[64];
dgriffin65 8:860d3b8e21f9 135 bool connected;
samux 4:466f90b7849a 136
dgriffin65 8:860d3b8e21f9 137 TCPSocket socket;
dgriffin65 8:860d3b8e21f9 138 NetworkStack *m_ns;
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