1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
/*
This file is part of the GSM3 communications library for Arduino
-- Multi-transport communications platform
-- Fully asynchronous
-- Includes code for the Arduino-Telefonica GSM/GPRS Shield V1
-- Voice calls
-- SMS
-- TCP/IP connections
-- HTTP basic clients
This library has been developed by Telef�nica Digital - PDI -
- Physical Internet Lab, as part as its collaboration with
Arduino and the Open Hardware Community.
September-December 2012
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
The latest version of this library can always be found at
https://github.com/BlueVia/Official-Arduino
*/
#ifndef __GSM3_SHIELDV1CLIENTPROVIDER__
#define __GSM3_SHIELDV1CLIENTPROVIDER__
#include <GSM3MobileClientProvider.h>
#include <GSM3ShieldV1BaseProvider.h>
class GSM3ShieldV1ClientProvider : public GSM3MobileClientProvider, public GSM3ShieldV1BaseProvider
{
private:
int remotePort; //Current operation remote port.
IPAddress remoteIP; // Remote IP address
int idSocket; // Remote ID socket.
/** Continue to connect TCP client function
*/
void connectTCPClientContinue();
/** Continue to available socket function
*/
void availableSocketContinue();
/** Continue to flush socket function
*/
void flushSocketContinue();
public:
/** Constructor */
GSM3ShieldV1ClientProvider();
/** minSocket
@return 0
*/
int minSocket(){return 0;};
/** maxSocket
@return 0
*/
int maxSocket(){return 0;};
/** Connect to a remote TCP server
@param server String with IP or server name
@param port Remote port number
@param id_socket Local socket number
@return 0 if command running, 1 if success, otherwise error
*/
int connectTCPClient(const char* server, int port, int id_socket);
/** Connect to a remote TCP server
@param add Remote IP address
@param port Remote port number
@param id_socket Local socket number
@return 0 if command running, 1 if success, otherwise error
*/
int connectTCPClient(IPAddress add, int port, int id_socket);
/** Begin writing through a socket
@param client1Server0 1 if modem acts as client, 0 if acts as server
@param id_socket Local socket number
@return 0 if command running, 1 if success, otherwise error
*/
void beginWriteSocket(bool client1Server0, int id_socket);
/** Write through a socket. MUST go after beginWriteSocket()
@param buf characters to be written (final 0 will not be written)
*/
void writeSocket(const char* buf);
/** Write through a socket. MUST go after beginWriteSocket()
@param c character to be written
*/
void writeSocket(uint8_t c);
/** Finish current writing
*/
void endWriteSocket();
/** Check if there are data to be read in socket.
@param client1Server0 1 if modem acts as client, 0 if acts as server
@param id_socket Local socket number
@return 0 if command running, 1 if there are data available, 4 if no data, otherwise error
*/
int availableSocket(bool client, int id_socket); // With "available" and "readSocket" ask the modem for 1500 bytes.
/** Read data (get a character) available in socket
@return character
*/
int readSocket(); //If Read() gets to the end of the QIRD response, execute again QIRD SYNCHRONOUSLY
/** Flush socket
*/
void flushSocket();
/** Get a character but will not advance the buffer head
@return character
*/
int peekSocket();
/** Close a socket
@param client1Server0 1 if modem acts as client, 0 if acts as server
@param id_socket Socket
@return 0 if command running, 1 if success, otherwise error
*/
int disconnectTCP(bool client1Server0, int id_socket);
/** Recognize unsolicited event
@param oldTail
@return true if successful
*/
bool recognizeUnsolicitedEvent(byte from);
/** Manages modem response
@param from Initial byte position
@param to Final byte position
*/
void manageResponse(byte from, byte to);
/** Get last command status
@return returns 0 if last command is still executing, 1 success, >1 error
*/
int ready(){return GSM3ShieldV1BaseProvider::ready();};
// Client socket management, just to be compatible
// with the Multi option
/** Get socket
@param socket Socket
@return socket
*/
int getSocket(int socket=-1);
/** Release socket
@param socket Socket
*/
void releaseSocket(int socket);
/** Get socket client status
@param socket Socket
@return 1 if connected, 0 otherwise
*/
bool getStatusSocketClient(uint8_t socket);
};
#endif
|
