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 cancellation_token;
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;
64 public Uri BaseAddress {
73 public HttpRequestHeaders DefaultRequestHeaders {
75 return headers ?? (headers = new HttpRequestHeaders ());
79 public long MaxResponseContentBufferSize {
85 throw new ArgumentOutOfRangeException ();
91 public TimeSpan Timeout {
96 if (value != System.Threading.Timeout.InfiniteTimeSpan && value < TimeSpan.Zero)
97 throw new ArgumentOutOfRangeException ();
103 public void CancelPendingRequests ()
105 if (cancellation_token != null)
106 cancellation_token.Cancel ();
108 cancellation_token = new CancellationTokenSource ();
111 protected override void Dispose (bool disposing)
113 if (disposing && !disposed) {
116 if (cancellation_token != null)
117 cancellation_token.Dispose ();
120 base.Dispose (disposing);
123 public Task<HttpResponseMessage> DeleteAsync (string requestUri)
125 return SendAsync (new HttpRequestMessage (HttpMethod.Delete, requestUri));
128 public Task<HttpResponseMessage> DeleteAsync (string requestUri, CancellationToken cancellationToken)
130 return SendAsync (new HttpRequestMessage (HttpMethod.Delete, requestUri), cancellationToken);
133 public Task<HttpResponseMessage> DeleteAsync (Uri requestUri)
135 return SendAsync (new HttpRequestMessage (HttpMethod.Delete, requestUri));
138 public Task<HttpResponseMessage> DeleteAsync (Uri requestUri, CancellationToken cancellationToken)
140 return SendAsync (new HttpRequestMessage (HttpMethod.Delete, requestUri), cancellationToken);
143 public Task<HttpResponseMessage> GetAsync (string requestUri)
145 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri));
148 public Task<HttpResponseMessage> GetAsync (string requestUri, CancellationToken cancellationToken)
150 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri));
153 public Task<HttpResponseMessage> GetAsync (string requestUri, HttpCompletionOption completionOption)
155 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri), completionOption);
158 public Task<HttpResponseMessage> GetAsync (string requestUri, HttpCompletionOption completionOption, CancellationToken cancellationToken)
160 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri), completionOption, cancellationToken);
163 public Task<HttpResponseMessage> GetAsync (Uri requestUri)
165 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri));
168 public Task<HttpResponseMessage> GetAsync (Uri requestUri, CancellationToken cancellationToken)
170 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri), cancellationToken);
173 public Task<HttpResponseMessage> GetAsync (Uri requestUri, HttpCompletionOption completionOption)
175 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri), completionOption);
178 public Task<HttpResponseMessage> GetAsync (Uri requestUri, HttpCompletionOption completionOption, CancellationToken cancellationToken)
180 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri), completionOption, cancellationToken);
183 public Task<HttpResponseMessage> PostAsync (string requestUri, HttpContent content)
185 return SendAsync (new HttpRequestMessage (HttpMethod.Post, requestUri) { Content = content });
188 public Task<HttpResponseMessage> PostAsync (string requestUri, HttpContent content, CancellationToken cancellationToken)
190 return SendAsync (new HttpRequestMessage (HttpMethod.Post, requestUri) { Content = content }, cancellationToken);
193 public Task<HttpResponseMessage> PostAsync (Uri requestUri, HttpContent content)
195 return SendAsync (new HttpRequestMessage (HttpMethod.Post, requestUri) { Content = content });
198 public Task<HttpResponseMessage> PostAsync (Uri requestUri, HttpContent content, CancellationToken cancellationToken)
200 return SendAsync (new HttpRequestMessage (HttpMethod.Post, requestUri) { Content = content }, cancellationToken);
203 public Task<HttpResponseMessage> PutAsync (Uri requestUri, HttpContent content)
205 return SendAsync (new HttpRequestMessage (HttpMethod.Put, requestUri) { Content = content });
208 public Task<HttpResponseMessage> PutAsync (Uri requestUri, HttpContent content, CancellationToken cancellationToken)
210 return SendAsync (new HttpRequestMessage (HttpMethod.Put, requestUri) { Content = content }, cancellationToken);
213 public Task<HttpResponseMessage> PutAsync (string requestUri, HttpContent content)
215 return SendAsync (new HttpRequestMessage (HttpMethod.Put, requestUri) { Content = content });
218 public Task<HttpResponseMessage> PutAsync (string requestUri, HttpContent content, CancellationToken cancellationToken)
220 return SendAsync (new HttpRequestMessage (HttpMethod.Put, requestUri) { Content = content }, cancellationToken);
223 public Task<HttpResponseMessage> SendAsync (HttpRequestMessage request)
225 return SendAsync (request, HttpCompletionOption.ResponseContentRead, CancellationToken.None);
228 public Task<HttpResponseMessage> SendAsync (HttpRequestMessage request, HttpCompletionOption completionOption)
230 return SendAsync (request, completionOption, CancellationToken.None);
233 public override Task<HttpResponseMessage> SendAsync (HttpRequestMessage request, CancellationToken cancellationToken)
235 return SendAsync (request, HttpCompletionOption.ResponseContentRead, cancellationToken);
238 public Task<HttpResponseMessage> SendAsync (HttpRequestMessage request, HttpCompletionOption completionOption, CancellationToken cancellationToken)
241 throw new ArgumentNullException ("request");
243 if (request.SetIsUsed ())
244 throw new InvalidOperationException ("Cannot send the same request message multiple times");
246 if (request.RequestUri == null) {
247 if (base_address == null)
248 throw new InvalidOperationException ("The request URI must either be an absolute URI or BaseAddress must be set");
250 request.RequestUri = base_address;
251 } else if (!request.RequestUri.IsAbsoluteUri) {
252 if (base_address == null)
253 throw new InvalidOperationException ("The request URI must either be an absolute URI or BaseAddress must be set");
255 request.RequestUri = new Uri (base_address, request.RequestUri);
258 if (headers != null) {
259 request.Headers.AddHeaders (headers);
262 return SendAsyncWorker (request, completionOption, cancellationToken);
265 async Task<HttpResponseMessage> SendAsyncWorker (HttpRequestMessage request, HttpCompletionOption completionOption, CancellationToken cancellationToken)
268 if (cancellation_token == null)
269 cancellation_token = new CancellationTokenSource ();
271 using (var cts = CancellationTokenSource.CreateLinkedTokenSource (cancellation_token.Token, cancellationToken)) {
272 cts.CancelAfter (timeout);
274 var task = base.SendAsync (request, cts.Token);
276 throw new InvalidOperationException ("Handler failed to return a value");
278 var response = await task.ConfigureAwait (false);
279 if (response == null)
280 throw new InvalidOperationException ("Handler failed to return a response");
283 // Read the content when default HttpCompletionOption.ResponseContentRead is set
285 if (response.Content != null && (completionOption & HttpCompletionOption.ResponseHeadersRead) == 0) {
286 await response.Content.LoadIntoBufferAsync (MaxResponseContentBufferSize).ConfigureAwait (false);
292 cancellation_token.Dispose ();
293 cancellation_token = null;
297 public async Task<byte[]> GetByteArrayAsync (string requestUri)
299 using (var resp = await GetAsync (requestUri, HttpCompletionOption.ResponseContentRead).ConfigureAwait (false)) {
300 resp.EnsureSuccessStatusCode ();
301 return await resp.Content.ReadAsByteArrayAsync ().ConfigureAwait (false);
305 public async Task<byte[]> GetByteArrayAsync (Uri requestUri)
307 using (var resp = await GetAsync (requestUri, HttpCompletionOption.ResponseContentRead).ConfigureAwait (false)) {
308 resp.EnsureSuccessStatusCode ();
309 return await resp.Content.ReadAsByteArrayAsync ().ConfigureAwait (false);
313 public async Task<Stream> GetStreamAsync (string requestUri)
315 var resp = await GetAsync (requestUri, HttpCompletionOption.ResponseContentRead).ConfigureAwait (false);
316 resp.EnsureSuccessStatusCode ();
317 return await resp.Content.ReadAsStreamAsync ().ConfigureAwait (false);
320 public async Task<Stream> GetStreamAsync (Uri requestUri)
322 var resp = await GetAsync (requestUri, HttpCompletionOption.ResponseContentRead).ConfigureAwait (false);
323 resp.EnsureSuccessStatusCode ();
324 return await resp.Content.ReadAsStreamAsync ().ConfigureAwait (false);
327 public async Task<string> GetStringAsync (string requestUri)
329 using (var resp = await GetAsync (requestUri, HttpCompletionOption.ResponseContentRead).ConfigureAwait (false)) {
330 resp.EnsureSuccessStatusCode ();
331 return await resp.Content.ReadAsStringAsync ().ConfigureAwait (false);
335 public async Task<string> GetStringAsync (Uri requestUri)
337 using (var resp = await GetAsync (requestUri, HttpCompletionOption.ResponseContentRead).ConfigureAwait (false)) {
338 resp.EnsureSuccessStatusCode ();
339 return await resp.Content.ReadAsStringAsync ().ConfigureAwait (false);