Kentaro Sekimoto / mbed-http

mbed-http

Fork of mbed-http by sandbox

source/http_request.h@22:fb5e4bc49534, 2018-01-02 (annotated)

Committer:
ksekimoto
Date:
Tue Jan 02 16:00:05 2018 +0000
Revision:
22:fb5e4bc49534
Parent:
20:0e63d6a93c02 
Change http-buffer-size for GR-PEACH

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jan Jongboom 0:910f5949759f 1 /*
Jan Jongboom 0:910f5949759f 2 * PackageLicenseDeclared: Apache-2.0
Jan Jongboom 0:910f5949759f 3 * Copyright (c) 2017 ARM Limited
Jan Jongboom 0:910f5949759f 4 *
Jan Jongboom 0:910f5949759f 5 * Licensed under the Apache License, Version 2.0 (the "License");
Jan Jongboom 0:910f5949759f 6 * you may not use this file except in compliance with the License.
Jan Jongboom 0:910f5949759f 7 * You may obtain a copy of the License at
Jan Jongboom 0:910f5949759f 8 *
Jan Jongboom 0:910f5949759f 9 * http://www.apache.org/licenses/LICENSE-2.0
Jan Jongboom 0:910f5949759f 10 *
Jan Jongboom 0:910f5949759f 11 * Unless required by applicable law or agreed to in writing, software
Jan Jongboom 0:910f5949759f 12 * distributed under the License is distributed on an "AS IS" BASIS,
Jan Jongboom 0:910f5949759f 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Jan Jongboom 0:910f5949759f 14 * See the License for the specific language governing permissions and
Jan Jongboom 0:910f5949759f 15 * limitations under the License.
Jan Jongboom 0:910f5949759f 16 */
Jan Jongboom 0:910f5949759f 17
Jan Jongboom 0:910f5949759f 18 #ifndef _HTTP_REQUEST_
Jan Jongboom 0:910f5949759f 19 #define _HTTP_REQUEST_
Jan Jongboom 0:910f5949759f 20
Jan Jongboom 0:910f5949759f 21 #include <string>
Jan Jongboom 0:910f5949759f 22 #include <vector>
Jan Jongboom 0:910f5949759f 23 #include <map>
Jan Jongboom 0:910f5949759f 24 #include "http_parser.h"
Jan Jongboom 0:910f5949759f 25 #include "http_response.h"
Jan Jongboom 0:910f5949759f 26 #include "http_request_builder.h"
Jan Jongboom 15:ffc77f212382 27 #include "http_request_parser.h"
Jan Jongboom 0:910f5949759f 28 #include "http_parsed_url.h"
Jan Jongboom 0:910f5949759f 29
Jan Jongboom 0:910f5949759f 30 /**
Jan Jongboom 0:910f5949759f 31 * @todo:
Jan Jongboom 0:910f5949759f 32 * - Userinfo parameter is not handled
Jan Jongboom 0:910f5949759f 33 */
Jan Jongboom 0:910f5949759f 34
Jan Jongboom 20:0e63d6a93c02 35 #ifndef HTTP_RECEIVE_BUFFER_SIZE
Jan Jongboom 20:0e63d6a93c02 36 #define HTTP_RECEIVE_BUFFER_SIZE 8 * 1024
Jan Jongboom 20:0e63d6a93c02 37 #endif
Jan Jongboom 0:910f5949759f 38
Jan Jongboom 0:910f5949759f 39 /**
Jan Jongboom 17:6e0025e01b98 40 * \brief HttpRequest implements the logic for interacting with HTTP servers.
Jan Jongboom 0:910f5949759f 41 */
Jan Jongboom 0:910f5949759f 42 class HttpRequest {
Jan Jongboom 0:910f5949759f 43 public:
Jan Jongboom 0:910f5949759f 44 /**
Jan Jongboom 0:910f5949759f 45 * HttpRequest Constructor
Jan Jongboom 0:910f5949759f 46 *
Jan Jongboom 0:910f5949759f 47 * @param[in] aNetwork The network interface
Jan Jongboom 0:910f5949759f 48 * @param[in] aMethod HTTP method to use
Jan Jongboom 0:910f5949759f 49 * @param[in] url URL to the resource
Jan Jongboom 0:910f5949759f 50 * @param[in] aBodyCallback Callback on which to retrieve chunks of the response body.
Jan Jongboom 0:910f5949759f 51 If not set, the complete body will be allocated on the HttpResponse object,
Jan Jongboom 0:910f5949759f 52 which might use lots of memory.
Jan Jongboom 0:910f5949759f 53 */
Jan Jongboom 0:910f5949759f 54 HttpRequest(NetworkInterface* aNetwork, http_method aMethod, const char* url, Callback<void(const char *at, size_t length)> aBodyCallback = 0)
Jan Jongboom 0:910f5949759f 55 : network(aNetwork), method(aMethod), body_callback(aBodyCallback)
Jan Jongboom 0:910f5949759f 56 {
Jan Jongboom 0:910f5949759f 57 error = 0;
Jan Jongboom 0:910f5949759f 58 response = NULL;
Jan Jongboom 0:910f5949759f 59
Jan Jongboom 0:910f5949759f 60 parsed_url = new ParsedUrl(url);
Jan Jongboom 0:910f5949759f 61 request_builder = new HttpRequestBuilder(method, parsed_url);
Jan Jongboom 11:96e4dcb9c0c2 62
Jan Jongboom 11:96e4dcb9c0c2 63 socket = new TCPSocket();
Jan Jongboom 11:96e4dcb9c0c2 64 we_created_socket = true;
Jan Jongboom 11:96e4dcb9c0c2 65 }
Jan Jongboom 11:96e4dcb9c0c2 66
Jan Jongboom 11:96e4dcb9c0c2 67 /**
Jan Jongboom 11:96e4dcb9c0c2 68 * HttpRequest Constructor
Jan Jongboom 11:96e4dcb9c0c2 69 *
Jan Jongboom 11:96e4dcb9c0c2 70 * @param[in] aSocket An open TCPSocket
Jan Jongboom 11:96e4dcb9c0c2 71 * @param[in] aMethod HTTP method to use
Jan Jongboom 11:96e4dcb9c0c2 72 * @param[in] url URL to the resource
Jan Jongboom 11:96e4dcb9c0c2 73 * @param[in] aBodyCallback Callback on which to retrieve chunks of the response body.
Jan Jongboom 11:96e4dcb9c0c2 74 If not set, the complete body will be allocated on the HttpResponse object,
Jan Jongboom 11:96e4dcb9c0c2 75 which might use lots of memory.
Jan Jongboom 11:96e4dcb9c0c2 76 */
Jan Jongboom 11:96e4dcb9c0c2 77 HttpRequest(TCPSocket* aSocket, http_method aMethod, const char* url, Callback<void(const char *at, size_t length)> aBodyCallback = 0)
Jan Jongboom 11:96e4dcb9c0c2 78 : socket(aSocket), method(aMethod), body_callback(aBodyCallback)
Jan Jongboom 11:96e4dcb9c0c2 79 {
Jan Jongboom 11:96e4dcb9c0c2 80 error = 0;
Jan Jongboom 11:96e4dcb9c0c2 81 response = NULL;
Jan Jongboom 11:96e4dcb9c0c2 82 network = NULL;
Jan Jongboom 11:96e4dcb9c0c2 83
Jan Jongboom 11:96e4dcb9c0c2 84 parsed_url = new ParsedUrl(url);
Jan Jongboom 11:96e4dcb9c0c2 85 request_builder = new HttpRequestBuilder(method, parsed_url);
Jan Jongboom 11:96e4dcb9c0c2 86
Jan Jongboom 11:96e4dcb9c0c2 87 we_created_socket = false;
Jan Jongboom 0:910f5949759f 88 }
Jan Jongboom 0:910f5949759f 89
Jan Jongboom 0:910f5949759f 90 /**
Jan Jongboom 0:910f5949759f 91 * HttpRequest Constructor
Jan Jongboom 0:910f5949759f 92 */
Jan Jongboom 0:910f5949759f 93 ~HttpRequest() {
Jan Jongboom 0:910f5949759f 94 // should response be owned by us? Or should user free it?
Jan Jongboom 0:910f5949759f 95 // maybe implement copy constructor on response...
Jan Jongboom 0:910f5949759f 96 if (response) {
Jan Jongboom 0:910f5949759f 97 delete response;
Jan Jongboom 0:910f5949759f 98 }
Jan Jongboom 0:910f5949759f 99
Jan Jongboom 0:910f5949759f 100 if (parsed_url) {
Jan Jongboom 0:910f5949759f 101 delete parsed_url;
Jan Jongboom 0:910f5949759f 102 }
Jan Jongboom 0:910f5949759f 103
Jan Jongboom 0:910f5949759f 104 if (request_builder) {
Jan Jongboom 0:910f5949759f 105 delete request_builder;
Jan Jongboom 0:910f5949759f 106 }
Jan Jongboom 11:96e4dcb9c0c2 107
Jan Jongboom 11:96e4dcb9c0c2 108 if (socket && we_created_socket) {
Jan Jongboom 11:96e4dcb9c0c2 109 delete socket;
Jan Jongboom 11:96e4dcb9c0c2 110 }
Jan Jongboom 0:910f5949759f 111 }
Jan Jongboom 0:910f5949759f 112
Jan Jongboom 0:910f5949759f 113 /**
Jan Jongboom 0:910f5949759f 114 * Execute the request and receive the response.
Jan Jongboom 0:910f5949759f 115 */
Jan Jongboom 0:910f5949759f 116 HttpResponse* send(const void* body = NULL, nsapi_size_t body_size = 0) {
Jan Jongboom 0:910f5949759f 117 if (response != NULL) {
Jan Jongboom 0:910f5949759f 118 // already executed this response
Jan Jongboom 0:910f5949759f 119 error = -2100; // @todo, make a lookup table with errors
Jan Jongboom 0:910f5949759f 120 return NULL;
Jan Jongboom 0:910f5949759f 121 }
Jan Jongboom 0:910f5949759f 122
Jan Jongboom 0:910f5949759f 123 error = 0;
Jan Jongboom 0:910f5949759f 124
Jan Jongboom 11:96e4dcb9c0c2 125 if (we_created_socket) {
Jan Jongboom 11:96e4dcb9c0c2 126 nsapi_error_t open_result = socket->open(network);
Jan Jongboom 11:96e4dcb9c0c2 127 if (open_result != 0) {
Jan Jongboom 11:96e4dcb9c0c2 128 error = open_result;
Jan Jongboom 11:96e4dcb9c0c2 129 return NULL;
Jan Jongboom 11:96e4dcb9c0c2 130 }
Jan Jongboom 0:910f5949759f 131
Jan Jongboom 11:96e4dcb9c0c2 132 nsapi_error_t connection_result = socket->connect(parsed_url->host(), parsed_url->port());
Jan Jongboom 11:96e4dcb9c0c2 133 if (connection_result != 0) {
Jan Jongboom 11:96e4dcb9c0c2 134 error = connection_result;
Jan Jongboom 11:96e4dcb9c0c2 135 return NULL;
Jan Jongboom 11:96e4dcb9c0c2 136 }
Jan Jongboom 0:910f5949759f 137 }
Jan Jongboom 0:910f5949759f 138
Jan Jongboom 10:b017c7d2cf23 139 size_t request_size = 0;
Jan Jongboom 10:b017c7d2cf23 140 char* request = request_builder->build(body, body_size, request_size);
Jan Jongboom 0:910f5949759f 141
Jan Jongboom 11:96e4dcb9c0c2 142 nsapi_size_or_error_t send_result = socket->send(request, request_size);
Jan Jongboom 0:910f5949759f 143
Jan Jongboom 0:910f5949759f 144 free(request);
Jan Jongboom 0:910f5949759f 145
Jan Jongboom 0:910f5949759f 146 if (send_result != request_size) {
Jan Jongboom 0:910f5949759f 147 error = send_result;
Jan Jongboom 0:910f5949759f 148 return NULL;
Jan Jongboom 0:910f5949759f 149 }
Jan Jongboom 0:910f5949759f 150
Jan Jongboom 0:910f5949759f 151 // Create a response object
Jan Jongboom 0:910f5949759f 152 response = new HttpResponse();
Jan Jongboom 0:910f5949759f 153 // And a response parser
Jan Jongboom 15:ffc77f212382 154 HttpParser parser(response, HTTP_RESPONSE, body_callback);
Jan Jongboom 0:910f5949759f 155
Jan Jongboom 0:910f5949759f 156 // Set up a receive buffer (on the heap)
Jan Jongboom 0:910f5949759f 157 uint8_t* recv_buffer = (uint8_t*)malloc(HTTP_RECEIVE_BUFFER_SIZE);
Jan Jongboom 0:910f5949759f 158
Jan Jongboom 0:910f5949759f 159 // TCPSocket::recv is called until we don't have any data anymore
Jan Jongboom 0:910f5949759f 160 nsapi_size_or_error_t recv_ret;
Jan Jongboom 11:96e4dcb9c0c2 161 while ((recv_ret = socket->recv(recv_buffer, HTTP_RECEIVE_BUFFER_SIZE)) > 0) {
Jan Jongboom 3:8a6b003e3874 162
Jan Jongboom 0:910f5949759f 163 // Pass the chunk into the http_parser
Jan Jongboom 0:910f5949759f 164 size_t nparsed = parser.execute((const char*)recv_buffer, recv_ret);
Jan Jongboom 0:910f5949759f 165 if (nparsed != recv_ret) {
Jan Jongboom 0:910f5949759f 166 // printf("Parsing failed... parsed %d bytes, received %d bytes\n", nparsed, recv_ret);
Jan Jongboom 0:910f5949759f 167 error = -2101;
Jan Jongboom 0:910f5949759f 168 free(recv_buffer);
Jan Jongboom 0:910f5949759f 169 return NULL;
Jan Jongboom 0:910f5949759f 170 }
Jan Jongboom 3:8a6b003e3874 171
Jan Jongboom 7:2e3eedb9ca5c 172 if (response->is_message_complete()) {
Jan Jongboom 0:910f5949759f 173 break;
Jan Jongboom 0:910f5949759f 174 }
Jan Jongboom 0:910f5949759f 175 }
Jan Jongboom 0:910f5949759f 176 // error?
Jan Jongboom 0:910f5949759f 177 if (recv_ret < 0) {
Jan Jongboom 0:910f5949759f 178 error = recv_ret;
Jan Jongboom 0:910f5949759f 179 free(recv_buffer);
Jan Jongboom 0:910f5949759f 180 return NULL;
Jan Jongboom 0:910f5949759f 181 }
Jan Jongboom 0:910f5949759f 182
Jan Jongboom 0:910f5949759f 183 // When done, call parser.finish()
Jan Jongboom 0:910f5949759f 184 parser.finish();
Jan Jongboom 0:910f5949759f 185
Jan Jongboom 0:910f5949759f 186 // Free the receive buffer
Jan Jongboom 0:910f5949759f 187 free(recv_buffer);
Jan Jongboom 0:910f5949759f 188
Jan Jongboom 11:96e4dcb9c0c2 189 if (we_created_socket) {
Jan Jongboom 11:96e4dcb9c0c2 190 // Close the socket
Jan Jongboom 11:96e4dcb9c0c2 191 socket->close();
Jan Jongboom 11:96e4dcb9c0c2 192 }
Jan Jongboom 0:910f5949759f 193
Jan Jongboom 0:910f5949759f 194 return response;
Jan Jongboom 0:910f5949759f 195 }
Jan Jongboom 0:910f5949759f 196
Jan Jongboom 0:910f5949759f 197 /**
Jan Jongboom 0:910f5949759f 198 * Set a header for the request.
Jan Jongboom 0:910f5949759f 199 *
Jan Jongboom 0:910f5949759f 200 * The 'Host' and 'Content-Length' headers are set automatically.
Jan Jongboom 0:910f5949759f 201 * Setting the same header twice will overwrite the previous entry.
Jan Jongboom 0:910f5949759f 202 *
Jan Jongboom 0:910f5949759f 203 * @param[in] key Header key
Jan Jongboom 0:910f5949759f 204 * @param[in] value Header value
Jan Jongboom 0:910f5949759f 205 */
Jan Jongboom 0:910f5949759f 206 void set_header(string key, string value) {
Jan Jongboom 0:910f5949759f 207 request_builder->set_header(key, value);
Jan Jongboom 0:910f5949759f 208 }
Jan Jongboom 0:910f5949759f 209
Jan Jongboom 0:910f5949759f 210 /**
Jan Jongboom 0:910f5949759f 211 * Get the error code.
Jan Jongboom 0:910f5949759f 212 *
Jan Jongboom 0:910f5949759f 213 * When send() fails, this error is set.
Jan Jongboom 0:910f5949759f 214 */
Jan Jongboom 0:910f5949759f 215 nsapi_error_t get_error() {
Jan Jongboom 0:910f5949759f 216 return error;
Jan Jongboom 0:910f5949759f 217 }
Jan Jongboom 0:910f5949759f 218
Jan Jongboom 0:910f5949759f 219 private:
Jan Jongboom 0:910f5949759f 220 NetworkInterface* network;
Jan Jongboom 11:96e4dcb9c0c2 221 TCPSocket* socket;
Jan Jongboom 0:910f5949759f 222 http_method method;
Jan Jongboom 0:910f5949759f 223 Callback<void(const char *at, size_t length)> body_callback;
Jan Jongboom 0:910f5949759f 224
Jan Jongboom 0:910f5949759f 225 ParsedUrl* parsed_url;
Jan Jongboom 0:910f5949759f 226
Jan Jongboom 0:910f5949759f 227 HttpRequestBuilder* request_builder;
Jan Jongboom 0:910f5949759f 228 HttpResponse* response;
Jan Jongboom 0:910f5949759f 229
Jan Jongboom 11:96e4dcb9c0c2 230 bool we_created_socket;
Jan Jongboom 11:96e4dcb9c0c2 231
Jan Jongboom 0:910f5949759f 232 nsapi_error_t error;
Jan Jongboom 0:910f5949759f 233 };
Jan Jongboom 0:910f5949759f 234
Jan Jongboom 0:910f5949759f 235 #endif // _HTTP_REQUEST_