infra

Documentation

Index

• type Config
  • func (cfg *Config) SetSensiblePolicyDefaults()
• type Infra
  • func NewInfra(cfg Config, redisClient *redis.Client) Infra
  • func NewInfraWithProvider(lock Lock, provider InfraProvider) *Infra
  • func (infra *Infra) Declare(ctx context.Context) error
  • func (infra *Infra) Teardown(ctx context.Context) error
• type InfraProvider
• type Lock
  • func NewRedisLock(client *redis.Client, opts ...LockOption) Lock
• type LockOption
  • func LockWithKey(key string) LockOption
  • func LockWithTTL(ttl time.Duration) LockOption

Types

type Config

type Config struct {
	DeliveryMQ *mqinfra.MQInfraConfig
	LogMQ      *mqinfra.MQInfraConfig
}

func (*Config) SetSensiblePolicyDefaults

func (cfg *Config) SetSensiblePolicyDefaults()

type Infra

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

func NewInfra

func NewInfra(cfg Config, redisClient *redis.Client) Infra

func NewInfraWithProvider

func NewInfraWithProvider(lock Lock, provider InfraProvider) *Infra

NewInfraWithProvider creates an Infra instance with custom lock and provider (for testing)

func (*Infra) Declare

func (infra *Infra) Declare(ctx context.Context) error

func (*Infra) Teardown

func (infra *Infra) Teardown(ctx context.Context) error

type InfraProvider

type InfraProvider interface {
	Exist(ctx context.Context) (bool, error)
	Declare(ctx context.Context) error
	Teardown(ctx context.Context) error
}

InfraProvider handles the actual infrastructure operations

type Lock

type Lock interface {
	AttemptLock(ctx context.Context) (bool, error)
	Unlock(ctx context.Context) (bool, error)
}

func NewRedisLock

func NewRedisLock(client *redis.Client, opts ...LockOption) Lock

NewRedisLock creates a new Redis-based distributed lock

type LockOption

type LockOption func(*redisLock)

LockOption configures a redisLock

func LockWithKey

func LockWithKey(key string) LockOption

LockWithKey sets a custom key for the lock

func LockWithTTL

func LockWithTTL(ttl time.Duration) LockOption

LockWithTTL sets a custom TTL for the lock