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 partial class HttpClient : HttpMessageInvoker
38 static readonly TimeSpan TimeoutDefault = TimeSpan.FromSeconds (100);
41 CancellationTokenSource cts;
43 HttpRequestHeaders headers;
49 : this (new HttpClientHandler (), true)
54 public HttpClient (HttpMessageHandler handler)
55 : this (handler, true)
59 public HttpClient (HttpMessageHandler handler, bool disposeHandler)
60 : base (handler, disposeHandler)
62 buffer_size = int.MaxValue;
63 timeout = TimeoutDefault;
64 cts = new CancellationTokenSource ();
67 public Uri BaseAddress {
76 public HttpRequestHeaders DefaultRequestHeaders {
78 return headers ?? (headers = new HttpRequestHeaders ());
82 public long MaxResponseContentBufferSize {
88 throw new ArgumentOutOfRangeException ();
94 public TimeSpan Timeout {
99 if (value != System.Threading.Timeout.InfiniteTimeSpan && value < TimeSpan.Zero)
100 throw new ArgumentOutOfRangeException ();
106 public void CancelPendingRequests ()
108 // Cancel only any already running requests not any new request after this cancellation
109 using (var c = Interlocked.Exchange (ref cts, new CancellationTokenSource ()))
113 protected override void Dispose (bool disposing)
115 if (disposing && !disposed) {
121 base.Dispose (disposing);
124 public Task<HttpResponseMessage> DeleteAsync (string requestUri)
126 return SendAsync (new HttpRequestMessage (HttpMethod.Delete, requestUri));
129 public Task<HttpResponseMessage> DeleteAsync (string requestUri, CancellationToken cancellationToken)
131 return SendAsync (new HttpRequestMessage (HttpMethod.Delete, requestUri), cancellationToken);
134 public Task<HttpResponseMessage> DeleteAsync (Uri requestUri)
136 return SendAsync (new HttpRequestMessage (HttpMethod.Delete, requestUri));
139 public Task<HttpResponseMessage> DeleteAsync (Uri requestUri, CancellationToken cancellationToken)
141 return SendAsync (new HttpRequestMessage (HttpMethod.Delete, requestUri), cancellationToken);
144 public Task<HttpResponseMessage> GetAsync (string requestUri)
146 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri));
149 public Task<HttpResponseMessage> GetAsync (string requestUri, CancellationToken cancellationToken)
151 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri), cancellationToken);
154 public Task<HttpResponseMessage> GetAsync (string requestUri, HttpCompletionOption completionOption)
156 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri), completionOption);
159 public Task<HttpResponseMessage> GetAsync (string requestUri, HttpCompletionOption completionOption, CancellationToken cancellationToken)
161 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri), completionOption, cancellationToken);
164 public Task<HttpResponseMessage> GetAsync (Uri requestUri)
166 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri));
169 public Task<HttpResponseMessage> GetAsync (Uri requestUri, CancellationToken cancellationToken)
171 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri), cancellationToken);
174 public Task<HttpResponseMessage> GetAsync (Uri requestUri, HttpCompletionOption completionOption)
176 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri), completionOption);
179 public Task<HttpResponseMessage> GetAsync (Uri requestUri, HttpCompletionOption completionOption, CancellationToken cancellationToken)
181 return SendAsync (new HttpRequestMessage (HttpMethod.Get, requestUri), completionOption, cancellationToken);
184 public Task<HttpResponseMessage> PostAsync (string requestUri, HttpContent content)
186 return SendAsync (new HttpRequestMessage (HttpMethod.Post, requestUri) { Content = content });
189 public Task<HttpResponseMessage> PostAsync (string requestUri, HttpContent content, CancellationToken cancellationToken)
191 return SendAsync (new HttpRequestMessage (HttpMethod.Post, requestUri) { Content = content }, cancellationToken);
194 public Task<HttpResponseMessage> PostAsync (Uri requestUri, HttpContent content)
196 return SendAsync (new HttpRequestMessage (HttpMethod.Post, requestUri) { Content = content });
199 public Task<HttpResponseMessage> PostAsync (Uri requestUri, HttpContent content, CancellationToken cancellationToken)
201 return SendAsync (new HttpRequestMessage (HttpMethod.Post, requestUri) { Content = content }, cancellationToken);
204 public Task<HttpResponseMessage> PutAsync (Uri requestUri, HttpContent content)
206 return SendAsync (new HttpRequestMessage (HttpMethod.Put, requestUri) { Content = content });
209 public Task<HttpResponseMessage> PutAsync (Uri requestUri, HttpContent content, CancellationToken cancellationToken)
211 return SendAsync (new HttpRequestMessage (HttpMethod.Put, requestUri) { Content = content }, cancellationToken);
214 public Task<HttpResponseMessage> PutAsync (string requestUri, HttpContent content)
216 return SendAsync (new HttpRequestMessage (HttpMethod.Put, requestUri) { Content = content });
219 public Task<HttpResponseMessage> PutAsync (string requestUri, HttpContent content, CancellationToken cancellationToken)
221 return SendAsync (new HttpRequestMessage (HttpMethod.Put, requestUri) { Content = content }, cancellationToken);
224 public Task<HttpResponseMessage> SendAsync (HttpRequestMessage request)
226 return SendAsync (request, HttpCompletionOption.ResponseContentRead, CancellationToken.None);
229 public Task<HttpResponseMessage> SendAsync (HttpRequestMessage request, HttpCompletionOption completionOption)
231 return SendAsync (request, completionOption, CancellationToken.None);
234 public override Task<HttpResponseMessage> SendAsync (HttpRequestMessage request, CancellationToken cancellationToken)
236 return SendAsync (request, HttpCompletionOption.ResponseContentRead, cancellationToken);
239 public Task<HttpResponseMessage> SendAsync (HttpRequestMessage request, HttpCompletionOption completionOption, CancellationToken cancellationToken)
242 throw new ArgumentNullException ("request");
244 if (request.SetIsUsed ())
245 throw new InvalidOperationException ("Cannot send the same request message multiple times");
247 var uri = request.RequestUri;
249 if (base_address == null)
250 throw new InvalidOperationException ("The request URI must either be an absolute URI or BaseAddress must be set");
252 request.RequestUri = base_address;
253 } else if (!uri.IsAbsoluteUri || uri.Scheme == Uri.UriSchemeFile && uri.OriginalString.StartsWith ("/", StringComparison.Ordinal)) {
254 if (base_address == null)
255 throw new InvalidOperationException ("The request URI must either be an absolute URI or BaseAddress must be set");
257 request.RequestUri = new Uri (base_address, uri);
260 if (headers != null) {
261 request.Headers.AddHeaders (headers);
264 return SendAsyncWorker (request, completionOption, cancellationToken);
267 async Task<HttpResponseMessage> SendAsyncWorker (HttpRequestMessage request, HttpCompletionOption completionOption, CancellationToken cancellationToken)
269 using (var lcts = CancellationTokenSource.CreateLinkedTokenSource (cts.Token, cancellationToken)) {
270 lcts.CancelAfter (timeout);
272 var task = base.SendAsync (request, lcts.Token);
274 throw new InvalidOperationException ("Handler failed to return a value");
276 var response = await task.ConfigureAwait (false);
277 if (response == null)
278 throw new InvalidOperationException ("Handler failed to return a response");
281 // Read the content when default HttpCompletionOption.ResponseContentRead is set
283 if (response.Content != null && (completionOption & HttpCompletionOption.ResponseHeadersRead) == 0) {
284 await response.Content.LoadIntoBufferAsync (MaxResponseContentBufferSize).ConfigureAwait (false);
291 public async Task<byte[]> GetByteArrayAsync (string requestUri)
293 using (var resp = await GetAsync (requestUri, HttpCompletionOption.ResponseContentRead).ConfigureAwait (false)) {
294 resp.EnsureSuccessStatusCode ();
295 return await resp.Content.ReadAsByteArrayAsync ().ConfigureAwait (false);
299 public async Task<byte[]> GetByteArrayAsync (Uri requestUri)
301 using (var resp = await GetAsync (requestUri, HttpCompletionOption.ResponseContentRead).ConfigureAwait (false)) {
302 resp.EnsureSuccessStatusCode ();
303 return await resp.Content.ReadAsByteArrayAsync ().ConfigureAwait (false);
307 public async Task<Stream> GetStreamAsync (string requestUri)
309 var resp = await GetAsync (requestUri, HttpCompletionOption.ResponseHeadersRead).ConfigureAwait (false);
310 resp.EnsureSuccessStatusCode ();
311 return await resp.Content.ReadAsStreamAsync ().ConfigureAwait (false);
314 public async Task<Stream> GetStreamAsync (Uri requestUri)
316 var resp = await GetAsync (requestUri, HttpCompletionOption.ResponseHeadersRead).ConfigureAwait (false);
317 resp.EnsureSuccessStatusCode ();
318 return await resp.Content.ReadAsStreamAsync ().ConfigureAwait (false);
321 public async Task<string> GetStringAsync (string requestUri)
323 using (var resp = await GetAsync (requestUri, HttpCompletionOption.ResponseContentRead).ConfigureAwait (false)) {
324 resp.EnsureSuccessStatusCode ();
325 return await resp.Content.ReadAsStringAsync ().ConfigureAwait (false);
329 public async Task<string> GetStringAsync (Uri requestUri)
331 using (var resp = await GetAsync (requestUri, HttpCompletionOption.ResponseContentRead).ConfigureAwait (false)) {
332 resp.EnsureSuccessStatusCode ();
333 return await resp.Content.ReadAsStringAsync ().ConfigureAwait (false);