candiutils

Documentation

Index

• type HTTPRequest
  • func NewHTTPRequest(opts ...HTTPRequestOption) HTTPRequest
• type HTTPRequestOption
  • func HTTPRequestSetBreakerName(breakerName string) HTTPRequestOption
  • func HTTPRequestSetClient(cl *http.Client) 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 HTTPRequestResult
• type LockerOption
  • func WithPrefixLocker(prefix string) LockerOption
  • func WithTTLLocker(ttl time.Duration) LockerOption
• type LockerOptions
• type NoopLocker
  • func (NoopLocker) Disconnect(context.Context) error
  • func (NoopLocker) GetPrefixLocker() string
  • func (NoopLocker) GetTTLLocker() time.Duration
  • func (NoopLocker) HasBeenLocked(string) bool
  • func (NoopLocker) IsLocked(string) bool
  • func (NoopLocker) IsLockedTTL(string, time.Duration) bool
  • func (NoopLocker) Lock(string, time.Duration) (func(), error)
  • func (NoopLocker) Reset(string)
  • func (NoopLocker) Unlock(string)
• type RedisLocker
  • func NewRedisLocker(pool *redis.Pool, opts ...LockerOption) *RedisLocker
  • func (r *RedisLocker) Disconnect(ctx context.Context) error
  • func (r *RedisLocker) GetPrefixLocker() string
  • func (r *RedisLocker) GetTTLLocker() time.Duration
  • func (r *RedisLocker) HasBeenLocked(key string) bool
  • func (r *RedisLocker) IsLocked(key string) bool
  • func (r *RedisLocker) IsLockedTTL(key string, TTL time.Duration) bool
  • func (r *RedisLocker) Lock(key string, timeout time.Duration) (unlockFunc func(), err error)
  • func (r *RedisLocker) Reset(key string)
  • func (r *RedisLocker) Unlock(key string)
• type SyncPool
  • func NewSyncPool[T any](newFunc func() T, onPut func(T)) SyncPool[T]
  • func (s *SyncPool[T]) Get() T
  • func (s *SyncPool[T]) Put(x T)
• type WorkerPool
  • func NewWorkerPool[T any](maxWorker int) WorkerPool[T]

Types

type HTTPRequest

type HTTPRequest interface {
	DoRequest(ctx context.Context, method, url string, requestBody []byte, headers map[string]string) (result *HTTPRequestResult, err error)
	Do(context context.Context, method, url string, reqBody []byte, headers map[string]string) (respBody []byte, respCode int, err error)
}

HTTPRequest interface

func NewHTTPRequest

func NewHTTPRequest(opts ...HTTPRequestOption) HTTPRequest

NewHTTPRequest function Request's Constructor

type HTTPRequestOption

type HTTPRequestOption func(*httpRequestImpl)

HTTPRequestOption func type

func HTTPRequestSetBreakerName

func HTTPRequestSetBreakerName(breakerName string) HTTPRequestOption

HTTPRequestSetBreakerName option func

func HTTPRequestSetClient

func HTTPRequestSetClient(cl *http.Client) HTTPRequestOption

HTTPRequestSetClient 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 HTTPRequestResult

type HTTPRequestResult struct {
	*bytes.Buffer
	RespCode int
}

HTTPRequestResult struct

type LockerOption

type LockerOption func(*LockerOptions)

Option function type for setting options

func WithPrefixLocker

func WithPrefixLocker(prefix string) LockerOption

WithPrefix sets the prefix for keys

func WithTTLLocker

func WithTTLLocker(ttl time.Duration) LockerOption

WithTTL sets the default TTL for keys

type LockerOptions

type LockerOptions struct {
	Prefix string
	TTL    time.Duration
}

Options for RedisLocker

type NoopLocker

type NoopLocker struct{}

NoopLocker empty locker

func (NoopLocker) Disconnect

func (NoopLocker) Disconnect(context.Context) error

func (NoopLocker) GetPrefixLocker

func (NoopLocker) GetPrefixLocker() string

GetPrefix method

func (NoopLocker) GetTTLLocker

func (NoopLocker) GetTTLLocker() time.Duration

GetTTLLocker method

func (NoopLocker) HasBeenLocked

func (NoopLocker) HasBeenLocked(string) bool

HasBeenLocked method

func (NoopLocker) IsLocked

func (NoopLocker) IsLocked(string) bool

IsLocked method

func (NoopLocker) IsLockedTTL

func (NoopLocker) IsLockedTTL(string, time.Duration) bool

IsLockedTTL method

func (NoopLocker) Lock

func (NoopLocker) Lock(string, time.Duration) (func(), error)

Lock method

func (NoopLocker) Reset

func (NoopLocker) Reset(string)

Reset method

func (NoopLocker) Unlock

func (NoopLocker) Unlock(string)

Unlock method

type RedisLocker

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

RedisLocker lock using redis

func NewRedisLocker

func NewRedisLocker(pool *redis.Pool, opts ...LockerOption) *RedisLocker

NewRedisLocker constructor

func (*RedisLocker) Disconnect

func (r *RedisLocker) Disconnect(ctx context.Context) error

Disconnect close and reset

func (*RedisLocker) GetPrefixLocker

func (r *RedisLocker) GetPrefixLocker() string

GetPrefix returns the prefix used for keys

func (*RedisLocker) GetTTLLocker

func (r *RedisLocker) GetTTLLocker() time.Duration

GetTTLLocker returns the default TTL for keys

func (*RedisLocker) HasBeenLocked

func (r *RedisLocker) HasBeenLocked(key string) bool

func (*RedisLocker) IsLocked

func (r *RedisLocker) IsLocked(key string) bool

func (*RedisLocker) IsLockedTTL

func (r *RedisLocker) IsLockedTTL(key string, TTL time.Duration) bool

func (*RedisLocker) Lock

func (r *RedisLocker) Lock(key string, timeout time.Duration) (unlockFunc func(), err error)

Lock method

func (*RedisLocker) Reset

func (r *RedisLocker) Reset(key string)

Reset method

func (*RedisLocker) Unlock

func (r *RedisLocker) Unlock(key string)

Unlock method

type SyncPool

type SyncPool[T any] struct {
	// contains filtered or unexported fields
}

func NewSyncPool

func NewSyncPool[T any](newFunc func() T, onPut func(T)) SyncPool[T]

func (*SyncPool[T]) Get

func (s *SyncPool[T]) Get() T

func (*SyncPool[T]) Put

func (s *SyncPool[T]) Put(x T)

type WorkerPool

type WorkerPool[T any] interface {
	Dispatch(ctx context.Context, jobFunc func(context.Context, T))
	AddJob(job T)
	Finish()
}

WorkerPool implementation

func NewWorkerPool

func NewWorkerPool[T any](maxWorker int) WorkerPool[T]

NewWorkerPool create an instance of WorkerPool.