client

Documentation

Overview

Package client provides tcp connection to kvserver.

Package client provides tcp connection to kvserver.

Package client provides tcp connection to kvserver.

Index

• Constants
• Variables
• type Client
  • func NewInterceptedClient(client Client) Client
  • func NewReqCollapse(client Client) Client
• type Opt
  • func WithCodec(codec apicodec.Codec) Opt
  • func WithGRPCDialOptions(grpcDialOptions ...grpc.DialOption) Opt
  • func WithSecurity(security config.Security) Opt
• type RPCClient
  • func NewRPCClient(opts ...Opt) *RPCClient
  • func (c *RPCClient) Close() error
  • func (c *RPCClient) CloseAddr(addr string) error
  • func (c *RPCClient) SendRequest(ctx context.Context, addr string, req *tikvrpc.Request, timeout time.Duration) (*tikvrpc.Response, error)

Constants

const (
	ReadTimeoutShort  = 30 * time.Second // For requests that read/write several key-values.
	ReadTimeoutMedium = 60 * time.Second // For requests that may need scan region.

	// MaxWriteExecutionTime is the MaxExecutionDurationMs field for write requests.
	// Because the last deadline check is before proposing, let us give it 10 more seconds
	// after proposing.
	MaxWriteExecutionTime = ReadTimeoutShort - 10*time.Second
)

Timeout durations.

const (
	GrpcInitialWindowSize     = 1 << 30
	GrpcInitialConnWindowSize = 1 << 30
)

Grpc window size

Variables

var (
	// ResourceControlSwitch is used to control whether to enable the resource control.
	ResourceControlSwitch atomic.Value
	// ResourceControlInterceptor is used to build the resource control interceptor.
	ResourceControlInterceptor resourceControlClient.ResourceGroupKVInterceptor
)

var MaxRecvMsgSize = math.MaxInt64 - 1

MaxRecvMsgSize set max gRPC receive message size received from server. If any message size is larger than current value, an error will be reported from gRPC.

Types

type Client

type Client interface {
	// Close should release all data.
	Close() error
	// CloseAddr closes gRPC connections to the address. It will reconnect the next time it's used.
	CloseAddr(addr string) error
	// SendRequest sends Request.
	SendRequest(ctx context.Context, addr string, req *tikvrpc.Request, timeout time.Duration) (*tikvrpc.Response, error)
}

Client is a client that sends RPC. It should not be used after calling Close().

func NewInterceptedClient

func NewInterceptedClient(client Client) Client

NewInterceptedClient creates a Client which can execute interceptor.

func NewReqCollapse

func NewReqCollapse(client Client) Client

NewReqCollapse creates a reqCollapse.

type Opt

type Opt func(*option)

Opt is the option for the client.

func WithCodec

func WithCodec(codec apicodec.Codec) Opt

WithCodec is used to set RPCClient's codec.

func WithGRPCDialOptions

func WithGRPCDialOptions(grpcDialOptions ...grpc.DialOption) Opt

WithGRPCDialOptions is used to set the grpc.DialOption.

func WithSecurity

func WithSecurity(security config.Security) Opt

WithSecurity is used to set the security config.

type RPCClient

type RPCClient struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

RPCClient is RPC client struct. TODO: Add flow control between RPC clients in TiDB ond RPC servers in TiKV. Since we use shared client connection to communicate to the same TiKV, it's possible that there are too many concurrent requests which overload the service of TiKV.

func NewRPCClient

func NewRPCClient(opts ...Opt) *RPCClient

NewRPCClient creates a client that manages connections and rpc calls with tikv-servers.

func (*RPCClient) Close

func (c *RPCClient) Close() error

Close closes all connections.

func (*RPCClient) CloseAddr

func (c *RPCClient) CloseAddr(addr string) error

CloseAddr closes gRPC connections to the address.

func (*RPCClient) SendRequest

func (c *RPCClient) SendRequest(ctx context.Context, addr string, req *tikvrpc.Request, timeout time.Duration) (*tikvrpc.Response, error)

SendRequest sends a Request to server and receives Response.