github.com/KinWaiYuen/client-go/v2@v2.5.4/kv/variables.go (about)

     1  // Copyright 2021 TiKV Authors
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // NOTE: The code in this file is based on code from the
    16  // TiDB project, licensed under the Apache License v 2.0
    17  //
    18  // https://github.com/pingcap/tidb/tree/cc5e161ac06827589c4966674597c137cc9e809c/store/tikv/kv/variables.go
    19  //
    20  
    21  // Copyright 2021 PingCAP, Inc.
    22  //
    23  // Licensed under the Apache License, Version 2.0 (the "License");
    24  // you may not use this file except in compliance with the License.
    25  // You may obtain a copy of the License at
    26  //
    27  //     http://www.apache.org/licenses/LICENSE-2.0
    28  //
    29  // Unless required by applicable law or agreed to in writing, software
    30  // distributed under the License is distributed on an "AS IS" BASIS,
    31  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    32  // See the License for the specific language governing permissions and
    33  // limitations under the License.
    34  
    35  package kv
    36  
    37  // Variables defines the variables used by KV storage.
    38  type Variables struct {
    39  	// BackoffLockFast specifies the LockFast backoff base duration in milliseconds.
    40  	BackoffLockFast int
    41  
    42  	// BackOffWeight specifies the weight of the max back off time duration.
    43  	BackOffWeight int
    44  
    45  	// Pointer to SessionVars.Killed
    46  	// Killed is a flag to indicate that this query is killed.
    47  	Killed *uint32
    48  }
    49  
    50  // NewVariables create a new Variables instance with default values.
    51  func NewVariables(killed *uint32) *Variables {
    52  	return &Variables{
    53  		BackoffLockFast: DefBackoffLockFast,
    54  		BackOffWeight:   DefBackOffWeight,
    55  		Killed:          killed,
    56  	}
    57  }
    58  
    59  var ignoreKill uint32
    60  
    61  // DefaultVars is the default variables instance.
    62  var DefaultVars = NewVariables(&ignoreKill)
    63  
    64  // Default values
    65  const (
    66  	DefBackoffLockFast = 100
    67  	DefBackOffWeight   = 2
    68  )