grpc

Documentation

Index

• func Dial(ctx context.Context, opts ...ClientOption) (*grpc.ClientConn, error)
• func DialInsecure(ctx context.Context, opts ...ClientOption) (*grpc.ClientConn, error)
• func NewWrappedStream(ctx context.Context, stream grpc.ServerStream) grpc.ServerStream
• type ClientOption
  • func WithBalancerName(name string) ClientOption
  • func WithClientOptions(opts ...grpc.DialOption) ClientOption
  • func WithClientStreamInterceptor(in ...grpc.StreamClientInterceptor) ClientOption
  • func WithClientTimeout(timeout time.Duration) ClientOption
  • func WithClientUnaryInterceptor(in ...grpc.UnaryClientInterceptor) ClientOption
  • func WithDiscovery(d registry.Discovery) ClientOption
  • func WithEnableTracing(enable bool) ClientOption
  • func WithEndpoint(endpoint string) ClientOption
  • func WithMetric(metric metric.GrpcClientMetric) ClientOption
• type Server
  • func NewServer(opts ...ServerOption) *Server
  • func (s *Server) Endpoint() (*url.URL, error)
  • func (s *Server) Start(ctx context.Context) error
  • func (s *Server) Stop(_ context.Context) error
• type ServerOption
  • func WithAddress(address string) ServerOption
  • func WithGrpcOpts(opts ...grpc.ServerOption) ServerOption
  • func WithListener(lis net.Listener) ServerOption
  • func WithNetwork(network string) ServerOption
  • func WithStreamInterceptor(in ...grpc.StreamServerInterceptor) ServerOption
  • func WithUnaryInterceptor(in ...grpc.UnaryServerInterceptor) ServerOption
• type Transport
  • func (tr *Transport) Endpoint() string
  • func (tr *Transport) Kind() transport.Kind
  • func (tr *Transport) Operation() string
  • func (tr *Transport) ReplyHeader() transport.Header
  • func (tr *Transport) RequestHeader() transport.Header

Functions

func Dial

func Dial(ctx context.Context, opts ...ClientOption) (*grpc.ClientConn, error)

func DialInsecure

func DialInsecure(ctx context.Context, opts ...ClientOption) (*grpc.ClientConn, error)

func NewWrappedStream

func NewWrappedStream(ctx context.Context, stream grpc.ServerStream) grpc.ServerStream

Types

type ClientOption

type ClientOption func(o *clientOptions)

func WithBalancerName

func WithBalancerName(name string) ClientOption

设置负载均衡器

func WithClientOptions

func WithClientOptions(opts ...grpc.DialOption) ClientOption

设置grpc的dial选项

func WithClientStreamInterceptor

func WithClientStreamInterceptor(in ...grpc.StreamClientInterceptor) ClientOption

设置stream拦截器

func WithClientTimeout

func WithClientTimeout(timeout time.Duration) ClientOption

设置超时时间

func WithClientUnaryInterceptor

func WithClientUnaryInterceptor(in ...grpc.UnaryClientInterceptor) ClientOption

设置拦截器

func WithDiscovery

func WithDiscovery(d registry.Discovery) ClientOption

设置服务发现

func WithEnableTracing

func WithEnableTracing(enable bool) ClientOption

func WithEndpoint

func WithEndpoint(endpoint string) ClientOption

设置地址

func WithMetric

func WithMetric(metric metric.GrpcClientMetric) ClientOption

type Server

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

Server is a gRPC server wrapper.

func NewServer

func NewServer(opts ...ServerOption) *Server

NewServer creates a gRPC server by options.

func (*Server) Endpoint

func (s *Server) Endpoint() (*url.URL, error)

Endpoint return a real address to registry endpoint. examples:

grpc://127.0.0.1:9000?isSecure=false

func (*Server) Start

func (s *Server) Start(ctx context.Context) error

Start start the gRPC server.

func (*Server) Stop

func (s *Server) Stop(_ context.Context) error

Stop stop the gRPC server.

type ServerOption

type ServerOption func(o *Server)

ServerOption is gRPC server option.

func WithAddress

func WithAddress(address string) ServerOption

func WithGrpcOpts

func WithGrpcOpts(opts ...grpc.ServerOption) ServerOption

WithGrpcOpts with grpc options.

func WithListener

func WithListener(lis net.Listener) ServerOption

Listener with server lis

func WithNetwork

func WithNetwork(network string) ServerOption

func WithStreamInterceptor

func WithStreamInterceptor(in ...grpc.StreamServerInterceptor) ServerOption

WithStreamInterceptor returns a ServerOption that sets the StreamServerInterceptor for the server.

func WithUnaryInterceptor

func WithUnaryInterceptor(in ...grpc.UnaryServerInterceptor) ServerOption

WithUnaryInterceptor returns a ServerOption that sets the UnaryServerInterceptor for the server.

type Transport

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

Transport is a gRPC transport.

func (*Transport) Endpoint

func (tr *Transport) Endpoint() string

Endpoint returns the transport endpoint.

func (*Transport) Kind

func (tr *Transport) Kind() transport.Kind

Kind returns the transport kind.

func (*Transport) Operation

func (tr *Transport) Operation() string

Operation returns the transport operation.

func (*Transport) ReplyHeader

func (tr *Transport) ReplyHeader() transport.Header

ReplyHeader returns the reply header.

func (*Transport) RequestHeader

func (tr *Transport) RequestHeader() transport.Header

RequestHeader returns the request header.