mirror of
https://github.com/Links2004/arduinoWebSockets.git
synced 2025-07-12 15:06:30 +02:00
111 lines
3.4 KiB
C++
111 lines
3.4 KiB
C++
/**
|
|
* @file WebSockets.h
|
|
* @date 20.05.2015
|
|
* @author Markus Sattler
|
|
*
|
|
* Copyright (c) 2015 Markus Sattler. All rights reserved.
|
|
* This file is part of the WebSockets for Arduino.
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*
|
|
*/
|
|
|
|
#ifndef WEBSOCKETS_H_
|
|
#define WEBSOCKETS_H_
|
|
|
|
#include <Arduino.h>
|
|
|
|
#ifdef ESP8266
|
|
#include <ESP8266WiFi.h>
|
|
#else
|
|
#include <UIPEthernet.h>
|
|
#ifndef UIPETHERNET_H
|
|
#include <Ethernet.h>
|
|
#include <SPI.h>
|
|
#endif
|
|
#endif
|
|
|
|
#define DEBUG_WEBSOCKETS(...) Serial1.printf( __VA_ARGS__ );
|
|
|
|
#ifndef DEBUG_WEBSOCKETS
|
|
#define DEBUG_WEBSOCKETS(...)
|
|
#endif
|
|
|
|
#define WEBSOCKETS_MAX_DATA_SIZE (15*1024)
|
|
#define WEBSOCKETS_TCP_TIMEOUT (1000)
|
|
|
|
typedef enum {
|
|
WSC_NOT_CONNECTED,
|
|
WSC_HEADER,
|
|
WSC_CONNECTED
|
|
} WSclientsStatus_t;
|
|
|
|
typedef enum {
|
|
WSop_continuation = 0x00, ///< %x0 denotes a continuation frame
|
|
WSop_text = 0x01, ///< %x1 denotes a text frame
|
|
WSop_binary = 0x02, ///< %x2 denotes a binary frame
|
|
///< %x3-7 are reserved for further non-control frames
|
|
WSop_close = 0x08, ///< %x8 denotes a connection close
|
|
WSop_ping = 0x09, ///< %x9 denotes a ping
|
|
WSop_pong = 0x0A ///< %xA denotes a pong
|
|
///< %xB-F are reserved for further control frames
|
|
} WSopcode_t;
|
|
|
|
typedef struct {
|
|
uint8_t num; ///< connection number
|
|
|
|
WSclientsStatus_t status;
|
|
#ifdef ESP8266
|
|
WiFiClient tcp;
|
|
#else
|
|
#ifdef UIPETHERNET_H
|
|
UIPClient tcp;
|
|
#else
|
|
EthernetClient tcp;
|
|
#endif
|
|
#endif
|
|
String cUrl; ///< http url
|
|
|
|
bool cIsUpgrade; ///< Connection == Upgrade
|
|
bool cIsWebsocket; ///< Upgrade == websocket
|
|
|
|
String cKey; ///< client Sec-WebSocket-Key
|
|
String cProtocol; ///< client Sec-WebSocket-Protocol
|
|
String cExtensions; ///< client Sec-WebSocket-Extensions
|
|
int cVersion; ///< client Sec-WebSocket-Version
|
|
|
|
} WSclient_t;
|
|
|
|
class WebSockets {
|
|
protected:
|
|
virtual void clientDisconnect(WSclient_t * client);
|
|
virtual bool clientIsConnected(WSclient_t * client);
|
|
|
|
virtual void messageRecived(WSclient_t * client, WSopcode_t opcode, uint8_t * payload, size_t length);
|
|
|
|
void clientDisconnect(WSclient_t * client, uint16_t code, char * reason = NULL, size_t reasonLen = 0);
|
|
void sendFrame(WSclient_t * client, WSopcode_t opcode, uint8_t * payload = NULL, size_t length = 0);
|
|
|
|
|
|
void handleWebsocket(WSclient_t * client);
|
|
|
|
bool readWait(WSclient_t * client, uint8_t *out, size_t n);
|
|
|
|
String acceptKey(String clientKey);
|
|
String base64_encode(uint8_t * data, size_t length);
|
|
};
|
|
|
|
#endif /* WEBSOCKETS_H_ */
|