mutex

Documentation

Overview

Package mutex provides switch of concurrent safe feature for sync.Mutex.

Index

• type Mutex
  • func Create(safe ...bool) Mutex
  • func New(safe ...bool) *Mutex
  • func (mu *Mutex) IsSafe() bool
  • func (mu *Mutex) Lock()
  • func (mu *Mutex) Unlock()

Types

type Mutex

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

Mutex is a sync.Mutex with a switch for concurrent safe feature.

func Create

func Create(safe ...bool) Mutex

Create creates and returns a new Mutex object. The parameter `safe` is used to specify whether using this mutex in concurrent safety, which is false in default.

func New

func New(safe ...bool) *Mutex

New creates and returns a new *Mutex. The parameter `safe` is used to specify whether using this mutex in concurrent safety, which is false in default.

func (*Mutex) IsSafe

func (mu *Mutex) IsSafe() bool

IsSafe checks and returns whether current mutex is in concurrent-safe usage.

func (*Mutex) Lock

func (mu *Mutex) Lock()

Lock locks mutex for writing. It does nothing if it is not in concurrent-safe usage.

func (*Mutex) Unlock

func (mu *Mutex) Unlock()

Unlock unlocks mutex for writing. It does nothing if it is not in concurrent-safe usage.