ridv/gorealis
1
0
Fork 0
Code Issues Pull requests Projects Releases 23 Packages Wiki Activity Actions

Added documentation as to how to handle a timeout on an API request.

Browse source
This commit is contained in:
Renan DelValle 2019-05-03 18:20:54 -07:00
parent 9ad2dde3e1
commit 5ff89046dc
No known key found for this signature in database
GPG key ID: C240AD6D6F443EC9
1 changed files with 16 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/leveraging-the-library.md
View file

@ -57,4 +57,19 @@ updateJob := realis.NewUpdateJob(job)
updateJob.InstanceCount(1)
updateJob.Ram(128)
msg, err := r.UpdateJob(updateJob, "")
```
```
* Handling a timeout scenario:
When sending an API call to Aurora, the call may timeout at the client side.
This means that the time limit has been reached while waiting for the scheduler
to reply. In such a case it is recommended that the timeout is increased through
the use of the `realis.TimeoutMS()` option.
As these timeouts cannot be totally avoided, there exists a mechanism to mitigate such
scenarios. The `StartJobUpdate` and `CreateService` API will return an error that
implements the Timeout interface.
An error can be checked to see if it is a Timeout error by using the `realis.IsTimeout()`
function.