config

Documentation

Index

• Constants
• type Config
  • func New(opts ...Option) *Config
  • func (c *Config) Clock() clockwork.Clock
  • func (c *Config) CreateSessionTimeout() time.Duration
  • func (c *Config) DeleteTimeout() time.Duration
  • func (c *Config) IdleThreshold() time.Duration
  • func (c *Config) SizeLimit() int
  • func (c *Config) Trace() *trace.Query
• type Option
  • func With(config config.Common) Option
  • func WithCreateSessionTimeout(createSessionTimeout time.Duration) Option
  • func WithDeleteTimeout(deleteTimeout time.Duration) Option
  • func WithIdleThreshold(idleThreshold time.Duration) Option
  • func WithSizeLimit(sizeLimit int) Option

Constants

const (
	DefaultSessionPoolDeleteTimeout        = 500 * time.Millisecond
	DefaultSessionPoolCreateSessionTimeout = 5 * time.Second
	DefaultSessionPoolSizeLimit            = 50
	DefaultSessionPoolIdleThreshold        = 5 * time.Minute
)

Types

type Config

type Config struct {
	config.Common
	// contains filtered or unexported fields
}

func New

func New(opts ...Option) *Config

func (*Config) Clock

func (c *Config) Clock() clockwork.Clock

Clock defines clock

func (*Config) CreateSessionTimeout

func (c *Config) CreateSessionTimeout() time.Duration

CreateSessionTimeout limits maximum time spent on Create session request

func (*Config) DeleteTimeout

func (c *Config) DeleteTimeout() time.Duration

DeleteTimeout limits maximum time spent on Delete request

If DeleteTimeout is less than or equal to zero then the DefaultSessionPoolDeleteTimeout is used.

func (*Config) IdleThreshold

func (c *Config) IdleThreshold() time.Duration

IdleThreshold is a maximum duration between any activity within session. If this threshold reached, idle session will be closed

If IdleThreshold is less than zero then there is no idle limit. If IdleThreshold is zero, then the DefaultSessionPoolIdleThreshold value is used.

func (*Config) SizeLimit

func (c *Config) SizeLimit() int

SizeLimit is an upper bound of pooled sessions. If SizeLimit is less than or equal to zero then the DefaultSessionPoolSizeLimit variable is used as a limit.

func (*Config) Trace

func (c *Config) Trace() *trace.Query

Trace defines trace over table client calls

type Option

type Option func(*Config)

func With

func With(config config.Common) Option

With applies common configuration params

func WithCreateSessionTimeout

func WithCreateSessionTimeout(createSessionTimeout time.Duration) Option

WithCreateSessionTimeout limits maximum time spent on Create session request If createSessionTimeout is less than or equal to zero then no used timeout on create session request

func WithDeleteTimeout

func WithDeleteTimeout(deleteTimeout time.Duration) Option

WithDeleteTimeout limits maximum time spent on Delete request If deleteTimeout is less than or equal to zero then the DefaultSessionPoolDeleteTimeout is used.

func WithIdleThreshold

func WithIdleThreshold(idleThreshold time.Duration) Option

WithIdleThreshold sets maximum duration between any activity within session. If this threshold reached, session will be closed.

If idleThreshold is less than zero then there is no idle limit. If idleThreshold is zero, then the DefaultSessionPoolIdleThreshold value is used.

func WithSizeLimit

func WithSizeLimit(sizeLimit int) Option

WithSizeLimit defines upper bound of pooled sessions. If sizeLimit is less than or equal to zero then the DefaultSessionPoolSizeLimit variable is used as a limit.