timelimiter

Documentation

Index

• Constants
• func DecorateConsumer[T any](limiter TimeLimiter, fn consumer.Consumer[T]) consumer.Consumer[T]
• func DecorateFunction[T any, R any](limiter TimeLimiter, fn function.Function[T, R]) function.Function[T, R]
• func DecorateRunnable(limiter TimeLimiter, fn runnable.Runnable) runnable.Runnable
• func DecorateSupplier[T any](limiter TimeLimiter, fn supplier.Supplier[T]) supplier.Supplier[T]
• type Config
  • func (config *Config) String() string
• type ConfigBuilder
  • func WithTimeoutDuration(timeoutDuration time.Duration) ConfigBuilder
• type Event
• type EventConsumer
• type EventListener
• type EventType
• type Metrics
• type TimeLimiter
  • func NewTimeLimiter(name string, configs ...ConfigBuilder) TimeLimiter
• type TimeoutError
  • func (e *TimeoutError) Error() string

Constants

const DefaultTimeoutDuration = time.Second

Functions

func DecorateConsumer

func DecorateConsumer[T any](limiter TimeLimiter, fn consumer.Consumer[T]) consumer.Consumer[T]

func DecorateFunction

func DecorateFunction[T any, R any](limiter TimeLimiter, fn function.Function[T, R]) function.Function[T, R]

func DecorateRunnable

func DecorateRunnable(limiter TimeLimiter, fn runnable.Runnable) runnable.Runnable

func DecorateSupplier

func DecorateSupplier[T any](limiter TimeLimiter, fn supplier.Supplier[T]) supplier.Supplier[T]

Types

type Config

type Config struct {
	// contains filtered or unexported fields
}

func (*Config) String

func (config *Config) String() string

type ConfigBuilder

type ConfigBuilder func(*Config)

func WithTimeoutDuration

func WithTimeoutDuration(timeoutDuration time.Duration) ConfigBuilder

type Event

type Event interface {
	fmt.Stringer
	TimeLimiterName() string
	CreationTime() time.Time
	EventType() EventType
}

type EventConsumer

type EventConsumer func(Event)

type EventListener

type EventListener interface {
	OnSuccess(EventConsumer) EventListener
	OnTimeout(EventConsumer) EventListener
	OnFailure(EventConsumer) EventListener
	Dismiss(EventConsumer) EventListener
	HasConsumer() bool
	// contains filtered or unexported methods
}

type EventType

type EventType string

const (
	SUCCESS EventType = "SUCCESS"
	TIMEOUT EventType = "TIMEOUT"
	FAILURE EventType = "FAILURE"
)

type Metrics

type Metrics interface {
	SuccessCount() int64
	TimeoutCount() int64
	FailureCount() int64
	// contains filtered or unexported methods
}

type TimeLimiter

type TimeLimiter interface {
	Name() string
	Metrics() Metrics
	EventListener() EventListener
	// contains filtered or unexported methods
}

func NewTimeLimiter

func NewTimeLimiter(name string, configs ...ConfigBuilder) TimeLimiter

type TimeoutError

type TimeoutError struct {
	// contains filtered or unexported fields
}

func (*TimeoutError) Error

func (e *TimeoutError) Error() string