mfs

README

mfs

golang mfs - additional sync structs ant methods

mfs.RWTMutex - Read Write Try Mutex

mfs.RWTMutex is like sync.RWMutex

mx := mfs.RWTMutex{}
mx.Lock()
// DO Something
mx.Unlock()

and mfs.RWTMutex contains TryLock

// ctx - sime context
ctx := context.Background()
mx := mfs.RWTMutex{}
isLocked := mx.TryLock(ctx)
if isLocked {
    // DO Something
    mx.Unlock()
} else {
    // DO Something else
}

mfs.PMutex - Read Write Try Mutex with change priority (Promote and Reduce)

mfs.PMutex is like sync.RWMutex
mfs.PMutex is like mfs.RWTMutex

Reduce - lock mutex from Lock to RLock

mx := mfs.RWTMutex{}
mx.Lock()
// DO Something
mx.Reduce()
// Now mutex like RLock()
// DO Something
mx.RUnlock()

Promote - lock mutex from RLock to Lock

mx := mfs.RWTMutex{}
mx.RLock()
// DO Something
mx.Promote()
// Now mutex like Lock()
// DO Something
mx.Unlock()

TryPromote - lock mutex from RLock to Lock

// ctx is some context
mx := mfs.RWTMutex{}
mx.RLock()
// DO Something
isLocked := mx.TryPromote()
if isLocked {
    // Now mutex like Lock()
    // DO Something
    mx.Unlock()
} else {
    // Mutex is not locked (like call mx.RUnlock())
    // DO Something else
}

F methods (PromoteF, TryPromoteF, LockF, TryLockF, RLockF, RTryLockF)

It should be locked befor regular methods like Lock or Promote are

Me

Ilya Shcherbina
+7(903)192-4239
sch@myfantasy.ru

Documentation

Index

• type MapMutex
  • func (m *MapMutex) DoGlobal(do func())
  • func (m *MapMutex) GetMutex(name string) *PMutex
  • func (m *MapMutex) Lock(name string)
  • func (m *MapMutex) LockD(d time.Duration, name string) bool
  • func (m *MapMutex) LockDF(d time.Duration, name string) bool
  • func (m *MapMutex) LockF(name string)
  • func (m *MapMutex) Promote(name string)
  • func (m *MapMutex) PromoteD(d time.Duration, name string) bool
  • func (m *MapMutex) PromoteDF(d time.Duration, name string) bool
  • func (m *MapMutex) PromoteF(name string)
  • func (m *MapMutex) RLock(name string)
  • func (m *MapMutex) RLockD(d time.Duration, name string) bool
  • func (m *MapMutex) RLockDF(d time.Duration, name string) bool
  • func (m *MapMutex) RLockF(name string)
  • func (m *MapMutex) RTryLock(ctx context.Context, name string) bool
  • func (m *MapMutex) RTryLockF(ctx context.Context, name string) bool
  • func (m *MapMutex) RUnlock(name string)
  • func (m *MapMutex) Reduce(name string)
  • func (m *MapMutex) TryLock(ctx context.Context, name string) bool
  • func (m *MapMutex) TryLockF(ctx context.Context, name string) bool
  • func (m *MapMutex) TryPromote(ctx context.Context, name string) bool
  • func (m *MapMutex) TryPromoteF(ctx context.Context, name string) bool
  • func (m *MapMutex) Unlock(name string)
• type PMutex
  • func (m *PMutex) Lock()
  • func (m *PMutex) LockD(d time.Duration) bool
  • func (m *PMutex) LockDF(d time.Duration) bool
  • func (m *PMutex) LockF()
  • func (m *PMutex) Promote()
  • func (m *PMutex) PromoteD(d time.Duration) bool
  • func (m *PMutex) PromoteDF(d time.Duration) bool
  • func (m *PMutex) PromoteF()
  • func (m *PMutex) RLock()
  • func (m *PMutex) RLockD(d time.Duration) bool
  • func (m *PMutex) RLockDF(d time.Duration) bool
  • func (m *PMutex) RLockF()
  • func (m *PMutex) RTryLock(ctx context.Context) bool
  • func (m *PMutex) RTryLockF(ctx context.Context) bool
  • func (m *PMutex) RUnlock()
  • func (m *PMutex) Reduce()
  • func (m *PMutex) TryLock(ctx context.Context) bool
  • func (m *PMutex) TryLockF(ctx context.Context) bool
  • func (m *PMutex) TryPromote(ctx context.Context) bool
  • func (m *PMutex) TryPromoteF(ctx context.Context) bool
  • func (m *PMutex) Unlock()
