cidlocker

README

repo-template

GitHub repository template for Golang projects using codecov and travis CI. Includes a Makefile for common development workflow tasks, such as dependency updates, linting, formatting, etc..

Documentation

Overview

Package cidlocker is used to provide granular concurrent resource access control on a per-CID basis.

Index

• type CIDLocker
  • func New() *CIDLocker
  • func (cl *CIDLocker) Create(cid gocid.Cid)
  • func (cl *CIDLocker) Exists(cid gocid.Cid) bool
  • func (cl *CIDLocker) Lock(cid gocid.Cid)
  • func (cl *CIDLocker) Unlock(cid gocid.Cid)

Types

type CIDLocker

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

CIDLocker is used to block access to resources on a per-CID basis, useful when guarding concurrent access in systems handling many different CIDs (like reference counting)

The only time this blocks is when creating the initial lock, afterwards all writes for a record are non-blocking unless another record is first published at the same time.

func New

func New() *CIDLocker

New returns a fresh instance of CIDLocker

func (*CIDLocker) Create

func (cl *CIDLocker) Create(cid gocid.Cid)

Create is like exists, except it populates the map if the entry does not exist

func (*CIDLocker) Exists

func (cl *CIDLocker) Exists(cid gocid.Cid) bool

Exists check if we have a lock for this cid

func (*CIDLocker) Lock

func (cl *CIDLocker) Lock(cid gocid.Cid)

Lock obtains a lock for the cid

func (*CIDLocker) Unlock

func (cl *CIDLocker) Unlock(cid gocid.Cid)

Unlock reverts the cid lock