namedlocker

README

namedlocker

Package namedlocker implements in-memory named locks. See https://oya.to/namedlocker for docs.

Install

go get oya.to/namedlocker

Usage

package test


func Example() {
    sto := Store{}
    sto.Lock("my-key")
    defer sto.Unlock("my-key")

    // do some work...
}

Documentation

Overview

Package namedlocker implements in-memory named locks.

Example

sto := Store{}
sto.Lock("my-key")
defer sto.Unlock("my-key")

// do some work...

Index

• Variables
• type Store
  • func (s *Store) Lock(key string)
  • func (s *Store) TryUnlock(key string) error
  • func (s *Store) Unlock(key string)

Examples

• Package

Variables

var (
	// ErrUnlockOfUnlockedKey is the error reported when unlocking an unlocked key.
	ErrUnlockOfUnlockedKey = errors.New("unlock of unlocked key")
)

Types

type Store

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

Store is an in-memory store of named locks.

The zero-value is usable as-is.

func (*Store) Lock

func (s *Store) Lock(key string)

Lock acquires a lock on key. If key is locked, it blocks until it can be acquired.

func (*Store) TryUnlock

func (s *Store) TryUnlock(key string) error

TryUnlock releases the lock on key.

If key is not locked, ErrUnlockOfUnlockedKey is returned.

func (*Store) Unlock

func (s *Store) Unlock(key string)

Unlock is a wrapper around TryUnlock that panics if it returns an error.