• type RWTMutex
  • func (m *RWTMutex) Lock()
  • func (m *RWTMutex) LockD(d time.Duration) bool
  • func (m *RWTMutex) RLock()
  • func (m *RWTMutex) RLockD(d time.Duration) bool
  • func (m *RWTMutex) RTryLock(ctx context.Context) bool
  • func (m *RWTMutex) RUnlock()
  • func (m *RWTMutex) Reduce()
  • func (m *RWTMutex) TryLock(ctx context.Context) bool
  • func (m *RWTMutex) Unlock()

Types

type MapMutex

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

MapMutex - Mutex is named (each name locks independently) Read Write Try Mutex with change priority (Promote and Reduce) F methods (like LockF and TryLockF) Locks mutex if mutex already locked then this methods will be first in lock queue Promote - lock mutex from RLock to Lock Reduce - lock mutex from Lock to RLock

func (*MapMutex) DoGlobal

func (m *MapMutex) DoGlobal(do func())

DoGlobal - do some action under global lock

func (*MapMutex) GetMutex

func (m *MapMutex) GetMutex(name string) *PMutex

GetMutex - gets PMutex from MapMutex by name

func (*MapMutex) Lock

func (m *MapMutex) Lock(name string)

Lock - locks mutex

func (*MapMutex) LockD

func (m *MapMutex) LockD(d time.Duration, name string) bool

LockD - try locks mutex with time duration

func (*MapMutex) LockDF

func (m *MapMutex) LockDF(d time.Duration, name string) bool

LockDF - try locks mutex with time duration first (out of turn)

func (*MapMutex) LockF

func (m *MapMutex) LockF(name string)

LockF - locks mutex first (out of turn)

func (*MapMutex) Promote

func (m *MapMutex) Promote(name string)

Promote - lock mutex from RLock to Lock

func (*MapMutex) PromoteD

func (m *MapMutex) PromoteD(d time.Duration, name string) bool

PromoteD - try locks mutex from RLock to Lock with time duration !!! If returns false then mutex is UNLOCKED if true mutex is locked as Lock

func (*MapMutex) PromoteDF

func (m *MapMutex) PromoteDF(d time.Duration, name string) bool

PromoteDF - try locks mutex from RLock to Lock with time duration first (out of turn) !!! If returns false then mutex is UNLOCKED if true mutex is locked as Lock

func (*MapMutex) PromoteF

func (m *MapMutex) PromoteF(name string)

PromoteF - lock mutex from RLock to Lock first (out of turn)

func (*MapMutex) RLock

func (m *MapMutex) RLock(name string)

RLock - read locks mutex

func (*MapMutex) RLockD

func (m *MapMutex) RLockD(d time.Duration, name string) bool

RLockD - try read locks mutex with time duration

func (*MapMutex) RLockDF

func (m *MapMutex) RLockDF(d time.Duration, name string) bool

RLockDF - try read locks mutex with time duration first (out of turn)

func (*MapMutex) RLockF

func (m *MapMutex) RLockF(name string)

RLockF - read locks mutex first (out of turn)

func (*MapMutex) RTryLock

func (m *MapMutex) RTryLock(ctx context.Context, name string) bool

RTryLock - try read locks mutex with context

func (*MapMutex) RTryLockF

func (m *MapMutex) RTryLockF(ctx context.Context, name string) bool

RTryLockF - try read locks mutex with context first (out of turn)

func (*MapMutex) RUnlock

func (m *MapMutex) RUnlock(name string)

RUnlock - unlocks mutex

func (*MapMutex) Reduce

func (m *MapMutex) Reduce(name string)

Reduce - lock mutex from Lock to RLock

func (*MapMutex) TryLock

func (m *MapMutex) TryLock(ctx context.Context, name string) bool

TryLock - try locks mutex with context

func (*MapMutex) TryLockF

func (m *MapMutex) TryLockF(ctx context.Context, name string) bool

TryLockF - try locks mutex with context first (out of turn)

func (*MapMutex) TryPromote

func (m *MapMutex) TryPromote(ctx context.Context, name string) bool

TryPromote - try locks mutex from RLock to Lock with context !!! If returns false then mutex is UNLOCKED if true mutex is locked as Lock

func (*MapMutex) TryPromoteF

func (m *MapMutex) TryPromoteF(ctx context.Context, name string) bool

TryPromoteF - try locks mutex from RLock to Lock with context first (out of turn) !!! If returns false then mutex is UNLOCKED if true mutex is locked as Lock

func (*MapMutex) Unlock

func (m *MapMutex) Unlock(name string)

Unlock - unlocks mutex

type PMutex

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

