flock

README

Read-write mutex lock across process

Support Linux, Mac, Window.

Documentation

Overview

Package flock provides read-write mutex locks across process for Linux, Mac and Windows. RWMutex methods shall panic if they are misused.

Index

• type RWMutex
  • func New(filename string) (*RWMutex, error)
  • func (rw *RWMutex) Lock()
  • func (rw *RWMutex) RLock()
  • func (rw *RWMutex) RUnlock()
  • func (rw *RWMutex) Unlock()

Types

type RWMutex

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

RWMutex is equivalent to sync.RWMutex, but synchronizes across processes.

func New

func New(filename string) (*RWMutex, error)

New create a new instance of multi-process rwmutex.

func (*RWMutex) Lock

func (rw *RWMutex) Lock()

Lock locks rw. If the lock is already in use, the calling goroutine blocks until the mutex is available.

func (*RWMutex) RLock

func (rw *RWMutex) RLock()

RLock locks rw for reading. It should not be used for recursive read locking; a blocked Lock call excludes new readers from acquiring the lock.

func (*RWMutex) RUnlock

func (rw *RWMutex) RUnlock()

RUnlock undo a single RLock call; it does not affect other simultaneous readers.

func (*RWMutex) Unlock

func (rw *RWMutex) Unlock()

Unlock unlocks rw. It is a run-time error if rw is not locked on entry to Unlock.