dubbo.apache.org/dubbo-go/v3@v3.1.1/filter/tps_limiter.go (about)

     1  /*
     2   * Licensed to the Apache Software Foundation (ASF) under one or more
     3   * contributor license agreements.  See the NOTICE file distributed with
     4   * this work for additional information regarding copyright ownership.
     5   * The ASF licenses this file to You under the Apache License, Version 2.0
     6   * (the "License"); you may not use this file except in compliance with
     7   * the License.  You may obtain a copy of the License at
     8   *
     9   *     http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the License for the specific language governing permissions and
    15   * limitations under the License.
    16   */
    17  
    18  package filter
    19  
    20  import (
    21  	"dubbo.apache.org/dubbo-go/v3/common"
    22  	"dubbo.apache.org/dubbo-go/v3/protocol"
    23  )
    24  
    25  // TpsLimiter is the interface which defines the Limiter that judge if the TPS overs the threshold
    26  //
    27  // # IsAllowable method will check whether this invocation should be enabled for further process
    28  //
    29  // please register your implementation by invoking SetTpsLimiter
    30  // The usage, for example:
    31  // "UserProvider":
    32  //
    33  //	registry: "hangzhouzk"
    34  //	protocol : "dubbo"
    35  //	interface : "com.ikurento.user.UserProvider"
    36  //	... # other configuration
    37  //	tps.limiter: "the name of limiter",
    38  type TpsLimiter interface {
    39  	IsAllowable(*common.URL, protocol.Invocation) bool
    40  }