ESP3D  3.0
Firmware for ESP boards connected to 3D Printer
websocket_server.h
Go to the documentation of this file.
1 /*
2  websocket_server.h - websocket functions class
3 
4  Copyright (c) 2014 Luc Lebosse. All rights reserved.
5 
6  This library is free software; you can redistribute it and/or
7  modify it under the terms of the GNU Lesser General Public
8  License as published by the Free Software Foundation; either
9  version 2.1 of the License, or (at your option) any later version.
10 
11  This library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public
17  License along with this library; if not, write to the Free Software
18  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20 
21 
22 #ifndef _WEBSOCKET_SERVER_H_
23 #define _WEBSOCKET_SERVER_H_
24 
25 #include "Print.h"
26 #define TXBUFFERSIZE 1200
27 #define RXBUFFERSIZE 256
28 #define FLUSHTIMEOUT 500
29 class WebSocketsServer;
30 class WebSocket_Server: public Print
31 {
32 public:
35  size_t write(uint8_t c);
36  size_t write(const uint8_t *buffer, size_t size);
37 
38  inline size_t write(const char * s)
39  {
40  return write((uint8_t*) s, strlen(s));
41  }
42  inline size_t write(unsigned long n)
43  {
44  return write((uint8_t) n);
45  }
46  inline size_t write(long n)
47  {
48  return write((uint8_t) n);
49  }
50  inline size_t write(unsigned int n)
51  {
52  return write((uint8_t) n);
53  }
54  inline size_t write(int n)
55  {
56  return write((uint8_t) n);
57  }
58  bool begin(uint16_t port=0, bool debug=false);
59  uint16_t port()
60  {
61  return _port;
62  }
63  void end();
64  int available();
65  uint availableForWrite();
66  void pushMSG (const char * data);
67  void pushMSG (uint num, const char * data);
68  void flush(void);
69  void handle();
70  operator bool() const;
71  void set_currentID(uint8_t current_id);
72  uint8_t get_currentID();
73  void closeClients();
74  bool started()
75  {
76  return _started;
77  }
78  void push2RXbuffer(uint8_t * sbuf, size_t len);
79 private:
80  bool _started;
81  uint16_t _port;
82  bool _isdebug;
83  bool _isdata;
84  uint32_t _lastTXflush;
85  uint32_t _lastRXflush;
86  WebSocketsServer * _websocket_server;
87  uint8_t _TXbuffer[TXBUFFERSIZE];
88  uint16_t _TXbufferSize;
89  uint8_t _current_id;
90  void flushTXbuffer();
91  void flushRXbuffer();
92  uint8_t *_RXbuffer;
93  uint16_t _RXbufferSize;
94 };
95 
97 
98 #if defined(WS_DATA_FEATURE)
100 #endif //WS_DATA_FEATURE
101 #endif //_WEBSOCKET_SERVER_H_
WebSocket_Server::set_currentID
void set_currentID(uint8_t current_id)
Definition: websocket_server.cpp:201
WebSocket_Server
Definition: websocket_server.h:30
WebSocket_Server::write
size_t write(uint8_t c)
Definition: websocket_server.cpp:210
WebSocket_Server::get_currentID
uint8_t get_currentID()
Definition: websocket_server.cpp:205
WebSocket_Server::available
int available()
Definition: websocket_server.cpp:117
WebSocket_Server::~WebSocket_Server
~WebSocket_Server()
Definition: websocket_server.cpp:136
websocket_data_server
WebSocket_Server websocket_data_server
Definition: websocket_server.cpp:35
WebSocket_Server::write
size_t write(long n)
Definition: websocket_server.h:46
WebSocket_Server::started
bool started()
Definition: websocket_server.h:74
TXBUFFERSIZE
#define TXBUFFERSIZE
Definition: websocket_server.h:26
WebSocket_Server::write
size_t write(unsigned int n)
Definition: websocket_server.h:50
WebSocket_Server::closeClients
void closeClients()
Definition: websocket_server.cpp:49
WebSocket_Server::pushMSG
void pushMSG(const char *data)
Definition: websocket_server.cpp:37
WebSocket_Server::end
void end()
Definition: websocket_server.cpp:176
WebSocket_Server::WebSocket_Server
WebSocket_Server()
Definition: websocket_server.cpp:125
WebSocket_Server::availableForWrite
uint availableForWrite()
Definition: websocket_server.cpp:121
WebSocket_Server::write
size_t write(const char *s)
Definition: websocket_server.h:38
WebSocket_Server::flush
void flush(void)
Definition: websocket_server.cpp:315
websocket_terminal_server
WebSocket_Server websocket_terminal_server
Definition: websocket_server.cpp:33
WebSocket_Server::handle
void handle()
Definition: websocket_server.cpp:295
WebSocket_Server::port
uint16_t port()
Definition: websocket_server.h:59
WebSocket_Server::push2RXbuffer
void push2RXbuffer(uint8_t *sbuf, size_t len)
Definition: websocket_server.cpp:244
WebSocket_Server::write
size_t write(int n)
Definition: websocket_server.h:54
WebSocket_Server::begin
bool begin(uint16_t port=0, bool debug=false)
Definition: websocket_server.cpp:140
WebSocket_Server::write
size_t write(unsigned long n)
Definition: websocket_server.h:42