common

type LogFunctionType func(pattern string, args ...interface{})

type OnFinishFunc func(attempt int, maxRetries int, err error)

type OnRetryFunc func(attempt int, maxRetries int) (done bool, err error)

type OnStartFunc func(maxRetries int) error

type Poller interface {
	// Poll - starts the polling
	Poll() error
}

type PollerBuilder interface {
	// OnStart - The passed in function is executed before starting the polling. Useful for setting things up or logging the start of the polling
	OnStart(onStart OnStartFunc) PollerBuilder
	// OnRetry - The passed in function is executed at each retry. This function should contain the desired logic.
	OnRetry(onRetry OnRetryFunc) PollerBuilder
	// OnFinish - The passed in function is executed after the polling has ended.
	// Polling can end if the desired event has occurred, if the `OnRetry` function has failed or if the maximum number of retries has been reached
	OnFinish(onFinish OnFinishFunc) PollerBuilder
	// IntervalAndTimeout - Sets the interval between each retry and the timeout after which the polling will end
	// This method can be used as alternative of IntervalAndRetries
	IntervalAndTimeout(interval time.Duration, timeout time.Duration) PollerBuilder
	// IntervalAndRetries - Sets the interval between each retry and the maximum number of attempt to perform before giving up
	// This method can be used as alternative of IntervalAndTimeout
	IntervalAndRetries(interval time.Duration, maxRetries int) PollerBuilder
	// DisableRetryLog - Call this if you don't want the poller to log the polling
	DisableRetryLog() PollerBuilder
	// RetryLogMessage - Message to be shown on each retry. For more advanced logging, use RetryLogFunction
	RetryLogMessage(msg string) PollerBuilder
	// RetryLogMessagef - Message to be shown on each retry. The message is formatted according to a format specifie.
	// For more advanced logging, use RetryLogFunction
	RetryLogMessagef(format string, params ...interface{}) PollerBuilder
	// RetryLogFunction - The function to be called each time the poller desires to show some log. Default: 'Retrying...'
	RetryLogFunction(logFunction func(retry int, maxRetry int) string) PollerBuilder
	// OutputFunction - Useful only if RetryLogFunction is not used. Sets the function the poller must use to
	// output the log. Defaults to fmt.Printf
	OutputFunction(logFunction LogFunctionType) PollerBuilder
	// MaxRetryLogs - Sets the maximum number of log statements we want to be showed. They are evenly divided by the
	// maximum number of attempts
	MaxRetryLogs(maxRetryLogs int) PollerBuilder
	// ShouldLog - To be used to customise when a log should be shown or not. The default function tries to respect the
	// MaxRetryLogs value.
	ShouldLog(shouldLog ShouldLogFunc) PollerBuilder
	DumpCluster(id string) PollerBuilder
	DumpDB(name string, filter string, columns ...string) PollerBuilder
	// Build - Builds the poller
	Build() Poller
}

type ShouldLogFunc func(attempt int, maxRetries int, maxRetryLogs int) bool