go.temporal.io/server@v1.23.0/common/locks/priority_mutex.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  package locks
    26  
    27  import (
    28  	"context"
    29  )
    30  
    31  type (
    32  	PriorityMutex interface {
    33  		// LockHigh try to lock with high priority, use LockHigh / UnlockHigh pair to lock / unlock
    34  		LockHigh(context.Context) error
    35  		// LockLow try to lock with low priority, use LockLow / UnlockLow pair to lock / unlock
    36  		LockLow(context.Context) error
    37  		// UnlockHigh unlock with high priority, use LockHigh / UnlockHigh pair to lock / unlock
    38  		UnlockHigh()
    39  		// UnlockLow unlock with low priority, use LockLow / UnlockLow pair to lock / unlock
    40  		UnlockLow()
    41  		// TryLockHigh try to lock with high priority, return true if lock acquired
    42  		// use TryLockHigh / UnlockHigh pair to lock / unlock
    43  		TryLockHigh() bool
    44  		// TryLockLow try to lock with high priority, return true if lock acquired
    45  		// use TryLockLow / UnlockLow pair to lock / unlock
    46  		TryLockLow() bool
    47  		// IsLocked returns true if already locked
    48  		IsLocked() bool
    49  	}
    50  )