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
• func SetGlobalBalancer(scheme string, builder selector.Builder)
• type Builder
  • func (b *Builder) Build(info base.PickerBuildInfo) gBalancer.Picker
• type ClientOption
  • func WithBalancerName(name string) ClientOption
  • func WithDiscovery(d registry.Discovery) ClientOption
  • func WithEndpoint(endpoint string) ClientOption
  • func WithFilter(filters ...selector.Filter) ClientOption
  • func WithLogger(log log.Logger) ClientOption
  • func WithMiddleware(m ...middleware.Middleware) ClientOption
  • func WithOptions(opts ...grpc.DialOption) ClientOption
  • func WithTLSConfig(c *tls.Config) ClientOption
  • func WithTimeout(timeout time.Duration) ClientOption
  • func WithUnaryInterceptor(in ...grpc.UnaryClientInterceptor) ClientOption
• type Picker
  • func (p *Picker) Pick(info gBalancer.PickInfo) (gBalancer.PickResult, error)
• 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(ctx context.Context) error
  • func (s *Server) Use(selector string, m ...middleware.Middleware)
• type ServerOption
  • func Address(addr string) ServerOption
  • func Listener(lis net.Listener) ServerOption
  • func Logger(logger log.Logger) ServerOption
  • func Middleware(m ...middleware.Middleware) ServerOption
  • func Network(network string) ServerOption
  • func Options(opts ...grpc.ServerOption) ServerOption
  • func StreamInterceptor(in ...grpc.StreamServerInterceptor) ServerOption
  • func TLSConfig(c *tls.Config) ServerOption
  • func Timeout(timeout time.Duration) ServerOption
  • func UnaryInterceptor(in ...grpc.UnaryServerInterceptor) ServerOption
• type Trailer
  • func (t Trailer) Get(k string) string
• 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
  • func (tr *Transport) SelectFilters() []selector.Filter

Functions

func Dial

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

Dial returns a GRPC connection.

func DialInsecure

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

DialInsecure returns an insecure GRPC connection.

func NewWrappedStream

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

func SetGlobalBalancer

func SetGlobalBalancer(scheme string, builder selector.Builder)

SetGlobalBalancer set grpc balancer with scheme.

Types

type Builder

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

Builder is grpc balancer builder.

func (*Builder) Build

func (b *Builder) Build(info base.PickerBuildInfo) gBalancer.Picker

Build creates a grpc Picker.

type ClientOption

type ClientOption func(o *clientOptions)

ClientOption is gRPC client option.

func WithBalancerName

func WithBalancerName(name string) ClientOption

WithBalancerName with balancer name

func WithDiscovery

func WithDiscovery(d registry.Discovery) ClientOption

WithDiscovery with client discovery.

func WithEndpoint

func WithEndpoint(endpoint string) ClientOption

WithEndpoint with client endpoint.

func WithFilter

func WithFilter(filters ...selector.Filter) ClientOption

WithFilter with select filters

func WithLogger

func WithLogger(log log.Logger) ClientOption

WithLogger with logger Deprecated: use global logger instead.

func WithMiddleware

func WithMiddleware(m ...middleware.Middleware) ClientOption

WithMiddleware with client middleware.

func WithOptions

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

WithOptions with gRPC options.

func WithTLSConfig

func WithTLSConfig(c *tls.Config) ClientOption

WithTLSConfig with TLS config.

func WithTimeout

func WithTimeout(timeout time.Duration) ClientOption

WithTimeout with client timeout.

func WithUnaryInterceptor

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

WithUnaryInterceptor returns a DialOption that specifies the interceptor for unary RPCs.

type Picker

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

Picker is a grpc picker.

func (*Picker) Pick

func (p *Picker) Pick(info gBalancer.PickInfo) (gBalancer.PickResult, error)

Pick pick instances.

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(ctx context.Context) error

Stop stop the gRPC server.

func (*Server) Use

func (s *Server) Use(selector string, m ...middleware.Middleware)

Use uses a service middleware with selector. selector:

• '/*'
• '/helloworld.v1.Greeter/*'
• '/helloworld.v1.Greeter/SayHello'

type ServerOption

type ServerOption func(o *Server)

ServerOption is gRPC server option.

func Address

func Address(addr string) ServerOption

Address with server address.

func Listener

func Listener(lis net.Listener) ServerOption

Listener with server lis

func Logger

func Logger(logger log.Logger) ServerOption

Logger with server logger. Deprecated: use global logger instead.

func Middleware

func Middleware(m ...middleware.Middleware) ServerOption

Middleware with server middleware.

func Network

func Network(network string) ServerOption

Network with server network.

func Options

func Options(opts ...grpc.ServerOption) ServerOption

Options with grpc options.

func StreamInterceptor

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

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

func TLSConfig

func TLSConfig(c *tls.Config) ServerOption

TLSConfig with TLS config.

func Timeout

func Timeout(timeout time.Duration) ServerOption

Timeout with server timeout.

func UnaryInterceptor

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

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

type Trailer

type Trailer metadata.MD

Trailer is a grpc trailder MD.

func (Trailer) Get

func (t Trailer) Get(k string) string

Get get a grpc trailer value.

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.

func (*Transport) SelectFilters

func (tr *Transport) SelectFilters() []selector.Filter

SelectFilters returns the client select filters.