Skip to content

Commit 3f89b5d

Browse files
author
Me No Dev
committed
add licenses, fix headers, add sync client and async print
1 parent 19ceafb commit 3f89b5d

File tree

10 files changed

+916
-7
lines changed

10 files changed

+916
-7
lines changed

‎LICENSE.txt

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

‎library.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name=ESP8266 and ESP31B Async TCP Library
1+
name=ESP AsyncTCP
22
version=1.0.0
33
author=Me-No-Dev
44
maintainer=Me-No-Dev

‎src/AsyncPrinter.cpp

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
/*
2+
Asynchronous TCP library for Espressif MCUs
3+
4+
Copyright (c) 2016 Hristo Gochkov. All rights reserved.
5+
This file is part of the esp8266 core for Arduino environment.
6+
7+
This library is free software; you can redistribute it and/or
8+
modify it under the terms of the GNU Lesser General Public
9+
License as published by the Free Software Foundation; either
10+
version 2.1 of the License, or (at your option) any later version.
11+
12+
This library is distributed in the hope that it will be useful,
13+
but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15+
Lesser General Public License for more details.
16+
17+
You should have received a copy of the GNU Lesser General Public
18+
License along with this library; if not, write to the Free Software
19+
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20+
*/
21+
22+
#include "AsyncPrinter.h"
23+
24+
AsyncPrinter::AsyncPrinter()
25+
: _client(NULL)
26+
, _data_cb(NULL)
27+
, _data_arg(NULL)
28+
, _close_cb(NULL)
29+
, _close_arg(NULL)
30+
, _tx_buffer(NULL)
31+
, _tx_buffer_size(0)
32+
, next(NULL)
33+
{}
34+
35+
AsyncPrinter::AsyncPrinter(AsyncClient *client, size_t txBufLen)
36+
: _client(client)
37+
, _data_cb(NULL)
38+
, _data_arg(NULL)
39+
, _close_cb(NULL)
40+
, _close_arg(NULL)
41+
, _tx_buffer(NULL)
42+
, _tx_buffer_size(txBufLen)
43+
, next(NULL)
44+
{
45+
_attachCallbacks();
46+
_tx_buffer = new ccbuf(_tx_buffer_size);
47+
}
48+
49+
AsyncPrinter::~AsyncPrinter(){
50+
_on_close();
51+
}
52+
53+
void AsyncPrinter::onData(ApDataHandler cb, void *arg){
54+
_data_cb = cb;
55+
_data_arg = arg;
56+
}
57+
58+
void AsyncPrinter::onClose(ApCloseHandler cb, void *arg){
59+
_close_cb = cb;
60+
_close_arg = arg;
61+
}
62+
63+
AsyncPrinter::operator bool(){ return connected(); }
64+
65+
AsyncPrinter & AsyncPrinter::operator=(const AsyncPrinter &other){
66+
if(_client != NULL){
67+
_client->abort();
68+
_client->free();
69+
_client = NULL;
70+
}
71+
_tx_buffer_size = other._tx_buffer_size;
72+
if(_tx_buffer != NULL){
73+
ccbuf *b = _tx_buffer;
74+
_tx_buffer = NULL;
75+
delete b;
76+
}
77+
_tx_buffer = new ccbuf(other._tx_buffer_size);
78+
_client = other._client;
79+
_attachCallbacks();
80+
return *this;
81+
}
82+
83+
size_t AsyncPrinter::write(uint8_t data){
84+
return write(&data, 1);
85+
}
86+
87+
size_t AsyncPrinter::write(const uint8_t *data, size_t len){
88+
if(_tx_buffer == NULL || !connected())
89+
return 0;
90+
size_t toWrite = 0;
91+
size_t toSend = len;
92+
while(_tx_buffer->free() < toSend){
93+
toWrite = _tx_buffer->free();
94+
_tx_buffer->write((const char*)data, toWrite);
95+
while(!_client->canSend())
96+
delay(0);
97+
_sendBuffer();
98+
toSend -= toWrite;
99+
}
100+
_tx_buffer->write((const char*)(data+(len - toSend)), toSend);
101+
if(_client->canSend())
102+
_sendBuffer();
103+
return len;
104+
}
105+
106+
bool AsyncPrinter::connected(){
107+
return (_client != NULL && _client->connected());
108+
}
109+
110+
void AsyncPrinter::close(){
111+
if(_client != NULL)
112+
_client->close();
113+
}
114+
115+
size_t AsyncPrinter::_sendBuffer(){
116+
size_t available = _tx_buffer->available();
117+
if(!connected() || !_client->canSend() || available == 0)
118+
return 0;
119+
size_t sendable = _client->space();
120+
if(sendable < available)
121+
available= sendable;
122+
char *out = new char[available];
123+
_tx_buffer->read(out, available);
124+
size_t sent = _client->write(out, available);
125+
delete out;
126+
return sent;
127+
}
128+
129+
void AsyncPrinter::_onData(void *data, size_t len){
130+
if(_data_cb)
131+
_data_cb(_data_arg, this, (uint8_t*)data, len);
132+
}
133+
134+
void AsyncPrinter::_on_close(){
135+
if(_client != NULL){
136+
_client = NULL;
137+
}
138+
if(_tx_buffer != NULL){
139+
ccbuf *b = _tx_buffer;
140+
_tx_buffer = NULL;
141+
delete b;
142+
}
143+
if(_close_cb)
144+
_close_cb(_close_arg, this);
145+
}
146+
147+
void AsyncPrinter::_attachCallbacks(){
148+
_client->onPoll([](void *obj, AsyncClient* c){ ((AsyncPrinter*)(obj))->_sendBuffer(); }, this);
149+
_client->onAck([](void *obj, AsyncClient* c, size_t len, uint32_t time){ ((AsyncPrinter*)(obj))->_sendBuffer(); }, this);
150+
_client->onDisconnect([](void *obj, AsyncClient* c){ ((AsyncPrinter*)(obj))->_on_close(); c->abort(); c->free(); delete c; }, this);
151+
_client->onData([](void *obj, AsyncClient* c, void *data, size_t len){ ((AsyncPrinter*)(obj))->_onData(data, len); }, this);
152+
}
153+

