You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/advanced/configuration.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -172,7 +172,7 @@ RestSharp allows configuring `RestClient` using client options, as mentioned at
172
172
|`RemoteCertificateValidationCallback`| Custom function to validate the server certificate. Normally, it's used when the server uses a certificate that isn't trusted by default. |
173
173
|`BaseHost`| Value for the `Host` header sent with each request. |
174
174
|`CookieContainer`| Custom cookie container that will be shared among all calls made by the client. Normally not required as RestSharp handles cookies without using a client-level cookie container. |
175
-
|`MaxTimeout`| Client-level timeout in milliseconds. If the request timeout is also set, this value isn't used. |
175
+
|`Timeout`| Client-level timeout as `TimeSpan`. Used when the request timeout is not specified using `RestRequest.Timeout`. If not set, the default timeout is 100 seconds. Set to `Timeout.InfiniteTimeSpan` (or `TimeSpan.FromMilliseconds(-1)`) for no timeout. Setting to `TimeSpan.Zero` will cancel the request immediately. Negative values other than -1 millisecond will throw an exception.|
176
176
|`Encoding`| Default request encoding. Override it only if you don't use UTF-8. |
177
177
|`ThrowOnDeserializationError`| Forces the client to throw if it fails to deserialize the response. Remember that not all deserialization issues forces the serializer to throw. Default is `false`, so the client will return a `RestResponse` with deserialization exception details. Only relevant for `Execute...` functions. |
178
178
|`FailOnDeserializationError`| When set to `true`, if the client fails to deserialize the response, the response object will have status `Failed`, although the HTTP calls might have been successful. Default is `true`. |
@@ -213,7 +213,7 @@ Client options apply to all requests made by the client. Sometimes, you want to
213
213
|`Authenticator`| Overrides the client-level authenticator. |
214
214
|`Files`| Collection of file parameters, read-only. Use `AddFile` for adding files to the request. |
215
215
|`Method`| Request HTTP method, default is `GET`. Only needed when using `Execute` or `ExecuteAsync` as other functions like `ExecutePostAsync` will override the request method. |
216
-
|`TImeout`| Overrides the client-level timeout. |
216
+
|`Timeout`| Overrides the client-level timeout. If not set, uses the client timeout or the default of 100 seconds. Set to `Timeout.InfiniteTimeSpan` (or `TimeSpan.FromMilliseconds(-1)`) for no timeout. Setting to `TimeSpan.Zero` will cancel the request immediately. Negative values other than -1 millisecond will throw an exception.|
217
217
|`Resource`| Resource part of the remote endpoint URL. For example, when using the client-level base URL `https://localhost:5000/api` and `Resource` set to `weather`, the request will be sent to `https://localhost:5000/api/weather`. It can container resource placeholders to be used in combination with `AddUrlSegment`|
218
218
|`RequestFormat`| Identifies the request as JSON, XML, binary, or none. Rarely used because the client will set the request format based on the body type if functions like `AddJsonBody` or `AddXmlBody` are used. |
219
219
|`RootElement`| Used by the default deserializers to determine where to start deserializing from. Only supported for XML responses. Does not apply to requests. |
Copy file name to clipboardExpand all lines: src/RestSharp/Options/RestClientOptions.cs
+10-2Lines changed: 10 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -183,8 +183,16 @@ public RestClientOptions(string baseUrl) : this(new Uri(Ensure.NotEmptyString(ba
183
183
publicCookieContainer?CookieContainer{get;set;}
184
184
185
185
/// <summary>
186
-
/// Request duration. Used when the request timeout is not specified using <seealso cref="RestRequest.Timeout"/>,
187
-
/// </summary>
186
+
/// Request timeout duration. Used when the request timeout is not specified using <seealso cref="RestRequest.Timeout"/>.
187
+
/// If not set, the default timeout is 100 seconds.
188
+
/// </summary>
189
+
/// <remarks>
190
+
/// <list type="bullet">
191
+
/// <item><description>Set to <see cref="System.Threading.Timeout.InfiniteTimeSpan"/> (or <c>TimeSpan.FromMilliseconds(-1)</c>) for no timeout</description></item>
192
+
/// <item><description>Set to <see cref="TimeSpan.Zero"/> to cancel the request immediately</description></item>
193
+
/// <item><description>Negative values (other than -1 millisecond) will throw <see cref="ArgumentOutOfRangeException"/></description></item>
/// Custom request timeout. Overrides <see cref="RestClientOptions.Timeout"/> if set.
135
+
/// If not set, uses the client-level timeout or the default of 100 seconds.
135
136
/// </summary>
137
+
/// <remarks>
138
+
/// <list type="bullet">
139
+
/// <item><description>Set to <see cref="System.Threading.Timeout.InfiniteTimeSpan"/> (or <c>TimeSpan.FromMilliseconds(-1)</c>) for no timeout</description></item>
140
+
/// <item><description>Set to <see cref="TimeSpan.Zero"/> to cancel the request immediately</description></item>
141
+
/// <item><description>Negative values (other than -1 millisecond) will throw <see cref="ArgumentOutOfRangeException"/></description></item>
0 commit comments