limit.go

/*
 * Copyright 2021 CloudWeGo Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package limit

// Updater is used to update the limit dynamically.
type Updater interface {
	UpdateLimit(opt *Option) (updated bool)
}

// Option is used to config the limiter.
type Option struct {
	MaxConnections int
	MaxQPS         int

	// UpdateControl receives a Updater which gives the limitation provider
	// the ability to update limit dynamically.
	UpdateControl func(u Updater)
}

// Valid checks if the option is valid.
func (lo *Option) Valid() bool {
	return lo.MaxConnections > 0 || lo.MaxQPS > 0
}