lease

type DynamoDBLeaseAPI ¶

type DynamoDBLeaseAPI interface {
	PutItem(ctx context.Context, params *dynamodb.PutItemInput, optFns ...func(*dynamodb.Options)) (*dynamodb.PutItemOutput, error)
	UpdateItem(ctx context.Context, params *dynamodb.UpdateItemInput, optFns ...func(*dynamodb.Options)) (*dynamodb.UpdateItemOutput, error)
	DeleteItem(ctx context.Context, params *dynamodb.DeleteItemInput, optFns ...func(*dynamodb.Options)) (*dynamodb.DeleteItemOutput, error)
}

type Key ¶

type Key struct {
	PK string
	SK string
}

type Lease ¶

type Lease struct {
	Key       Key
	Token     string
	ExpiresAt int64
}

type LeaseHeldError ¶

type LeaseHeldError struct {
	Key Key
}

LeaseHeldError indicates a lease could not be acquired because it is held by another contender. This is the "expected" failure mode for lock contention.

func (e *LeaseHeldError) Error() string

type LeaseNotOwnedError ¶

type LeaseNotOwnedError struct {
	Key Key
}

LeaseNotOwnedError indicates a refresh attempt failed because the caller's token no longer owns the lease. This can happen if the lease expired and was acquired by another contender, or if the token is wrong.

func (e *LeaseNotOwnedError) Error() string

type Manager ¶

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

func NewManager(client DynamoDBLeaseAPI, tableName string, opts ...Option) (*Manager, error)

func (m *Manager) Acquire(ctx context.Context, pk string, duration time.Duration) (*Lease, error)

func (m *Manager) AcquireKey(ctx context.Context, key Key, duration time.Duration) (*Lease, error)

func (m *Manager) Refresh(ctx context.Context, lease Lease, duration time.Duration) (*Lease, error)

func (m *Manager) Release(ctx context.Context, lease Lease) error

type Option ¶

type Option func(*Manager)

func WithIncludeTTL(include bool) Option

func WithKeyAttributeNames(pkAttr, skAttr string) Option

func WithLeaseAttributeNames(tokenAttr, expiresAtAttr, ttlAttr string) Option

func WithLockSortKey(lockSortKey string) Option

func WithNow(now func() time.Time) Option

func WithTTLBuffer(buffer time.Duration) Option

func WithTokenGenerator(token func() string) Option

func WithValidateInput(validate bool) Option