github.com/KinWaiYuen/client-go/v2@v2.5.4/tikv/client.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/client.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 tikv
    36  
    37  import (
    38  	"github.com/KinWaiYuen/client-go/v2/config"
    39  	"github.com/KinWaiYuen/client-go/v2/internal/client"
    40  )
    41  
    42  // Client is a client that sends RPC.
    43  // It should not be used after calling Close().
    44  type Client = client.Client
    45  
    46  // ClientOpt defines the option to create RPC client.
    47  type ClientOpt = client.Opt
    48  
    49  // WithSecurity is used to set security config.
    50  func WithSecurity(security config.Security) ClientOpt {
    51  	return client.WithSecurity(security)
    52  }
    53  
    54  // Timeout durations.
    55  const (
    56  	ReadTimeoutMedium     = client.ReadTimeoutMedium
    57  	ReadTimeoutShort      = client.ReadTimeoutShort
    58  	MaxWriteExecutionTime = client.MaxWriteExecutionTime
    59  )
    60  
    61  // NewRPCClient creates a client that manages connections and rpc calls with tikv-servers.
    62  func NewRPCClient(opts ...ClientOpt) *client.RPCClient {
    63  	return client.NewRPCClient(opts...)
    64  }