github.com/cloudwego/kitex@v0.9.0/pkg/limit/limit.go (about)

     1  /*
     2   * Copyright 2021 CloudWeGo Authors
     3   *
     4   * Licensed under the Apache License, Version 2.0 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   *
     8   *     http://www.apache.org/licenses/LICENSE-2.0
     9   *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  package limit
    18  
    19  // Updater is used to update the limit dynamically.
    20  type Updater interface {
    21  	UpdateLimit(opt *Option) (updated bool)
    22  }
    23  
    24  // Option is used to config the limiter.
    25  type Option struct {
    26  	MaxConnections int
    27  	MaxQPS         int
    28  
    29  	// UpdateControl receives a Updater which gives the limitation provider
    30  	// the ability to update limit dynamically.
    31  	UpdateControl func(u Updater)
    32  }
    33  
    34  // Valid checks if the option is valid.
    35  func (lo *Option) Valid() bool {
    36  	return lo.MaxConnections > 0 || lo.MaxQPS > 0
    37  }