rpcx

Documentation

Index

• func WithStreamClientInterceptors(interceptors ...grpc.StreamClientInterceptor) grpc.DialOption
• func WithStreamServerInterceptors(interceptors ...grpc.StreamServerInterceptor) grpc.ServerOption
• func WithUnaryClientInterceptors(interceptors ...grpc.UnaryClientInterceptor) grpc.DialOption
• func WithUnaryServerInterceptors(interceptors ...grpc.UnaryServerInterceptor) grpc.ServerOption
• type Client
• type ClientConfig
  • func NewClientConfig(host string, name []string) (*ClientConfig, error)
  • func (clientConfig *ClientConfig) WithDefaultServiceConfig() grpc.DialOption
• type ClientOption
  • func WithDialOption(opt grpc.DialOption) ClientOption
  • func WithTimeout(timeout time.Duration) ClientOption
• type ClientOptions
• type DirectClient
  • func NewDirectClient(host string, timeout int64, opts ...ClientOption) (*DirectClient, error)
  • func NewDirectClientV2(clientConfig *ClientConfig) (*DirectClient, error)
  • func (c *DirectClient) Next() (*grpc.ClientConn, bool)
• type RegisterFn
• type RpcServer
  • func NewRpcServer(listenOn string, timeout int64, register RegisterFn) (*RpcServer, error)
  • func (s RpcServer) AddOptions(options ...grpc.ServerOption)
  • func (s RpcServer) AddStreamInterceptors(interceptors ...grpc.StreamServerInterceptor)
  • func (s RpcServer) AddUnaryInterceptors(interceptors ...grpc.UnaryServerInterceptor)
  • func (s *RpcServer) Start()
• type Server

Functions

func WithStreamClientInterceptors

func WithStreamClientInterceptors(interceptors ...grpc.StreamClientInterceptor) grpc.DialOption

func WithStreamServerInterceptors

func WithStreamServerInterceptors(interceptors ...grpc.StreamServerInterceptor) grpc.ServerOption

func WithUnaryClientInterceptors

func WithUnaryClientInterceptors(interceptors ...grpc.UnaryClientInterceptor) grpc.DialOption

func WithUnaryServerInterceptors

func WithUnaryServerInterceptors(interceptors ...grpc.UnaryServerInterceptor) grpc.ServerOption

Types

type Client

type Client interface {
	Next() (*grpc.ClientConn, bool)
}

type ClientConfig

type ClientConfig struct {
	Host                 string            //RPC链接
	Name                 []string          //RPC包名.服务名 如shop_base.ShopBase
	Timeout              string            //超时时间,默认:5s
	MaxAttempts          string            //最大重试次数,必须是大于 1 的整数，对于大于5的值会被视为5,默认:4
	InitialBackoff       string            //第一次重试默认时间间隔,必须具有大于0,默认:2s
	MaxBackoff           string            //最大重试时间间隔,必须具有大于0,默认:3s
	BackoffMultiplier    string            //间隔增量乘数因子,大于零,默认:1
	RetryableStatusCodes []string          //重试会根据请求返回的状态码是否符合 retryableStatusCodes来进行重试请求,默认:UNAVAILABLE
	WaitForReady         string            //如果为false，则RPC将在连接到服务器的瞬间失败时立即中止。否则，gRPC会尝试连接，直到超过截止日期。默认:true
	MaxTokens            string            //如果 token_count <= ( maxTokens / 2), 则关闭重试策略，直到 token_count > (maxTokens/2)，恢复重试,默认10
	TokenRatio           string            //成功 RPC 将会递增 token_count * tokenRatio
	DialOptions          []grpc.DialOption //RPC链接可选参数
}

func NewClientConfig

func NewClientConfig(host string, name []string) (*ClientConfig, error)

@desc RPC客户端初始化链接配置 @auth liuguoqiang 2020-08-12 @param @return

func (*ClientConfig) WithDefaultServiceConfig

func (clientConfig *ClientConfig) WithDefaultServiceConfig() grpc.DialOption

@desc 设置默认配置 @auth liuguoqiang 2020-08-12 @param @return

type ClientOption

type ClientOption func(options *ClientOptions)

func WithDialOption

func WithDialOption(opt grpc.DialOption) ClientOption

func WithTimeout

func WithTimeout(timeout time.Duration) ClientOption

type ClientOptions

type ClientOptions struct {
	Timeout     time.Duration
	DialOptions []grpc.DialOption
}

type DirectClient

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

func NewDirectClient

func NewDirectClient(host string, timeout int64, opts ...ClientOption) (*DirectClient, error)

@desc 初始化客户端 timeout:单位毫秒,默认两秒超时 @auth liuguoqiang 2020-04-21 @param @return

func NewDirectClientV2

func NewDirectClientV2(clientConfig *ClientConfig) (*DirectClient, error)

@desc 初始化客户端 @auth liuguoqiang 2020-04-21 @param @return

func (*DirectClient) Next

func (c *DirectClient) Next() (*grpc.ClientConn, bool)

@desc 返回grpc链接 @auth liuguoqiang 2020-04-21 @param @return

type RegisterFn

type RegisterFn func(*grpc.Server)

type RpcServer

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

func NewRpcServer

func NewRpcServer(listenOn string, timeout int64, register RegisterFn) (*RpcServer, error)

@desc rpc服务端初始化入口函数 @auth liuguoqiang 2020-06-11 @param @return

func (RpcServer) AddOptions

func (s RpcServer) AddOptions(options ...grpc.ServerOption)

func (RpcServer) AddStreamInterceptors

func (s RpcServer) AddStreamInterceptors(interceptors ...grpc.StreamServerInterceptor)

func (RpcServer) AddUnaryInterceptors

func (s RpcServer) AddUnaryInterceptors(interceptors ...grpc.UnaryServerInterceptor)

func (*RpcServer) Start

func (s *RpcServer) Start()

@desc 启动rpc @auth liuguoqiang 2020-06-11 @param @return

type Server

type Server interface {
	AddOptions(options ...grpc.ServerOption)
	AddStreamInterceptors(interceptors ...grpc.StreamServerInterceptor)
	AddUnaryInterceptors(interceptors ...grpc.UnaryServerInterceptor)
	Start(register RegisterFn) error
}