go.temporal.io/server@v1.23.0/common/quotas/reservation.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 quotas
    26  
    27  import (
    28  	"time"
    29  )
    30  
    31  //go:generate mockgen -copyright_file ../../LICENSE -package $GOPACKAGE -source $GOFILE -destination reservation_mock.go
    32  
    33  type (
    34  	// Reservation holds information about events that are permitted by a Limiter to happen after a delay
    35  	Reservation interface {
    36  		// OK returns whether the limiter can provide the requested number of tokens
    37  		OK() bool
    38  
    39  		// Cancel indicates that the reservation holder will not perform the reserved action
    40  		// and reverses the effects of this Reservation on the rate limit as much as possible
    41  		Cancel()
    42  
    43  		// CancelAt indicates that the reservation holder will not perform the reserved action
    44  		// and reverses the effects of this Reservation on the rate limit as much as possible
    45  		CancelAt(now time.Time)
    46  
    47  		// Delay returns the duration for which the reservation holder must wait
    48  		// before taking the reserved action.  Zero duration means act immediately.
    49  		Delay() time.Duration
    50  
    51  		// DelayFrom returns the duration for which the reservation holder must wait
    52  		// before taking the reserved action.  Zero duration means act immediately.
    53  		DelayFrom(now time.Time) time.Duration
    54  	}
    55  )