go.temporal.io/server@v1.23.0/common/quotas/multi_reservation_impl.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  type (
    32  	MultiReservationImpl struct {
    33  		ok           bool
    34  		reservations []Reservation
    35  	}
    36  )
    37  
    38  var _ Reservation = (*MultiReservationImpl)(nil)
    39  
    40  func NewMultiReservation(
    41  	ok bool,
    42  	reservations []Reservation,
    43  ) *MultiReservationImpl {
    44  	if ok && len(reservations) == 0 {
    45  		panic("expect at least one reservation")
    46  	}
    47  	return &MultiReservationImpl{
    48  		ok:           ok,
    49  		reservations: reservations,
    50  	}
    51  }
    52  
    53  // OK returns whether the limiter can provide the requested number of tokens
    54  func (r *MultiReservationImpl) OK() bool {
    55  	return r.ok
    56  }
    57  
    58  // Cancel indicates that the reservation holder will not perform the reserved action
    59  // and reverses the effects of this Reservation on the rate limit as much as possible
    60  func (r *MultiReservationImpl) Cancel() {
    61  	r.CancelAt(time.Now())
    62  }
    63  
    64  // CancelAt indicates that the reservation holder will not perform the reserved action
    65  // and reverses the effects of this Reservation on the rate limit as much as possible
    66  func (r *MultiReservationImpl) CancelAt(now time.Time) {
    67  	if !r.ok {
    68  		return
    69  	}
    70  
    71  	for _, reservation := range r.reservations {
    72  		reservation.CancelAt(now)
    73  	}
    74  }
    75  
    76  // Delay returns the duration for which the reservation holder must wait
    77  // before taking the reserved action.  Zero duration means act immediately.
    78  func (r *MultiReservationImpl) Delay() time.Duration {
    79  	return r.DelayFrom(time.Now())
    80  }
    81  
    82  // DelayFrom returns the duration for which the reservation holder must wait
    83  // before taking the reserved action.  Zero duration means act immediately.
    84  func (r *MultiReservationImpl) DelayFrom(now time.Time) time.Duration {
    85  	if !r.ok {
    86  		return InfDuration
    87  	}
    88  
    89  	result := r.reservations[0].DelayFrom(now)
    90  	for _, reservation := range r.reservations {
    91  		duration := reservation.DelayFrom(now)
    92  		if result < duration {
    93  			result = duration
    94  		}
    95  	}
    96  	return result
    97  }