valkey

package

v1.0.0 Latest Latest Go to latest Published: Aug 26, 2026 License: MIT Imports: 11 Imported by: 0

Details

Package valkey provides native atomic fenced leases for Valkey.

This section is empty.

This section is empty.

This section is empty.

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

Guard is an opaque active-ownership proof for atomic Valkey protected writes.

func (guard Guard) Owner() string

Owner returns the lease owner compared by a protected write.

func (guard Guard) StorageKey() string

StorageKey returns the redacted Valkey lease hash key.

func (guard Guard) Token() string

Token returns the exact decimal fencing token compared by a protected write.

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

Store persists atomic leases using backend-time Lua operations.

func New(client valkeygo.Client, prefix string) (*Store, error)

New constructs a native Valkey backend. The client owns reconnect, ACL, TLS, routing, and timeout policy and must be closed by its creator.

func Open(ctx context.Context, client valkeygo.Client, prefix string) (*Store, error)

Open constructs a backend and verifies Valkey 9 plus noeviction policy.

func (store *Store) Guard(owned lease.Record) (Guard, error)

Guard derives the backend coordinates required to validate owned atomically. The protected writer must use the same Valkey deployment as this Store.

func (store *Store) Release(ctx context.Context, owned lease.Record) error

Release atomically deletes only a matching lease; missing is idempotent.

func (store *Store) Renew(
	ctx context.Context,
	owned lease.Record,
	ttl time.Duration,
) (lease.Record, error)

Renew atomically compares owner and token before extending backend expiry.

func (store *Store) TryAcquire(
	ctx context.Context,
	key lease.Key,
	owner string,
	ttl time.Duration,
) (lease.Record, error)

TryAcquire atomically increments the persistent counter and creates a lease.

func (store *Store) Validate(ctx context.Context, owned lease.Record) (lease.Record, error)

Validate atomically compares owner and token against an unexpired lease.