Skip to content

Commit

Permalink
spec: Fix mismatch of HTTP retry and request timeouts
Browse files Browse the repository at this point in the history
Fixes #274
  • Loading branch information
mattheworiordan committed Feb 22, 2017
1 parent 2e3acd0 commit 3f75377
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions content/client-lib-development-guide/features.textile
Original file line number Diff line number Diff line change
Expand Up @@ -1055,9 +1055,9 @@ h4. ClientOptions
*** @(TO3l2)@ @suspendedRetryTimeout@ integer - default 30,000 (30s). When the connection enters the @SUSPENDED@ state, after this delay in milliseconds, if the state is still @SUSPENDED@, the client library will attempt to reconnect automatically
*** @(TO3l7)@ @channelRetryTimeout@ integer - default 15,000 (15s). When a channel becomes @SUSPENDED@ following a server initiated @DETACHED@, after this delay in milliseconds, if the channel is still @SUSPENDED@ and the connection is @CONNECTED@, the client library will attempt to re-attach the channel automatically
*** @(TO3l3)@ @httpOpenTimeout@ integer - default 4,000 (4s). Timeout for opening the connection, available in the client library if supported by the transport
*** @(TO3l4)@ @httpRequestTimeout@ integer - default 15,000 (15s). Timeout for any single HTTP request and response
*** @(TO3l4)@ @httpRequestTimeout@ integer - default 10,000 (10s). Timeout for any single HTTP request and response
*** @(TO3l5)@ @httpMaxRetryCount@ integer - default 3. Max number of fallback hosts to use as a fallback when an HTTP request to the primary host is unreachable or indicates that it is unserviceable
*** @(TO3l6)@ @httpMaxRetryDuration@ integer - default 10,000 (10s). Max elapsed time in which fallback host retries for HTTP requests will be attempted i.e. if the first default host attempt takes 5s, and then the subsequent fallback retry attempt takes 7s, no further fallback host attempts will be made as the total elapsed time of 12s exceeds the default 10s limit
*** @(TO3l6)@ @httpMaxRetryDuration@ integer - default 15,000 (15s). Max elapsed time in which fallback host retries for HTTP requests will be attempted i.e. if the first default host attempt takes 7s, and then the subsequent fallback retry attempt takes 10s, no further fallback host attempts will be made as the total elapsed time of 17s exceeds the default 15s limit

h4(#token-params). TokenParams
* @(TK1)@ A class providing parameters of a token request. These params are used when invoking @Auth#authorize@, @Auth#requestToken@ and @Auth#createTokenRequest@
Expand Down Expand Up @@ -1175,9 +1175,9 @@ class ClientOptions:
suspendedRetryTimeout: Duration default 30s // RTN14d, TO312
channelRetryTimeout: Duration default 15s // RTL13b, TO3l7
httpOpenTimeout: Duration default 4s // TO313
httpRequestTimeout: Duration default 15s // TO314
httpRequestTimeout: Duration default 10s // TO314
httpMaxRetryCount: Int default 3 // TO315
httpMaxRetryDuration: Duration default 10s // TO315
httpMaxRetryDuration: Duration default 15s // TO315

class AuthOptions: // RSA8e
authCallback: (() -> io (String | TokenDetails | TokenRequest))? // RSA4a, RSA4, TO3j5, AO2b
Expand Down

0 comments on commit 3f75377

Please sign in to comment.