PMutex - Read Write Try Mutex with change priority (Promote and Reduce) F methods (like LockF and TryLockF) Locks mutex if mutex already locked then this methods will be first in lock queue Promote - lock mutex from RLock to Lock Reduce - lock mutex from Lock to RLock

func (*PMutex) Lock

func (m *PMutex) Lock()

Lock - locks mutex

func (*PMutex) LockD

func (m *PMutex) LockD(d time.Duration) bool

LockD - try locks mutex with time duration

func (*PMutex) LockDF

func (m *PMutex) LockDF(d time.Duration) bool

LockDF - try locks mutex with time duration first (out of turn)

func (*PMutex) LockF

func (m *PMutex) LockF()

LockF - locks mutex first (out of turn)

func (*PMutex) Promote

func (m *PMutex) Promote()

Promote - lock mutex from RLock to Lock

func (*PMutex) PromoteD

func (m *PMutex) PromoteD(d time.Duration) bool

PromoteD - try locks mutex from RLock to Lock with time duration !!! If returns false then mutex is UNLOCKED if true mutex is locked as Lock

func (*PMutex) PromoteDF

func (m *PMutex) PromoteDF(d time.Duration) bool

PromoteDF - try locks mutex from RLock to Lock with time duration first (out of turn) !!! If returns false then mutex is UNLOCKED if true mutex is locked as Lock

func (*PMutex) PromoteF

func (m *PMutex) PromoteF()

PromoteF - lock mutex from RLock to Lock first (out of turn)

func (*PMutex) RLock

func (m *PMutex) RLock()

RLock - read locks mutex

func (*PMutex) RLockD

func (m *PMutex) RLockD(d time.Duration) bool

RLockD - try read locks mutex with time duration

func (*PMutex) RLockDF

func (m *PMutex) RLockDF(d time.Duration) bool

RLockDF - try read locks mutex with time duration first (out of turn)

func (*PMutex) RLockF

func (m *PMutex) RLockF()

RLockF - read locks mutex first (out of turn)

func (*PMutex) RTryLock

func (m *PMutex) RTryLock(ctx context.Context) bool

RTryLock - try read locks mutex with context

func (*PMutex) RTryLockF

func (m *PMutex) RTryLockF(ctx context.Context) bool

RTryLockF - try read locks mutex with context first (out of turn)

func (*PMutex) RUnlock

func (m *PMutex) RUnlock()

RUnlock - unlocks mutex

func (*PMutex) Reduce

func (m *PMutex) Reduce()

Reduce - lock mutex from Lock to RLock

func (*PMutex) TryLock

func (m *PMutex) TryLock(ctx context.Context) bool

TryLock - try locks mutex with context

func (*PMutex) TryLockF

func (m *PMutex) TryLockF(ctx context.Context) bool

TryLockF - try locks mutex with context first (out of turn)

func (*PMutex) TryPromote

func (m *PMutex) TryPromote(ctx context.Context) bool

TryPromote - try locks mutex from RLock to Lock with context !!! If returns false then mutex is UNLOCKED if true mutex is locked as Lock

func (*PMutex) TryPromoteF

func (m *PMutex) TryPromoteF(ctx context.Context) bool

TryPromoteF - try locks mutex from RLock to Lock with context first (out of turn) !!! If returns false then mutex is UNLOCKED if true mutex is locked as Lock

func (*PMutex) Unlock

func (m *PMutex) Unlock()

Unlock - unlocks mutex

type RWTMutex

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

RWTMutex - Read Write and Try Mutex

func (*RWTMutex) Lock

func (m *RWTMutex) Lock()

Lock - locks mutex

func (*RWTMutex) LockD

func (m *RWTMutex) LockD(d time.Duration) bool

LockD - try locks mutex with time duration

func (*RWTMutex) RLock

func (m *RWTMutex) RLock()

RLock - read locks mutex

func (*RWTMutex) RLockD

func (m *RWTMutex) RLockD(d time.Duration) bool

RLockD - try read locks mutex with time duration

func (*RWTMutex) RTryLock

func (m *RWTMutex) RTryLock(ctx context.Context) bool

RTryLock - try read locks mutex with context

func (*RWTMutex) RUnlock

func (m *RWTMutex) RUnlock()

RUnlock - unlocks mutex

func (*RWTMutex) Reduce

func (m *RWTMutex) Reduce()

Reduce - lock mutex from Lock to RLock

func (*RWTMutex) TryLock

func (m *RWTMutex) TryLock(ctx context.Context) bool

TryLock - try locks mutex with context

func (*RWTMutex) Unlock

func (m *RWTMutex) Unlock()

Unlock - unlocks mutex