3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #ifndef HTTPFETCH_HEADER
21 #define HTTPFETCH_HEADER
24 #include "util/string.h"
27 // Can be used in place of "caller" in asynchronous transfers to discard result
28 // (used as default value of "caller")
29 #define HTTPFETCH_DISCARD 0
30 #define HTTPFETCH_SYNC 1
32 struct HTTPFetchRequest
36 // Identifies the caller (for asynchronous requests)
37 // Ignored by httpfetch_sync
40 // Some number that identifies the request
41 // (when the same caller issues multiple httpfetch_async calls)
42 unsigned long request_id;
44 // Timeout for the whole transfer, in milliseconds
47 // Timeout for the connection phase, in milliseconds
50 // Indicates if this is multipart/form-data or
51 // application/x-www-form-urlencoded. POST-only.
54 // POST fields. Fields are escaped properly.
55 // If this is empty a GET request is done instead.
56 StringMap post_fields;
58 // Raw POST data, overrides post_fields.
59 std::string post_data;
61 // If not empty, should contain entries such as "Accept: text/html"
62 std::vector<std::string> extra_headers;
65 std::string useragent;
70 struct HTTPFetchResult
76 // The caller and request_id from the corresponding HTTPFetchRequest.
78 unsigned long request_id;
85 caller(HTTPFETCH_DISCARD),
89 HTTPFetchResult(const HTTPFetchRequest &fetch_request) :
94 caller(fetch_request.caller),
95 request_id(fetch_request.request_id)
100 // Initializes the httpfetch module
101 void httpfetch_init(int parallel_limit);
103 // Stops the httpfetch thread and cleans up resources
104 void httpfetch_cleanup();
106 // Starts an asynchronous HTTP fetch request
107 void httpfetch_async(const HTTPFetchRequest &fetch_request);
109 // If any fetch for the given caller ID is complete, removes it from the
110 // result queue, sets the fetch result and returns true. Otherwise returns false.
111 bool httpfetch_async_get(unsigned long caller, HTTPFetchResult &fetch_result);
113 // Allocates a caller ID for httpfetch_async
114 // Not required if you want to set caller = HTTPFETCH_DISCARD
115 unsigned long httpfetch_caller_alloc();
117 // Allocates a non-predictable caller ID for httpfetch_async
118 unsigned long httpfetch_caller_alloc_secure();
120 // Frees a caller ID allocated with httpfetch_caller_alloc
121 // Note: This can be expensive, because the httpfetch thread is told
122 // to stop any ongoing fetches for the given caller.
123 void httpfetch_caller_free(unsigned long caller);
125 // Performs a synchronous HTTP request. This blocks and therefore should
126 // only be used from background threads.
127 void httpfetch_sync(const HTTPFetchRequest &fetch_request,
128 HTTPFetchResult &fetch_result);
131 #endif // !HTTPFETCH_HEADER