xrpc

Documentation

Index

• Constants
• func DeregisterClient(name string)
• func DeregisterServer(name string)
• func IsIpPortAddr(addr string) (ip string, port int, ok bool)
• func NewBuilder() container.StandardBuilder
• func RegisterClient(resolver ClientResover)
• func RegisterServer(resolver ServerResolver)
• type Body
• type Client
• type ClientResover
• type Config
• type Options
• type RequestOption
  • func WithContentType(contentType string) RequestOption
  • func WithHeaders(header map[string]string) RequestOption
  • func WithMethod(method string) RequestOption
  • func WithQuery(query string) RequestOption
  • func WithSourceName() RequestOption
  • func WithWaitForReady(waitForReady bool) RequestOption
  • func WithXRequestID(requestID string) RequestOption
• type Server
  • func NewServer(proto string, router *engine.RouterGroup, cfg config.Config, ...) (Server, error)
• type ServerResolver
• type StandardRPC

Constants

const TypeNode = "rpcs"

Functions

func DeregisterClient

func DeregisterClient(name string)

Deregister 清理配置适配器

func DeregisterServer

func DeregisterServer(name string)

Deregister 清理配置适配器

func IsIpPortAddr

func IsIpPortAddr(addr string) (ip string, port int, ok bool)

func NewBuilder

func NewBuilder() container.StandardBuilder

func RegisterClient

func RegisterClient(resolver ClientResover)

Register 注册配置文件适配器

func RegisterServer

func RegisterServer(resolver ServerResolver)

Register 注册配置文件适配器

Types

type Body

type Body interface {
	GetStatus() int32
	GetHeader() map[string]string
	GetResult() []byte
}

type Client

type Client interface {
	//Swap 将当前请求参数作为RPC参数并发送RPC请求
	Swap(ctx context.Context, service string, opts ...RequestOption) (res Body, err error)

	//RequestByCtx RPC请求，可通过context撤销请求
	Request(ctx sctx.Context, service string, input interface{}, opts ...RequestOption) (res Body, err error)
}

type ClientResover

type ClientResover interface {
	Name() string
	Resolve(name string, setting config.Config) (Client, error)
}

ClientResover 定义配置文件转换方法

type Config

type Config struct {
	Addr           string        `json:"addr"`
	Proto          string        `json:"proto"`
	Status         engine.Status `json:"status"`
	MaxRecvMsgSize int           `json:"max_recv_msg_size"`
	MaxSendMsgSize int           `json:"max_send_msg_size"`
}

type Options

type Options struct {
	Header       xtypes.SMap
	Method       string
	Query        string
	WaitForReady bool
}

type RequestOption

type RequestOption func(*Options)

func WithContentType

func WithContentType(contentType string) RequestOption

func WithHeaders

func WithHeaders(header map[string]string) RequestOption

func WithMethod

func WithMethod(method string) RequestOption

func WithQuery

func WithQuery(query string) RequestOption

func WithSourceName

func WithSourceName() RequestOption

func WithWaitForReady

func WithWaitForReady(waitForReady bool) RequestOption

func WithXRequestID

func WithXRequestID(requestID string) RequestOption

type Server

type Server interface {
	GetProto() string
	GetAddr() string
	Serve(ctx context.Context) (err error)
	Stop(ctx context.Context) error
}

func NewServer

func NewServer(proto string,
	router *engine.RouterGroup,
	cfg config.Config,
	opts ...engine.Option) (Server, error)

NewServer 根据适配器名称及参数返回配置处理器

type ServerResolver

type ServerResolver interface {
	Name() string
	Resolve(name string,
		router *engine.RouterGroup,
		cfg config.Config,
		opts ...engine.Option) (Server, error)
}

ServerResover 定义配置文件转换方法

type StandardRPC

type StandardRPC interface {
	GetRPC(name string) (c Client)
}