locking

Documentation

Index

• type LockNode
  • func CreateLockNode(path ...interface{}) *LockNode
  • func (node *LockNode) Insert(path ...interface{})
  • func (node *LockNode) Lock(ctx context.Context, path ...interface{}) (func(), error)
  • func (node *LockNode) RLock(ctx context.Context, path ...interface{}) (func(), error)
  • func (node *LockNode) Remove(path ...interface{})

Types

type LockNode

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

LockNode is a node in the lock tree. It is used to provide multi-dimensional read and write lock.

func CreateLockNode

func CreateLockNode(path ...interface{}) *LockNode

CreateLockNode creates a lock node. It will create a linked list of lock node based on given path and return the root node.

@input - path.

@output - root node.

func (*LockNode) Insert

func (node *LockNode) Insert(path ...interface{})

Insert inserts a path to a given node. Note: In multiprocess, Lock(path) must be called prior to this function call.

@input - path.

func (*LockNode) Lock

func (node *LockNode) Lock(ctx context.Context, path ...interface{}) (func(), error)

Lock write locks a given path.

@input - context, path.

@output - function to release lock, error.

func (*LockNode) RLock

func (node *LockNode) RLock(ctx context.Context, path ...interface{}) (func(), error)

RLock read locks a given path.

@input - context, path.

@output - function to release lock, error.

func (*LockNode) Remove

func (node *LockNode) Remove(path ...interface{})

Remove removes a path from a given node. Note: In multiprocess, Lock(path) must be called prior to this function call.

@input - path.