candiutils

Documentation

Index

• type Consul
  • func NewConsul(opt *ConsulConfig) (*Consul, error)
  • func (c *Consul) DestroySession() error
  • func (c *Consul) RecreateSession() error
  • func (c *Consul) RetryLockAcquire(value map[string]string, acquired chan<- struct{}, released chan<- struct{})
• type ConsulConfig
• type HTTPRequest
  • func NewHTTPRequest(opts ...HTTPRequestOption) HTTPRequest
• type HTTPRequestOption
  • func HTTPRequestSetBreakerName(breakerName string) HTTPRequestOption
  • func HTTPRequestSetHTTPErrorCodeThreshold(minHTTPStatusCode int) HTTPRequestOption
  • func HTTPRequestSetRetries(retries int) HTTPRequestOption
  • func HTTPRequestSetSleepBetweenRetry(sleepBetweenRetry time.Duration) HTTPRequestOption
  • func HTTPRequestSetTLS(tlsConfig *tls.Config) HTTPRequestOption
  • func HTTPRequestSetTimeout(timeout time.Duration) HTTPRequestOption
• type Locker
  • func NewRedisLocker(conn redis.Conn) Locker
• type NoopLocker
  • func (NoopLocker) IsLocked(key string) (bool, func())

Types

type Consul

type Consul struct {
	Client            *api.Client
	Key               string
	SessionID         string
	LockRetryInterval time.Duration
	SessionTTL        time.Duration
	MaxJobRebalance   int
}

Consul configured for lock acquisition

func NewConsul

func NewConsul(opt *ConsulConfig) (*Consul, error)

NewConsul constructor

func (*Consul) DestroySession

func (c *Consul) DestroySession() error

DestroySession method

func (*Consul) RecreateSession

func (c *Consul) RecreateSession() error

RecreateSession method

func (*Consul) RetryLockAcquire

func (c *Consul) RetryLockAcquire(value map[string]string, acquired chan<- struct{}, released chan<- struct{})

RetryLockAcquire attempts to acquire the lock at `LockRetryInterval`

type ConsulConfig

type ConsulConfig struct {
	ConsulAgentHost   string
	ConsulKey         string
	LockRetryInterval time.Duration
	SessionTTL        time.Duration
	MaxJobRebalance   int
}

ConsulConfig is used to configure creation of client

type HTTPRequest

type HTTPRequest interface {
	Do(context context.Context, method, url string, reqBody []byte, headers map[string]string) ([]byte, int, error)
}

HTTPRequest interface

func NewHTTPRequest

func NewHTTPRequest(opts ...HTTPRequestOption) HTTPRequest

NewHTTPRequest function Request's Constructor Returns : *Request

type HTTPRequestOption

type HTTPRequestOption func(*httpRequestImpl)

HTTPRequestOption func type

func HTTPRequestSetBreakerName

func HTTPRequestSetBreakerName(breakerName string) HTTPRequestOption

HTTPRequestSetBreakerName option func

func HTTPRequestSetHTTPErrorCodeThreshold

func HTTPRequestSetHTTPErrorCodeThreshold(minHTTPStatusCode int) HTTPRequestOption

HTTPRequestSetHTTPErrorCodeThreshold option func, set minimum http response code for return error when exec client request

func HTTPRequestSetRetries

func HTTPRequestSetRetries(retries int) HTTPRequestOption

HTTPRequestSetRetries option func

func HTTPRequestSetSleepBetweenRetry

func HTTPRequestSetSleepBetweenRetry(sleepBetweenRetry time.Duration) HTTPRequestOption

HTTPRequestSetSleepBetweenRetry option func

func HTTPRequestSetTLS

func HTTPRequestSetTLS(tlsConfig *tls.Config) HTTPRequestOption

HTTPRequestSetTLS option func

func HTTPRequestSetTimeout

func HTTPRequestSetTimeout(timeout time.Duration) HTTPRequestOption

HTTPRequestSetTimeout option func

type Locker

type Locker interface {
	IsLocked(key string) (isLock bool, releaseLock func())
}

Locker abstraction, lock concurrent processs

func NewRedisLocker

func NewRedisLocker(conn redis.Conn) Locker

NewRedisLocker constructor

type NoopLocker

type NoopLocker struct{}

NoopLocker empty locker

func (NoopLocker) IsLocked

func (NoopLocker) IsLocked(key string) (bool, func())

IsLocked method