grpc

Documentation

Index

• Constants
• type Closeable
• type Container
  • func (c *Container) Addr() string
  • func (c *Container) AddrOrPanic() string
  • func (c *Container) NewHealthCheckClient() (service.HealthChecker, error)
• type HealthCheckClient
  • func NewHelthCheckClient(ctx context.Context, addr string, name string, d service.GrpcDialer) (*HealthCheckClient, error)
  • func NewHelthCheckClientWithConn(conn *grpc.ClientConn, name string) (*HealthCheckClient, error)
  • func (c *HealthCheckClient) Check(ctx context.Context) (healthpb.HealthCheckResponse_ServingStatus, error)
  • func (c *HealthCheckClient) CheckOk(ctx context.Context) error
  • func (c *HealthCheckClient) Close() error
• type HealthCheckFn
• type NewServiceFn
• type Option
  • func WithAddr(a string) Option
  • func WithContext(ctx context.Context) Option
  • func WithHealthCheckFn(healthCheck HealthCheckFn) Option
  • func WithListener(l service.GrpcListener) Option
  • func WithName(n string) Option
  • func WithNewServiceFn(newService NewServiceFn) Option
  • func WithPProfAddr(addr *string) Option
  • func WithProfilingEnabled(p bool) Option
  • func WithServiceDesc(serviceDesc *grpc.ServiceDesc) Option
• type Options
• type Service
  • func New(opts ...Option) (*Service, error)
  • func (g *Service) Addr() string
  • func (g *Service) Dial(d service.GrpcDialer) (*grpc.ClientConn, error)
  • func (g *Service) Dispose()
  • func (g *Service) DoServe(listener net.Listener) error
  • func (g *Service) Metadata() map[string]string
  • func (g *Service) Name() string
  • func (g *Service) NewHelthCheckClient(d service.GrpcDialer) (*HealthCheckClient, error)
  • func (g *Service) Serve() error
  • func (g *Service) Stop()

Constants

const Kind = service.GRPC

Types

type Closeable

type Closeable interface {
	Close() error
}

type Container

type Container struct {
	service.GrpcConn
	Svc  *Service
	Name string
}

func (*Container) Addr

func (c *Container) Addr() string

func (*Container) AddrOrPanic

func (c *Container) AddrOrPanic() string

func (*Container) NewHealthCheckClient

func (c *Container) NewHealthCheckClient() (service.HealthChecker, error)

type HealthCheckClient

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

func NewHelthCheckClient

func NewHelthCheckClient(ctx context.Context, addr string, name string, d service.GrpcDialer) (*HealthCheckClient, error)

func NewHelthCheckClientWithConn

func NewHelthCheckClientWithConn(conn *grpc.ClientConn, name string) (*HealthCheckClient, error)

func (*HealthCheckClient) Check

func (c *HealthCheckClient) Check(ctx context.Context) (healthpb.HealthCheckResponse_ServingStatus, error)

func (*HealthCheckClient) CheckOk

func (c *HealthCheckClient) CheckOk(ctx context.Context) error

func (*HealthCheckClient) Close

func (c *HealthCheckClient) Close() error

type HealthCheckFn

type HealthCheckFn func(context.Context) error

type NewServiceFn

type NewServiceFn func(context.Context) (any, error)

type Option

type Option interface {
	Apply(*Options)
}

func WithAddr

func WithAddr(a string) Option

Setters

func WithContext

func WithContext(ctx context.Context) Option

func WithHealthCheckFn

func WithHealthCheckFn(healthCheck HealthCheckFn) Option

func WithListener

func WithListener(l service.GrpcListener) Option

func WithName

func WithName(n string) Option

func WithNewServiceFn

func WithNewServiceFn(newService NewServiceFn) Option

func WithPProfAddr

func WithPProfAddr(addr *string) Option

func WithProfilingEnabled

func WithProfilingEnabled(p bool) Option

func WithServiceDesc

func WithServiceDesc(serviceDesc *grpc.ServiceDesc) Option

type Options

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

type Service

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

func New

func New(opts ...Option) (*Service, error)

func (*Service) Addr

func (g *Service) Addr() string

func (*Service) Dial

func (g *Service) Dial(d service.GrpcDialer) (*grpc.ClientConn, error)

func (*Service) Dispose

func (g *Service) Dispose()

func (*Service) DoServe

func (g *Service) DoServe(listener net.Listener) error

func (*Service) Metadata

func (g *Service) Metadata() map[string]string

func (*Service) Name

func (g *Service) Name() string

func (*Service) NewHelthCheckClient

func (g *Service) NewHelthCheckClient(d service.GrpcDialer) (*HealthCheckClient, error)

func (*Service) Serve

func (g *Service) Serve() error

func (*Service) Stop

func (g *Service) Stop()