vitess.io/vitess@v0.16.2/go/vt/vttablet/tabletserver/throttle/base/app_throttle.go (about)

     1  /*
     2  Copyright 2020 The Vitess 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 base
    18  
    19  import (
    20  	"time"
    21  )
    22  
    23  // AppThrottle is the definition for an app throttling instruction
    24  // - Ratio: [0..1], 0 == no throttle, 1 == fully throttle
    25  type AppThrottle struct {
    26  	AppName  string
    27  	ExpireAt time.Time
    28  	Ratio    float64
    29  }
    30  
    31  // NewAppThrottle creates an AppThrottle struct
    32  func NewAppThrottle(appName string, expireAt time.Time, ratio float64) *AppThrottle {
    33  	result := &AppThrottle{
    34  		AppName:  appName,
    35  		ExpireAt: expireAt,
    36  		Ratio:    ratio,
    37  	}
    38  	return result
    39  }