grpc

Documentation

Index

• type Client
  • func (c *Client) Close()
  • func (c *Client) Conn(service string, opts ...Option) (*grpc.ClientConn, error)
• type Config
  • func DefaultConfig() *Config
  • func RawConfig(key string) *Config
  • func ScanConfig(name string) *Config
  • func (c *Config) Build() *Client
  • func (c *Config) WithLogger(log *logger.Logger) *Config
  • func (c *Config) WithRegistry(registry registry.Registry) *Config
• type Option
  • func DialOption(dialOption ...grpc.DialOption) Option
  • func Region(region string) Option
  • func Version(v string) Option
  • func Zone(zone string) Option
• type Options

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client 客户端

func (*Client) Close

func (c *Client) Close()

Close 关闭客户端

func (*Client) Conn

func (c *Client) Conn(service string, opts ...Option) (*grpc.ClientConn, error)

Conn 获取连接

type Config

type Config struct {
	Debug         bool                        // 是否开启调试模式
	Block         bool                        // 等待连接启动再返回
	ReadTimeout   time.Duration               // 调用超时时间
	DialTimeout   time.Duration               // 调用超时时间
	SlowThreshold time.Duration               // 超时阈值
	Balancer      string                      // 负载均衡策略
	Secure        bool                        // 安全链接
	KeepAlive     *keepalive.ClientParameters // 存活策略
	// contains filtered or unexported fields
}

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig 默认配置

func RawConfig

func RawConfig(key string) *Config

RawConfig 读取配置

func ScanConfig

func ScanConfig(name string) *Config

ScanConfig 根据name扫描配置

func (*Config) Build

func (c *Config) Build() *Client

Build 构建grpc客户端

func (*Config) WithLogger

func (c *Config) WithLogger(log *logger.Logger) *Config

WithLogger 设置日志组件

func (*Config) WithRegistry

func (c *Config) WithRegistry(registry registry.Registry) *Config

WithRegistry 设置注册中心

type Option

type Option func(opt *Options)

func DialOption

func DialOption(dialOption ...grpc.DialOption) Option

DialOption 设置调用参数

func Region

func Region(region string) Option

Region 指定地域

func Version

func Version(v string) Option

Version 调用服务的版本

func Zone

func Zone(zone string) Option

Zone 指定地区

type Options

type Options struct {
	// 额外的调用参数
	DialOptions []grpc.DialOption
	// 附加信息
	Authority *resolver.Authority
}