rpc

Documentation

Index

• func AuthMiddleware(authFunc func(ctx context.Context) error) endpoint.Middleware
• func CircuitBreakerMiddleware() endpoint.Middleware
• func LoadBalanceMiddleware() endpoint.Middleware
• func LoggingMiddleware() endpoint.Middleware
• func MetricsMiddleware() endpoint.Middleware
• func NewClientWithConfig(config ClientConfig) []client.Option
• func NewServerWithConfig(config ServerConfig) []server.Option
• func RecoveryMiddleware() endpoint.Middleware
• func RetryMiddleware(maxRetries int) endpoint.Middleware
• type Client
  • func NewClient(serviceName string, opts ...client.Option) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) GetOptions() []client.Option
• type ClientConfig
• type ClientMiddleware
• type Server
  • func NewServer(addr string, opts ...server.Option) *Server
  • func (s *Server) GetOptions() []server.Option
• type ServerConfig
• type ServerMiddleware

Functions

func AuthMiddleware

func AuthMiddleware(authFunc func(ctx context.Context) error) endpoint.Middleware

AuthMiddleware 认证中间件

func CircuitBreakerMiddleware

func CircuitBreakerMiddleware() endpoint.Middleware

CircuitBreakerMiddleware 熔断中间件（客户端）

func LoadBalanceMiddleware

func LoadBalanceMiddleware() endpoint.Middleware

LoadBalanceMiddleware 负载均衡中间件（客户端）

func LoggingMiddleware

func LoggingMiddleware() endpoint.Middleware

LoggingMiddleware 日志中间件

func MetricsMiddleware

func MetricsMiddleware() endpoint.Middleware

MetricsMiddleware 指标中间件

func NewClientWithConfig

func NewClientWithConfig(config ClientConfig) []client.Option

NewClientWithConfig 使用配置创建客户端选项

func NewServerWithConfig

func NewServerWithConfig(config ServerConfig) []server.Option

NewServerWithConfig 使用配置创建服务器选项

func RecoveryMiddleware

func RecoveryMiddleware() endpoint.Middleware

RecoveryMiddleware 恢复中间件

func RetryMiddleware

func RetryMiddleware(maxRetries int) endpoint.Middleware

RetryMiddleware 重试中间件（客户端）

Types

type Client

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

Client Kitex RPC 客户端封装

func NewClient

func NewClient(serviceName string, opts ...client.Option) (*Client, error)

NewClient 创建 Kitex RPC 客户端选项 注意：此函数返回选项列表，实际的客户端需要使用Kitex生成的NewClient创建

func (*Client) Close

func (c *Client) Close() error

Close 关闭客户端（Kitex客户端无需显式关闭）

func (*Client) GetOptions

func (c *Client) GetOptions() []client.Option

GetOptions 获取客户端选项

type ClientConfig

type ClientConfig struct {
	ServiceName       string
	HostPorts         []string
	Middlewares       []endpoint.Middleware
	ConnectTimeout    int64
	RPCTimeout        int64
	TransportProtocol string
}

ClientConfig Kitex 客户端配置

type ClientMiddleware

type ClientMiddleware = endpoint.Middleware

ClientMiddleware Kitex 客户端中间件类型

type Server

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

Server Kitex RPC 服务器封装

func NewServer

func NewServer(addr string, opts ...server.Option) *Server

NewServer 创建 Kitex RPC 服务器 注意：此函数返回一个服务器包装器，实际的服务器需要在调用Kitex生成的RegisterService时创建

func (*Server) GetOptions

func (s *Server) GetOptions() []server.Option

GetOptions 获取服务器选项

type ServerConfig

type ServerConfig struct {
	Address           string
	ServiceName       string
	Middlewares       []endpoint.Middleware
	TransportProtocol string // "ttheader", "framed", "pure_payload"
}

ServerConfig Kitex 服务器配置

type ServerMiddleware

type ServerMiddleware = endpoint.Middleware

ServerMiddleware Kitex 服务器中间件类型 由于Kitex中间件类型定义较复杂，这里提供辅助函数创建