grpclient

Documentation

Index

• type GrpcClient
  • func NewGRPCClient(cfg *GrpcClientConfig) (*GrpcClient, error)
  • func (c *GrpcClient) Close() error
  • func (c *GrpcClient) Endpoints() []string
  • func (c *GrpcClient) GetCallOpts() []grpc.CallOption
  • func (c *GrpcClient) SetEndpoints(eps ...string)
• type GrpcClientConfig

Types

type GrpcClient

type GrpcClient struct {
	Conn *grpc.ClientConn
	// contains filtered or unexported fields
}

func NewGRPCClient

func NewGRPCClient(cfg *GrpcClientConfig) (*GrpcClient, error)

func (*GrpcClient) Close

func (c *GrpcClient) Close() error

Close shuts down the client's etcd connections.

func (*GrpcClient) Endpoints

func (c *GrpcClient) Endpoints() []string

Endpoints lists the registered endpoints for the client.

func (*GrpcClient) GetCallOpts

func (c *GrpcClient) GetCallOpts() []grpc.CallOption

func (*GrpcClient) SetEndpoints

func (c *GrpcClient) SetEndpoints(eps ...string)

SetEndpoints updates client's endpoints.

type GrpcClientConfig

type GrpcClientConfig struct {
	// Endpoints is a list of URLs.
	Endpoints []string

	// AutoSyncInterval is the interval to update endpoints with its latest members.
	// 0 disables auto-sync. By default auto-sync is disabled.
	AutoSyncInterval time.Duration

	// DialTimeout is the timeout for failing to establish a connection.
	DialTimeout time.Duration

	// DialKeepAliveTime is the time after which client pings the server to see if
	// transport is alive.
	DialKeepAliveTime time.Duration

	// DialKeepAliveTimeout is the time that the client waits for a response for the
	// keep-alive probe. If the response is not received in this time, the connection is closed.
	DialKeepAliveTimeout time.Duration

	// MaxCallSendMsgSize is the client-side request send limit in bytes.
	// If 0, it defaults to 2.0 MiB (2 * 1024 * 1024).
	// Make sure that "MaxCallSendMsgSize" < server-side default send/recv limit.
	// ("--max-request-bytes" flag to etcd or "embed.Config.MaxRequestBytes").
	MaxCallSendMsgSize int

	// MaxCallRecvMsgSize is the client-side response receive limit.
	// If 0, it defaults to "math.MaxInt32", because range response can
	// easily exceed request send limits.
	// Make sure that "MaxCallRecvMsgSize" >= server-side default send/recv limit.
	// ("--max-request-bytes" flag to etcd or "embed.Config.MaxRequestBytes").
	MaxCallRecvMsgSize int

	// DialOptions is a list of dial options for the grpc client (e.g., for interceptors).
	// For example, pass "grpc.WithBlock()" to block until the underlying connection is up.
	// Without this, Dial returns immediately and connecting the server happens in background.
	DialOptions []grpc.DialOption

	// Context is the default client context; it can be used to cancel grpc dial out and
	// other operations that do not have an explicit context.
	Context context.Context

	PermitWithoutStream bool
}