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
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
31 struct HTTPFetchRequest
35 // Identifies the caller (for asynchronous requests)
36 // Ignored by httpfetch_sync
39 // Some number that identifies the request
40 // (when the same caller issues multiple httpfetch_async calls)
41 unsigned long request_id;
43 // Timeout for the whole transfer, in milliseconds
46 // Timeout for the connection phase, in milliseconds
49 // POST data (should be application/x-www-form-urlencoded
50 // unless a Content-Type header is specified in extra_headers)
51 // If this is empty a GET request is done instead.
52 std::string post_fields;
54 // If not empty, should contain entries such as "Accept: text/html"
55 std::vector<std::string> extra_headers;
60 caller = HTTPFETCH_DISCARD;
67 struct HTTPFetchResult
73 // The caller and request_id from the corresponding HTTPFetchRequest.
75 unsigned long request_id;
83 caller = HTTPFETCH_DISCARD;
87 HTTPFetchResult(const HTTPFetchRequest &fetchrequest)
93 caller = fetchrequest.caller;
94 request_id = fetchrequest.request_id;
98 // Initializes the httpfetch module
99 void httpfetch_init(int parallel_limit);
101 // Stops the httpfetch thread and cleans up resources
102 void httpfetch_cleanup();
104 // Starts an asynchronous HTTP fetch request
105 void httpfetch_async(const HTTPFetchRequest &fetchrequest);
107 // If any fetch for the given caller ID is complete, removes it from the
108 // result queue, sets fetchresult and returns true. Otherwise returns false.
109 bool httpfetch_async_get(unsigned long caller, HTTPFetchResult &fetchresult);
111 // Allocates a caller ID for httpfetch_async
112 // Not required if you want to set caller = HTTPFETCH_DISCARD
113 unsigned long httpfetch_caller_alloc();
115 // Frees a caller ID allocated with httpfetch_caller_alloc
116 // Note: This can be expensive, because the httpfetch thread is told
117 // to stop any ongoing fetches for the given caller.
118 void httpfetch_caller_free(unsigned long caller);
120 // Performs a synchronous HTTP request. This blocks and therefore should
121 // only be used from background threads.
122 void httpfetch_sync(const HTTPFetchRequest &fetchrequest,
123 HTTPFetchResult &fetchresult);
126 #endif // !HTTPFETCH_HEADER