go.temporal.io/server@v1.23.0/common/quotas/priority_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  	PriorityReservationImpl struct {
    33  		decidingReservation Reservation
    34  		otherReservations   []Reservation
    35  	}
    36  )
    37  
    38  var _ Reservation = (*PriorityReservationImpl)(nil)
    39  
    40  func NewPriorityReservation(
    41  	decidingReservation Reservation,
    42  	otherReservations []Reservation,
    43  ) *PriorityReservationImpl {
    44  	return &PriorityReservationImpl{
    45  		decidingReservation: decidingReservation,
    46  		otherReservations:   otherReservations,
    47  	}
    48  }
    49  
    50  // OK returns whether the limiter can provide the requested number of tokens
    51  func (r *PriorityReservationImpl) OK() bool {
    52  	return r.decidingReservation.OK()
    53  }
    54  
    55  // Cancel indicates that the reservation holder will not perform the reserved action
    56  // and reverses the effects of this Reservation on the rate limit as much as possible
    57  func (r *PriorityReservationImpl) Cancel() {
    58  	r.CancelAt(time.Now())
    59  }
    60  
    61  // CancelAt indicates that the reservation holder will not perform the reserved action
    62  // and reverses the effects of this Reservation on the rate limit as much as possible
    63  func (r *PriorityReservationImpl) CancelAt(now time.Time) {
    64  	r.decidingReservation.CancelAt(now)
    65  	for _, reservation := range r.otherReservations {
    66  		reservation.CancelAt(now)
    67  	}
    68  }
    69  
    70  // Delay returns the duration for which the reservation holder must wait
    71  // before taking the reserved action.  Zero duration means act immediately.
    72  func (r *PriorityReservationImpl) Delay() time.Duration {
    73  	return r.DelayFrom(time.Now())
    74  }
    75  
    76  // DelayFrom returns the duration for which the reservation holder must wait
    77  // before taking the reserved action.  Zero duration means act immediately.
    78  func (r *PriorityReservationImpl) DelayFrom(now time.Time) time.Duration {
    79  	return r.decidingReservation.DelayFrom(now)
    80  }