Add possibility to configure GitHubClient timeout (octokit#963)

pmiossec · Oct 17, 2017 · 2443dbb · 2443dbb
1 parent 0f0a0dc
commit 2443dbb
Show file tree

Hide file tree

Showing 5 changed files with 76 additions and 0 deletions.
diff --git a/Octokit/GitHubClient.cs b/Octokit/GitHubClient.cs
@@ -99,6 +99,25 @@ public GitHubClient(IConnection connection)
             Reaction = new ReactionsClient(apiConnection);
         }
 
+        /// <summary>
+        /// Set the timespan to wait before the requests to GitHub api times out.
+        ///
+        /// Exceptions:
+        ///   T:System.ArgumentOutOfRangeException:
+        ///     The timeout specified is less than or equal to zero and is not System.Threading.Timeout.InfiniteTimeSpan.
+        ///
+        ///   T:System.InvalidOperationException:
+        ///     An operation has already been started on the current instance.
+        ///
+        ///   T:System.ObjectDisposedException:
+        ///     The current instance has been disposed.
+        /// </summary>
+        /// <param name="timeout">the timespan to wait before a request to GitHub api times out</param>
+        void SetRequestsTimeout(TimeSpan timeout)
+        {
+            Connection.SetRequestsTimeout(timeout);
+        }
+
         /// <summary>
         /// Gets the latest API Info - this will be null if no API calls have been made
         /// </summary>

diff --git a/Octokit/Http/Connection.cs b/Octokit/Http/Connection.cs
@@ -752,5 +752,24 @@ static string GetVersionInformation()
 
             return _versionInformation;
         }
+
+        /// <summary>
+        /// Set the timespan to wait before the requests to GitHub api times out.
+        ///
+        /// Exceptions:
+        ///   T:System.ArgumentOutOfRangeException:
+        ///     The timeout specified is less than or equal to zero and is not System.Threading.Timeout.InfiniteTimeSpan.
+        ///
+        ///   T:System.InvalidOperationException:
+        ///     An operation has already been started on the current instance.
+        ///
+        ///   T:System.ObjectDisposedException:
+        ///     The current instance has been disposed.
+        /// </summary>
+        /// <param name="timeout">the timespan to wait before a request to GitHub api times out</param>
+        public void SetRequestsTimeout(TimeSpan timeout)
+        {
+            _httpClient.SetRequestsTimeout(timeout);
+        }
     }
 }
diff --git a/Octokit/Http/HttpClientAdapter.cs b/Octokit/Http/HttpClientAdapter.cs
@@ -264,6 +264,11 @@ public static async Task<HttpRequestMessage> CloneHttpRequestMessageAsync(HttpRe
 
             return newRequest;
         }
+
+        public void SetRequestsTimeout(TimeSpan timeout)
+        {
+            _http.Timeout = timeout;
+        }
     }
 
     internal class RedirectHandler : DelegatingHandler

diff --git a/Octokit/Http/IConnection.cs b/Octokit/Http/IConnection.cs
@@ -292,5 +292,21 @@ public interface IConnection : IApiInfoProvider
         /// the default <see cref="InMemoryCredentialStore"/> with just these credentials.
         /// </remarks>
         Credentials Credentials { get; set; }
+
+        /// <summary>
+        /// Set the timespan to wait before the requests to GitHub api times out.
+        ///
+        /// Exceptions:
+        ///   T:System.ArgumentOutOfRangeException:
+        ///     The timeout specified is less than or equal to zero and is not System.Threading.Timeout.InfiniteTimeSpan.
+        ///
+        ///   T:System.InvalidOperationException:
+        ///     An operation has already been started on the current instance.
+        ///
+        ///   T:System.ObjectDisposedException:
+        ///     The current instance has been disposed.
+        /// </summary>
+        /// <param name="timeout">the timespan to wait before a request to GitHub api times out</param>
+        void SetRequestsTimeout(TimeSpan timeout);
     }
 }
diff --git a/Octokit/Http/IHttpClient.cs b/Octokit/Http/IHttpClient.cs
@@ -19,5 +19,22 @@ public interface IHttpClient : IDisposable
         /// <param name="cancellationToken">Used to cancel the request</param>
         /// <returns>A <see cref="Task" /> of <see cref="IResponse"/></returns>
         Task<IResponse> Send(IRequest request, CancellationToken cancellationToken);
+
+
+        /// <summary>
+        /// Set the timespan to wait before the requests to GitHub api times out.
+        ///
+        /// Exceptions:
+        ///   T:System.ArgumentOutOfRangeException:
+        ///     The timeout specified is less than or equal to zero and is not System.Threading.Timeout.InfiniteTimeSpan.
+        ///
+        ///   T:System.InvalidOperationException:
+        ///     An operation has already been started on the current instance.
+        ///
+        ///   T:System.ObjectDisposedException:
+        ///     The current instance has been disposed.
+        /// </summary>
+        /// <param name="timeout">the timespan to wait before a request to GitHub api times out</param>
+        void SetRequestsTimeout(TimeSpan timeout);
     }
 }