‎src/AsyncPrinter.h

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
/*
2+
Asynchronous TCP library for Espressif MCUs
3+
4+
Copyright (c) 2016 Hristo Gochkov. All rights reserved.
5+
This file is part of the esp8266 core for Arduino environment.
6+
7+
This library is free software; you can redistribute it and/or
8+
modify it under the terms of the GNU Lesser General Public
9+
License as published by the Free Software Foundation; either
10+
version 2.1 of the License, or (at your option) any later version.
11+
12+
This library is distributed in the hope that it will be useful,
13+
but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15+
Lesser General Public License for more details.
16+
17+
You should have received a copy of the GNU Lesser General Public
18+
License along with this library; if not, write to the Free Software
19+
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20+
*/
21+
22+
#ifndef ASYNCPRINTER_H_
23+
#define ASYNCPRINTER_H_
24+
25+
#include "Arduino.h"
26+
#include "ESPAsyncTCP.h"
27+
#include "ccbuf.h"
28+
29+
class AsyncPrinter;
30+
31+
typedef std::function<void(void*, AsyncPrinter*, uint8_t*, size_t)> ApDataHandler;
32+
typedef std::function<void(void*, AsyncPrinter*)> ApCloseHandler;
33+
34+
class AsyncPrinter: public Print {
35+
private:
36+
AsyncClient *_client;
37+
ApDataHandler _data_cb;
38+
void *_data_arg;
39+
ApCloseHandler _close_cb;
40+
void *_close_arg;
41+
ccbuf *_tx_buffer;
42+
size_t _tx_buffer_size;
43+
public:
44+
AsyncPrinter *next;
45+
46+
AsyncPrinter();
47+
AsyncPrinter(AsyncClient *client, size_t txBufLen = 1460);
48+
virtual ~AsyncPrinter();
49+
50+
void onData(ApDataHandler cb, void *arg);
51+
void onClose(ApCloseHandler cb, void *arg);
52+
53+
operator bool();
54+
AsyncPrinter & operator=(const AsyncPrinter &other);
55+
56+
size_t write(uint8_t data);
57+
size_t write(const uint8_t *data, size_t len);
58+
59+
bool connected();
60+
void close();
61+
62+
size_t _sendBuffer();
63+
void _onData(void *data, size_t len);
64+
void _on_close();
65+
void _attachCallbacks();
66+
};
67+
68+
#endif /* ASYNCPRINTER_H_ */

0 commit comments

Comments
 (0)