Repository navigation
Expand file tree
/
Copy pathHTTPClient.h
More file actions
197 lines (188 loc) · 6.89 KB
/
Copy pathHTTPClient.h
File metadata and controls
197 lines (188 loc) · 6.89 KB
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
/*
* HTTPClient
* HTTPClient.h
*
* http://interactive-matter.org/
*
* This file is part of HTTPClient.
*
* HTTPClient is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* HTTPClient 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 General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with HTTPClient. If not, see <http://www.gnu.org/licenses/>.
*
* Created on: 18.09.2010
* Author: Marcus Nowotny of Interactive Matter
*/
#ifndef HTTPCLIENT_H_
#define HTTPCLIENT_H_
#include <inttypes.h>
#include "EthernetClient.h"
/* This struct is used to pass parameters as URI paramters and additional HTTP headers.
* normally you pass this as a array. The last entry must have the NULL-Pointer as name.
*/
typedef struct
{
char* name;
char* value;
} http_client_parameter;
/*
* The HTTP client is basically a Ethernet client with some additional functions. The functions
* of the Ethernet client are not accessible.
* To construct a HTTP client you have to provide the IP AND the name of the server Ð else
* the virtual host management of most internet servers will fail. Sorry for the inconvenience.
*/
class HTTPClient : private EthernetClient
{
public:
/*
* create a HTTP client that connects to the default port 80.
*/
HTTPClient(char* host, uint8_t* ip );
/*
* create a HTTP client that connects to another port. HTTPS is not supported.
*/
HTTPClient(char* host, uint8_t* ip, uint16_t port);
/*
* Post a GET request to the server.
* The result is a file handle or null is an error occured.
*/
FILE*
getURI(char* uri);
/*
* Post a GET request to the server and give additional URI parameters like ?X=Y&...
* The URI Parameters should be given as array with {NULL,NULL} as marker for the
* last element.
* The result is a file handle or null is an error occured.
*/
FILE*
getURI(char* uri, http_client_parameter parameters[]);
/*
* Post a GET request to the server, give additional URI parameters ?X=Y&...
* and give additional HTTP header parameters (e.g. for some API key).
* The URI Parameters should be given as array with {NULL,NULL} as marker for the
* last element.
* The result is a file handle or null is an error occured.
*/
FILE*
getURI(char* uri, http_client_parameter parameters[],
http_client_parameter headers[]);
FILE*
/*
* Post a POST request to the server.
* The data is directly streamed to the server. It must be kept completely in
* memory since we must know how much data to send.
* The result is a file handle or null is an error occured.
*/
postURI(char* uri, char* data);
/*
* Post a POST request to the server and give additional URI parameters like ?X=Y&...
* The URI Parameters should be given as array with {NULL,NULL} as marker for the
* last element.
* The data is directly streamed to the server. It must be kept completely in
* memory since we must know how much data to send.
* The result is a file handle or null is an error occured.
*/
FILE*
postURI(char* uri, http_client_parameter parameters[], char* data);
/*
* Post a POST request to the server, give additional URI parameters ?X=Y&...
* and give additional HTTP header parameters (e.g. for some API key).
* The URI Parameters should be given as array with {NULL,NULL} as marker for the
* last element.
* The data is directly streamed to the server. It must be kept completely in
* memory since we must know how much data to send.
* The result is a file handle or null is an error occured.
*/
FILE*
postURI(char* uri, http_client_parameter parameters[], char* data,
http_client_parameter headers[]);
/*
* Post a REST PUT request to the server.
* The data is directly streamed to the server. It must be kept completely in
* memory since we must know how much data to send.
* The result is a file handle or null is an error occured.
*/
FILE*
putURI(char* uri, char* data);
/*
* Post a REST PUT request to the server and give additional URI parameters like ?X=Y&...
* The URI Parameters should be given as array with {NULL,NULL} as marker for the
* last element.
* The data is directly streamed to the server. It must be kept completely in
* memory since we must know how much data to send.
* The result is a file handle or null is an error occured.
*/
FILE*
putURI(char* uri, http_client_parameter parameters[], char* data);
/*
* Post a REST PUT request to the server, give additional URI parameters ?X=Y&...
* and give additional HTTP header parameters (e.g. for some API key).
* The URI Parameters should be given as array with {NULL,NULL} as marker for the
* last element.
* The data is directly streamed to the server. It must be kept completely in
* memory since we must know how much data to send.
* The result is a file handle or null is an error occured.
*/
FILE*
putURI(char* uri, http_client_parameter parameters[], char* data,
http_client_parameter headers[]);
/*
* Retrieve the HTTP return code of the last request. 200 indicates that everything was ok.
* For further details refer to http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
*/
int
getLastReturnCode(void);
/*
* enable or disable the debug code.
* By default the debug code is disabled. If debug is enabled the complete request and response
* is printed out on the serial connection. Very useful if your request do not work.
*/
void
debug(char debugOn);
static void
closeStream(FILE* stream);
/*
* And that is the internal stuff of the HTTP client
*/
private:
//the name of the host we are talking to
char* hostName;
//the ip of the host
uint8_t* ip;
//the port we are talking to
uint16_t port;
//the HTTP return code of the last request
int lastReturnCode;
//print to serial?
char debugCommunication;
//opening the client stream
FILE*
openClientFile();
//the rw routines
static int
clientWrite(char byte, FILE* stream);
static int
clientRead(FILE* stream);
//a helper to throw away the HTTP client
int
skipHeader(FILE* stream);
//a way to specify if and which URI encoding to use - encodeReserved also encodes characters
// like / or ? for URI parameters & stuff
static void
setEncoding(FILE* stream, char encode, char encodeReserved);
//some HTTP helpers
char
sendUriAndHeaders(FILE* stream, char* hostName, char* requestType, char* uri,
http_client_parameter parameters[], http_client_parameter headers[]);
char
sendContentPayload(FILE* stream, char* data);
};
#endif /* HTTPCLIENT_H_ */