types.go

// Copyright (c) 2016 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 ratelimit

// Options provides options for rate limiting
type Options interface {
	// SetLimitEnabled determines whether rate limiting is enabled
	SetLimitEnabled(value bool) Options

	// LimitEnabled returns whether rate limiting is enabled
	LimitEnabled() bool

	// SetLimitMbps sets the limit
	SetLimitMbps(value float64) Options

	// LimitMbps returns the limit
	LimitMbps() float64

	// SetLimitCheckEvery sets the limit check frequency
	SetLimitCheckEvery(value int) Options

	// LimitCheckEvery returns the limit check frequency
	LimitCheckEvery() int
}