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
28 // Can be used in place of "caller" in asynchronous transfers to discard result
29 // (used as default value of "caller")
30 #define HTTPFETCH_DISCARD 0
31 #define HTTPFETCH_SYNC 1
33 struct HTTPFetchRequest
37 // Identifies the caller (for asynchronous requests)
38 // Ignored by httpfetch_sync
41 // Some number that identifies the request
42 // (when the same caller issues multiple httpfetch_async calls)
43 unsigned long request_id;
45 // Timeout for the whole transfer, in milliseconds
48 // Timeout for the connection phase, in milliseconds
51 // Indicates if this is multipart/form-data or
52 // application/x-www-form-urlencoded. POST-only.
55 // POST fields. Fields are escaped properly.
56 // If this is empty a GET request is done instead.
57 std::map<std::string, std::string> post_fields;
59 // Raw POST data, overrides post_fields.
60 std::string post_data;
62 // If not empty, should contain entries such as "Accept: text/html"
63 std::vector<std::string> extra_headers;
66 std::string useragent;
71 struct HTTPFetchResult
77 // The caller and request_id from the corresponding HTTPFetchRequest.
79 unsigned long request_id;
87 caller = HTTPFETCH_DISCARD;
91 HTTPFetchResult(const HTTPFetchRequest &fetch_request)
97 caller = fetch_request.caller;
98 request_id = fetch_request.request_id;
103 // Initializes the httpfetch module
104 void httpfetch_init(int parallel_limit);
106 // Stops the httpfetch thread and cleans up resources
107 void httpfetch_cleanup();
109 // Starts an asynchronous HTTP fetch request
110 void httpfetch_async(const HTTPFetchRequest &fetch_request);
112 // If any fetch for the given caller ID is complete, removes it from the
113 // result queue, sets the fetch result and returns true. Otherwise returns false.
114 bool httpfetch_async_get(unsigned long caller, HTTPFetchResult &fetch_result);
116 // Allocates a caller ID for httpfetch_async
117 // Not required if you want to set caller = HTTPFETCH_DISCARD
118 unsigned long httpfetch_caller_alloc();
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