From 170ef11e2ae4c0a9852c816cd316659afc6fd9bc Mon Sep 17 00:00:00 2001 From: Renan DelValle Date: Tue, 30 Oct 2018 12:21:34 -0700 Subject: [PATCH] Adding documentation about how this particular implemantion of the realis client uses retries in scenarios where a temporary error is found. --- realis.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/realis.go b/realis.go index 72f5624..97e588f 100644 --- a/realis.go +++ b/realis.go @@ -251,6 +251,10 @@ func newTBinTransport(url string, timeout int, config *RealisConfig) (thrift.TTr return trans, err } +// This client implementation of the realis interface uses a retry mechanism for all Thrift Calls. +// It will retry all calls which result in a temporary failure as well as calls that fail due to an EOF +// being returned by the http client. Most permanent failures are now being caught by the thriftCallWithRetries +// function and not being retried but there may be corner cases not yet handled. func NewRealisClient(options ...ClientOption) (Realis, error) { config := &RealisConfig{}