egrpc

Documentation

Index

• Constants
• type Component
  • func (c *Component) Error() error
• type Config
  • func DefaultConfig() *Config
• type Container
  • func DefaultContainer() *Container
  • func Load(key string) *Container
  • func (c *Container) Build(options ...Option) *Component
• type Option
  • func WithAddr(addr string) Option
  • func WithBalancerName(balancerName string) Option
  • func WithBufnetServerListener(svc net.Listener) Option
  • func WithDebug(enableDebug bool) Option
  • func WithDialOption(opts ...grpc.DialOption) Option
  • func WithDialTimeout(t time.Duration) Option
  • func WithEnableAccessInterceptor(enableAccessInterceptor bool) Option
  • func WithEnableAccessInterceptorReq(enableAccessInterceptorReq bool) Option
  • func WithEnableAccessInterceptorRes(enableAccessInterceptorRes bool) Option
  • func WithMaxRecvMsgSize(maxRecvMsgSize int) Option
  • func WithName(name string) Option
  • func WithOnFail(onFail string) Option
  • func WithReadTimeout(t time.Duration) Option

Constants

const DefaultMaxCallRecvMsgSize = 1024 * 1024 * 4

const PackageName = "client.egrpc"

PackageName 设置包名

Types

type Component

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

Component 组件

func (*Component) Error

func (c *Component) Error() error

Error 错误信息

type Config

type Config struct {
	Addr                       string        // 连接地址，直连为127.0.0.1:9001，服务发现为etcd:///appname
	BalancerName               string        // 负载均衡方式，默认round robin
	OnFail                     string        // 失败后的处理方式，panic | error
	DialTimeout                time.Duration // 连接超时，默认3s
	ReadTimeout                time.Duration // 读超时，默认1s
	SlowLogThreshold           time.Duration // 慢日志记录的阈值，默认600ms
	EnableBlock                bool          // 是否开启阻塞，默认开启
	EnableOfficialGrpcLog      bool          // 是否开启官方grpc日志，默认关闭
	EnableWithInsecure         bool          // 是否开启非安全传输，默认开启
	EnableMetricInterceptor    bool          // 是否开启监控，默认开启
	EnableTraceInterceptor     bool          // 是否开启链路追踪，默认开启
	EnableAppNameInterceptor   bool          // 是否开启传递应用名，默认开启
	EnableTimeoutInterceptor   bool          // 是否开启超时传递，默认开启
	EnableAccessInterceptor    bool          // 是否开启记录请求数据，默认不开启
	EnableAccessInterceptorReq bool          // 是否开启记录请求参数，默认不开启
	EnableAccessInterceptorRes bool          // 是否开启记录响应参数，默认不开启
	// EnableCPUUsage               bool          // 是否开启CPU利用率，默认开启
	EnableServiceConfig          bool // 是否开启服务配置，默认开启
	EnableFailOnNonTempDialError bool
	MaxCallRecvMsgSize           int // 最大接收消息大小，默认4MB
	// contains filtered or unexported fields
}

Config ...

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig defines grpc client default configuration User should construct config base on DefaultConfig

type Container

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

Container defines a component instance.

func DefaultContainer

func DefaultContainer() *Container

DefaultContainer returns an default container.

func Load

func Load(key string) *Container

Load parses container configuration from configuration provider, such as a toml file, then use the configuration to construct a component container.

func (*Container) Build

func (c *Container) Build(options ...Option) *Component

Build constructs a specific component from container.

type Option

type Option func(c *Container)

Option overrides a Container's default configuration.

func WithAddr

func WithAddr(addr string) Option

WithAddr setting grpc server address

func WithBalancerName

func WithBalancerName(balancerName string) Option

WithBalancerName setting grpc load balancer name

func WithBufnetServerListener

func WithBufnetServerListener(svc net.Listener) Option

WithBufnetServerListener 写入bufnet listener

func WithDebug

func WithDebug(enableDebug bool) Option

WithDebug setting if enable debug mode

func WithDialOption

func WithDialOption(opts ...grpc.DialOption) Option

WithDialOption setting grpc dial options

func WithDialTimeout

func WithDialTimeout(t time.Duration) Option

WithDialTimeout setting grpc dial timeout

func WithEnableAccessInterceptor

func WithEnableAccessInterceptor(enableAccessInterceptor bool) Option

WithEnableAccessInterceptor 开启日志记录

func WithEnableAccessInterceptorReq

func WithEnableAccessInterceptorReq(enableAccessInterceptorReq bool) Option

WithEnableAccessInterceptorReq 开启日志请求参数

func WithEnableAccessInterceptorRes

func WithEnableAccessInterceptorRes(enableAccessInterceptorRes bool) Option

WithEnableAccessInterceptorRes 开启日志响应记录

func WithMaxRecvMsgSize

func WithMaxRecvMsgSize(maxRecvMsgSize int) Option

WithMaxRecvMsgSize 设置最大接收消息大小

func WithName

func WithName(name string) Option

WithName name

func WithOnFail

func WithOnFail(onFail string) Option

WithOnFail setting failing mode

func WithReadTimeout

func WithReadTimeout(t time.Duration) Option

WithReadTimeout setting grpc read timeout