5 // Marek Safar <marek.safar@gmail.com>
7 // Copyright (C) 2011 Xamarin Inc (http://www.xamarin.com)
9 // Permission is hereby granted, free of charge, to any person obtaining
10 // a copy of this software and associated documentation files (the
11 // "Software"), to deal in the Software without restriction, including
12 // without limitation the rights to use, copy, modify, merge, publish,
13 // distribute, sublicense, and/or sell copies of the Software, and to
14 // permit persons to whom the Software is furnished to do so, subject to
15 // the following conditions:
17 // The above copyright notice and this permission notice shall be
18 // included in all copies or substantial portions of the Software.
20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29 using System.Threading;
30 using System.Net.Http.Headers;
31 using System.Threading.Tasks;
34 namespace System.Net.Http
36 public class HttpClient : HttpMessageInvoker
38 static readonly TimeSpan TimeoutDefault = TimeSpan.FromSeconds (100);
41 CancellationTokenSource cts;
43 HttpRequestHeaders headers;
48 : this (new HttpClientHandler (), true)
52 public HttpClient (HttpMessageHandler handler)
53 : this (handler, true)
57 public HttpClient (HttpMessageHandler handler, bool disposeHandler)
58 : base (handler, disposeHandler)
60 buffer_size = int.MaxValue;
61 timeout = TimeoutDefault;
62 cts = new CancellationTokenSource ();
65 public Uri BaseAddress {
74 public HttpRequestHeaders DefaultRequestHeaders {
76 return headers ?? (headers = new HttpRequestHeaders ());
80 public long MaxResponseContentBufferSize {
86 throw new ArgumentOutOfRangeException ();
92 public TimeSpan Timeout {
97 if (value != System.Threading.Timeout.InfiniteTimeSpan && value < TimeSpan.Zero)
98 throw new ArgumentOutOfRangeException ();
104 public void CancelPendingRequests ()
106 // Cancel only any already running requests not any new request after this cancellation
107 using (var c = Interlocked.Exchange (ref cts, new CancellationTokenSource ()))
111 protected override void Dispose (bool disposing)
113 if (disposing && !disposed) {
119 base.Dispose (disposing);
122 public Task<HttpResponseMessage> DeleteAsync (string requestUri)
124 return SendAsync (new HttpRequestMessage (HttpMethod.Delete, requestUri));
127 public Task<HttpResponseMessage> DeleteAsync (string requestUri, CancellationToken cancellationToken)
129 return SendAsync (new HttpRequestMessage (HttpMethod.Delete, requestUri), cancellationToken);
132 public Task<HttpResponseMessage> DeleteAsync (Uri requestUri)
134 return SendAsync (new HttpRequestMessage (HttpMethod.Delete, requestUri));
137 public Task<HttpResponseMessage> DeleteAsync (Uri requestUri, CancellationToken cancellationToken)
139 return SendAsync (new HttpRequestMessage (HttpMethod.Delete, requestUri), cancellationToken);
142 public Task<HttpResponseMessage> GetAsync (string requestUri)
144 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri));
147 public Task<HttpResponseMessage> GetAsync (string requestUri, CancellationToken cancellationToken)
149 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri), cancellationToken);
152 public Task<HttpResponseMessage> GetAsync (string requestUri, HttpCompletionOption completionOption)
154 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri), completionOption);
157 public Task<HttpResponseMessage> GetAsync (string requestUri, HttpCompletionOption completionOption, CancellationToken cancellationToken)
159 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri), completionOption, cancellationToken);
162 public Task<HttpResponseMessage> GetAsync (Uri requestUri)
164 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri));
167 public Task<HttpResponseMessage> GetAsync (Uri requestUri, CancellationToken cancellationToken)
169 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri), cancellationToken);
172 public Task<HttpResponseMessage> GetAsync (Uri requestUri, HttpCompletionOption completionOption)
174 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri), completionOption);
177 public Task<HttpResponseMessage> GetAsync (Uri requestUri, HttpCompletionOption completionOption, CancellationToken cancellationToken)
179 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri), completionOption, cancellationToken);
182 public Task<HttpResponseMessage> PostAsync (string requestUri, HttpContent content)
184 return SendAsync (new HttpRequestMessage (HttpMethod.Post, requestUri) { Content = content });
187 public Task<HttpResponseMessage> PostAsync (string requestUri, HttpContent content, CancellationToken cancellationToken)
189 return SendAsync (new HttpRequestMessage (HttpMethod.Post, requestUri) { Content = content }, cancellationToken);
192 public Task<HttpResponseMessage> PostAsync (Uri requestUri, HttpContent content)
194 return SendAsync (new HttpRequestMessage (HttpMethod.Post, requestUri) { Content = content });
197 public Task<HttpResponseMessage> PostAsync (Uri requestUri, HttpContent content, CancellationToken cancellationToken)
199 return SendAsync (new HttpRequestMessage (HttpMethod.Post, requestUri) { Content = content }, cancellationToken);
202 public Task<HttpResponseMessage> PutAsync (Uri requestUri, HttpContent content)
204 return SendAsync (new HttpRequestMessage (HttpMethod.Put, requestUri) { Content = content });
207 public Task<HttpResponseMessage> PutAsync (Uri requestUri, HttpContent content, CancellationToken cancellationToken)
209 return SendAsync (new HttpRequestMessage (HttpMethod.Put, requestUri) { Content = content }, cancellationToken);
212 public Task<HttpResponseMessage> PutAsync (string requestUri, HttpContent content)
214 return SendAsync (new HttpRequestMessage (HttpMethod.Put, requestUri) { Content = content });
217 public Task<HttpResponseMessage> PutAsync (string requestUri, HttpContent content, CancellationToken cancellationToken)
219 return SendAsync (new HttpRequestMessage (HttpMethod.Put, requestUri) { Content = content }, cancellationToken);
222 public Task<HttpResponseMessage> SendAsync (HttpRequestMessage request)
224 return SendAsync (request, HttpCompletionOption.ResponseContentRead, CancellationToken.None);
227 public Task<HttpResponseMessage> SendAsync (HttpRequestMessage request, HttpCompletionOption completionOption)
229 return SendAsync (request, completionOption, CancellationToken.None);
232 public override Task<HttpResponseMessage> SendAsync (HttpRequestMessage request, CancellationToken cancellationToken)
234 return SendAsync (request, HttpCompletionOption.ResponseContentRead, cancellationToken);
237 public Task<HttpResponseMessage> SendAsync (HttpRequestMessage request, HttpCompletionOption completionOption, CancellationToken cancellationToken)
240 throw new ArgumentNullException ("request");
242 if (request.SetIsUsed ())
243 throw new InvalidOperationException ("Cannot send the same request message multiple times");
245 if (request.RequestUri == null) {
246 if (base_address == null)
247 throw new InvalidOperationException ("The request URI must either be an absolute URI or BaseAddress must be set");
249 request.RequestUri = base_address;
250 } else if (!request.RequestUri.IsAbsoluteUri) {
251 if (base_address == null)
252 throw new InvalidOperationException ("The request URI must either be an absolute URI or BaseAddress must be set");
254 request.RequestUri = new Uri (base_address, request.RequestUri);
257 if (headers != null) {
258 request.Headers.AddHeaders (headers);
261 return SendAsyncWorker (request, completionOption, cancellationToken);
264 async Task<HttpResponseMessage> SendAsyncWorker (HttpRequestMessage request, HttpCompletionOption completionOption, CancellationToken cancellationToken)
266 using (var lcts = CancellationTokenSource.CreateLinkedTokenSource (cts.Token, cancellationToken)) {
267 lcts.CancelAfter (timeout);
269 var task = base.SendAsync (request, lcts.Token);
271 throw new InvalidOperationException ("Handler failed to return a value");
273 var response = await task.ConfigureAwait (false);
274 if (response == null)
275 throw new InvalidOperationException ("Handler failed to return a response");
278 // Read the content when default HttpCompletionOption.ResponseContentRead is set
280 if (response.Content != null && (completionOption & HttpCompletionOption.ResponseHeadersRead) == 0) {
281 await response.Content.LoadIntoBufferAsync (MaxResponseContentBufferSize).ConfigureAwait (false);
288 public async Task<byte[]> GetByteArrayAsync (string requestUri)
290 using (var resp = await GetAsync (requestUri, HttpCompletionOption.ResponseContentRead).ConfigureAwait (false)) {
291 resp.EnsureSuccessStatusCode ();
292 return await resp.Content.ReadAsByteArrayAsync ().ConfigureAwait (false);
296 public async Task<byte[]> GetByteArrayAsync (Uri requestUri)
298 using (var resp = await GetAsync (requestUri, HttpCompletionOption.ResponseContentRead).ConfigureAwait (false)) {
299 resp.EnsureSuccessStatusCode ();
300 return await resp.Content.ReadAsByteArrayAsync ().ConfigureAwait (false);
304 public async Task<Stream> GetStreamAsync (string requestUri)
306 var resp = await GetAsync (requestUri, HttpCompletionOption.ResponseContentRead).ConfigureAwait (false);
307 resp.EnsureSuccessStatusCode ();
308 return await resp.Content.ReadAsStreamAsync ().ConfigureAwait (false);
311 public async Task<Stream> GetStreamAsync (Uri requestUri)
313 var resp = await GetAsync (requestUri, HttpCompletionOption.ResponseContentRead).ConfigureAwait (false);
314 resp.EnsureSuccessStatusCode ();
315 return await resp.Content.ReadAsStreamAsync ().ConfigureAwait (false);
318 public async Task<string> GetStringAsync (string requestUri)
320 using (var resp = await GetAsync (requestUri, HttpCompletionOption.ResponseContentRead).ConfigureAwait (false)) {
321 resp.EnsureSuccessStatusCode ();
322 return await resp.Content.ReadAsStringAsync ().ConfigureAwait (false);
326 public async Task<string> GetStringAsync (Uri requestUri)
328 using (var resp = await GetAsync (requestUri, HttpCompletionOption.ResponseContentRead).ConfigureAwait (false)) {
329 resp.EnsureSuccessStatusCode ();
330 return await resp.Content.ReadAsStringAsync ().ConfigureAwait (false);