Nigel Rantor / mbed-http

This library is used to make HTTP and HTTPS calls from mbed OS 5 applications.

Fork of mbed-http by sandbox

source/http_request.h@3:8a6b003e3874, 2017-02-23 (annotated)

Committer:
Jan Jongboom
Date:
Thu Feb 23 13:28:07 2017 +0100
Revision:
3:8a6b003e3874
Parent:
0:910f5949759f
Child:
7:2e3eedb9ca5c
Rely on Content-Length header to determine when request is processed

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 0:910f5949759f 27 #include "http_response_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 * - Allow socket re-use
Jan Jongboom 0:910f5949759f 34 */
Jan Jongboom 0:910f5949759f 35
Jan Jongboom 0:910f5949759f 36
Jan Jongboom 0:910f5949759f 37 /**
Jan Jongboom 0:910f5949759f 38 * \brief HttpRequest implements the logic for interacting with HTTPS servers.
Jan Jongboom 0:910f5949759f 39 */
Jan Jongboom 0:910f5949759f 40 class HttpRequest {
Jan Jongboom 0:910f5949759f 41 public:
Jan Jongboom 0:910f5949759f 42 /**
Jan Jongboom 0:910f5949759f 43 * HttpRequest Constructor
Jan Jongboom 0:910f5949759f 44 *
Jan Jongboom 0:910f5949759f 45 * @param[in] aNetwork The network interface
Jan Jongboom 0:910f5949759f 46 * @param[in] aMethod HTTP method to use
Jan Jongboom 0:910f5949759f 47 * @param[in] url URL to the resource
Jan Jongboom 0:910f5949759f 48 * @param[in] aBodyCallback Callback on which to retrieve chunks of the response body.
Jan Jongboom 0:910f5949759f 49 If not set, the complete body will be allocated on the HttpResponse object,
Jan Jongboom 0:910f5949759f 50 which might use lots of memory.
Jan Jongboom 0:910f5949759f 51 */
Jan Jongboom 0:910f5949759f 52 HttpRequest(NetworkInterface* aNetwork, http_method aMethod, const char* url, Callback<void(const char *at, size_t length)> aBodyCallback = 0)
Jan Jongboom 0:910f5949759f 53 : network(aNetwork), method(aMethod), body_callback(aBodyCallback)
Jan Jongboom 0:910f5949759f 54 {
Jan Jongboom 0:910f5949759f 55 error = 0;
Jan Jongboom 0:910f5949759f 56 response = NULL;
Jan Jongboom 0:910f5949759f 57
Jan Jongboom 0:910f5949759f 58 parsed_url = new ParsedUrl(url);
Jan Jongboom 0:910f5949759f 59 request_builder = new HttpRequestBuilder(method, parsed_url);
Jan Jongboom 0:910f5949759f 60 }
Jan Jongboom 0:910f5949759f 61
Jan Jongboom 0:910f5949759f 62 /**
Jan Jongboom 0:910f5949759f 63 * HttpRequest Constructor
Jan Jongboom 0:910f5949759f 64 */
Jan Jongboom 0:910f5949759f 65 ~HttpRequest() {
Jan Jongboom 0:910f5949759f 66 // should response be owned by us? Or should user free it?
Jan Jongboom 0:910f5949759f 67 // maybe implement copy constructor on response...
Jan Jongboom 0:910f5949759f 68 if (response) {
Jan Jongboom 0:910f5949759f 69 delete response;
Jan Jongboom 0:910f5949759f 70 }
Jan Jongboom 0:910f5949759f 71
Jan Jongboom 0:910f5949759f 72 if (parsed_url) {
Jan Jongboom 0:910f5949759f 73 delete parsed_url;
Jan Jongboom 0:910f5949759f 74 }
Jan Jongboom 0:910f5949759f 75
Jan Jongboom 0:910f5949759f 76 if (request_builder) {
Jan Jongboom 0:910f5949759f 77 delete request_builder;
Jan Jongboom 0:910f5949759f 78 }
Jan Jongboom 0:910f5949759f 79 }
Jan Jongboom 0:910f5949759f 80
Jan Jongboom 0:910f5949759f 81 /**
Jan Jongboom 0:910f5949759f 82 * Execute the request and receive the response.
Jan Jongboom 0:910f5949759f 83 */
Jan Jongboom 0:910f5949759f 84 HttpResponse* send(const void* body = NULL, nsapi_size_t body_size = 0) {
Jan Jongboom 0:910f5949759f 85 if (response != NULL) {
Jan Jongboom 0:910f5949759f 86 // already executed this response
Jan Jongboom 0:910f5949759f 87 error = -2100; // @todo, make a lookup table with errors
Jan Jongboom 0:910f5949759f 88 return NULL;
Jan Jongboom 0:910f5949759f 89 }
Jan Jongboom 0:910f5949759f 90
Jan Jongboom 0:910f5949759f 91 error = 0;
Jan Jongboom 0:910f5949759f 92
Jan Jongboom 0:910f5949759f 93 TCPSocket socket;
Jan Jongboom 0:910f5949759f 94
Jan Jongboom 0:910f5949759f 95 nsapi_error_t open_result = socket.open(network);
Jan Jongboom 0:910f5949759f 96 if (open_result != 0) {
Jan Jongboom 0:910f5949759f 97 error = open_result;
Jan Jongboom 0:910f5949759f 98 return NULL;
Jan Jongboom 0:910f5949759f 99 }
Jan Jongboom 0:910f5949759f 100
Jan Jongboom 0:910f5949759f 101 nsapi_error_t connection_result = socket.connect(parsed_url->host(), parsed_url->port());
Jan Jongboom 0:910f5949759f 102 if (connection_result != 0) {
Jan Jongboom 0:910f5949759f 103 error = connection_result;
Jan Jongboom 0:910f5949759f 104 return NULL;
Jan Jongboom 0:910f5949759f 105 }
Jan Jongboom 0:910f5949759f 106
Jan Jongboom 0:910f5949759f 107 char* request = request_builder->build(body, body_size);
Jan Jongboom 0:910f5949759f 108 size_t request_size = strlen(request);
Jan Jongboom 0:910f5949759f 109
Jan Jongboom 0:910f5949759f 110 nsapi_size_or_error_t send_result = socket.send(request, request_size);
Jan Jongboom 0:910f5949759f 111
Jan Jongboom 0:910f5949759f 112 free(request);
Jan Jongboom 0:910f5949759f 113
Jan Jongboom 0:910f5949759f 114 if (send_result != request_size) {
Jan Jongboom 0:910f5949759f 115 error = send_result;
Jan Jongboom 0:910f5949759f 116 return NULL;
Jan Jongboom 0:910f5949759f 117 }
Jan Jongboom 0:910f5949759f 118
Jan Jongboom 0:910f5949759f 119 // Create a response object
Jan Jongboom 0:910f5949759f 120 response = new HttpResponse();
Jan Jongboom 0:910f5949759f 121 // And a response parser
Jan Jongboom 0:910f5949759f 122 HttpResponseParser parser(response, body_callback);
Jan Jongboom 0:910f5949759f 123
Jan Jongboom 0:910f5949759f 124 // Set up a receive buffer (on the heap)
Jan Jongboom 0:910f5949759f 125 uint8_t* recv_buffer = (uint8_t*)malloc(HTTP_RECEIVE_BUFFER_SIZE);
Jan Jongboom 0:910f5949759f 126
Jan Jongboom 0:910f5949759f 127 // TCPSocket::recv is called until we don't have any data anymore
Jan Jongboom 0:910f5949759f 128 nsapi_size_or_error_t recv_ret;
Jan Jongboom 0:910f5949759f 129 while ((recv_ret = socket.recv(recv_buffer, HTTP_RECEIVE_BUFFER_SIZE)) > 0) {
Jan Jongboom 3:8a6b003e3874 130
Jan Jongboom 0:910f5949759f 131 // Pass the chunk into the http_parser
Jan Jongboom 0:910f5949759f 132 size_t nparsed = parser.execute((const char*)recv_buffer, recv_ret);
Jan Jongboom 0:910f5949759f 133 if (nparsed != recv_ret) {
Jan Jongboom 0:910f5949759f 134 // printf("Parsing failed... parsed %d bytes, received %d bytes\n", nparsed, recv_ret);
Jan Jongboom 0:910f5949759f 135 error = -2101;
Jan Jongboom 0:910f5949759f 136 free(recv_buffer);
Jan Jongboom 0:910f5949759f 137 return NULL;
Jan Jongboom 0:910f5949759f 138 }
Jan Jongboom 3:8a6b003e3874 139
Jan Jongboom 3:8a6b003e3874 140 if (response->is_body_complete()) {
Jan Jongboom 0:910f5949759f 141 break;
Jan Jongboom 0:910f5949759f 142 }
Jan Jongboom 0:910f5949759f 143 }
Jan Jongboom 0:910f5949759f 144 // error?
Jan Jongboom 0:910f5949759f 145 if (recv_ret < 0) {
Jan Jongboom 0:910f5949759f 146 error = recv_ret;
Jan Jongboom 0:910f5949759f 147 free(recv_buffer);
Jan Jongboom 0:910f5949759f 148 return NULL;
Jan Jongboom 0:910f5949759f 149 }
Jan Jongboom 0:910f5949759f 150
Jan Jongboom 0:910f5949759f 151 // When done, call parser.finish()
Jan Jongboom 0:910f5949759f 152 parser.finish();
Jan Jongboom 0:910f5949759f 153
Jan Jongboom 0:910f5949759f 154 // Free the receive buffer
Jan Jongboom 0:910f5949759f 155 free(recv_buffer);
Jan Jongboom 0:910f5949759f 156
Jan Jongboom 0:910f5949759f 157 // Close the socket
Jan Jongboom 0:910f5949759f 158 socket.close();
Jan Jongboom 0:910f5949759f 159
Jan Jongboom 0:910f5949759f 160 return response;
Jan Jongboom 0:910f5949759f 161 }
Jan Jongboom 0:910f5949759f 162
Jan Jongboom 0:910f5949759f 163 /**
Jan Jongboom 0:910f5949759f 164 * Set a header for the request.
Jan Jongboom 0:910f5949759f 165 *
Jan Jongboom 0:910f5949759f 166 * The 'Host' and 'Content-Length' headers are set automatically.
Jan Jongboom 0:910f5949759f 167 * Setting the same header twice will overwrite the previous entry.
Jan Jongboom 0:910f5949759f 168 *
Jan Jongboom 0:910f5949759f 169 * @param[in] key Header key
Jan Jongboom 0:910f5949759f 170 * @param[in] value Header value
Jan Jongboom 0:910f5949759f 171 */
Jan Jongboom 0:910f5949759f 172 void set_header(string key, string value) {
Jan Jongboom 0:910f5949759f 173 request_builder->set_header(key, value);
Jan Jongboom 0:910f5949759f 174 }
Jan Jongboom 0:910f5949759f 175
Jan Jongboom 0:910f5949759f 176 /**
Jan Jongboom 0:910f5949759f 177 * Get the error code.
Jan Jongboom 0:910f5949759f 178 *
Jan Jongboom 0:910f5949759f 179 * When send() fails, this error is set.
Jan Jongboom 0:910f5949759f 180 */
Jan Jongboom 0:910f5949759f 181 nsapi_error_t get_error() {
Jan Jongboom 0:910f5949759f 182 return error;
Jan Jongboom 0:910f5949759f 183 }
Jan Jongboom 0:910f5949759f 184
Jan Jongboom 0:910f5949759f 185 private:
Jan Jongboom 0:910f5949759f 186 NetworkInterface* network;
Jan Jongboom 0:910f5949759f 187 http_method method;
Jan Jongboom 0:910f5949759f 188 Callback<void(const char *at, size_t length)> body_callback;
Jan Jongboom 0:910f5949759f 189
Jan Jongboom 0:910f5949759f 190 ParsedUrl* parsed_url;
Jan Jongboom 0:910f5949759f 191
Jan Jongboom 0:910f5949759f 192 HttpRequestBuilder* request_builder;
Jan Jongboom 0:910f5949759f 193 HttpResponse* response;
Jan Jongboom 0:910f5949759f 194
Jan Jongboom 0:910f5949759f 195 nsapi_error_t error;
Jan Jongboom 0:910f5949759f 196 };
Jan Jongboom 0:910f5949759f 197
Jan Jongboom 0:910f5949759f 198 #endif // _HTTP_REQUEST_