multi_reservation_impl.go

// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
//
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package quotas

import (
	"time"
)

type (
	MultiReservationImpl struct {
		ok           bool
		reservations []Reservation
	}
)

var _ Reservation = (*MultiReservationImpl)(nil)

func NewMultiReservation(
	ok bool,
	reservations []Reservation,
) *MultiReservationImpl {
	if ok && len(reservations) == 0 {
		panic("expect at least one reservation")
	}
	return &MultiReservationImpl{
		ok:           ok,
		reservations: reservations,
	}
}

// OK returns whether the limiter can provide the requested number of tokens
func (r *MultiReservationImpl) OK() bool {
	return r.ok
}

// Cancel indicates that the reservation holder will not perform the reserved action
// and reverses the effects of this Reservation on the rate limit as much as possible
func (r *MultiReservationImpl) Cancel() {
	r.CancelAt(time.Now())
}

// CancelAt indicates that the reservation holder will not perform the reserved action
// and reverses the effects of this Reservation on the rate limit as much as possible
func (r *MultiReservationImpl) CancelAt(now time.Time) {
	if !r.ok {
		return
	}

	for _, reservation := range r.reservations {
		reservation.CancelAt(now)
	}
}

// Delay returns the duration for which the reservation holder must wait
// before taking the reserved action.  Zero duration means act immediately.
func (r *MultiReservationImpl) Delay() time.Duration {
	return r.DelayFrom(time.Now())
}

// DelayFrom returns the duration for which the reservation holder must wait
// before taking the reserved action.  Zero duration means act immediately.
func (r *MultiReservationImpl) DelayFrom(now time.Time) time.Duration {
	if !r.ok {
		return InfDuration
	}

	result := r.reservations[0].DelayFrom(now)
	for _, reservation := range r.reservations {
		duration := reservation.DelayFrom(now)
		if result < duration {
			result = duration
		}
	}
	return result
}