go.temporal.io/server@v1.23.0/common/locks/condition_variable.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  type (
    28  	// ConditionVariable is the interface for condition variable
    29  	ConditionVariable interface {
    30  		// Signal wakes one goroutine waiting on this condition variable, if there is any.
    31  		Signal()
    32  		// Broadcast wakes all goroutines waiting on this condition variable.
    33  		Broadcast()
    34  		// Wait atomically unlocks user provided lock and suspends execution of the calling goroutine.
    35  		// After later resuming execution, Wait locks c.L before returning.
    36  		// Wait can be awoken by Broadcast, Signal or user provided interrupt channel.
    37  		Wait(interrupt <-chan struct{})
    38  	}
    39  )