grpc

Documentation

Overview

Package grpc provides the hiboot starter for injectable grpc client and server dependency

Index

• Constants
• Variables
• func Connect(address string, tracer jaeger.Tracer) (conn *grpc.ClientConn, err error)
• func RegisterClient(name string, clientConstructors ...interface{})
• func RegisterServer(register interface{}, server interface{})
• type ClientConn
• type ClientConnector
• type ClientFactory
• type ClientProperties
• type HealthCheckService
  • func NewHealthCheckService(healthClient pb.HealthClient) *HealthCheckService
  • func (c *HealthCheckService) Name() (name string)
  • func (c *HealthCheckService) Status() (up bool)
• type ServerFactory

Constants

const (
	// Profile is the profile of grpc, it should be as same as the package name
	Profile = "grpc"
)

Variables

var (
	Header = grpc.Header
	Server = RegisterServer
)

var Client = RegisterClient

Client register client from application, it is a alias to RegisterClient

Functions

func Connect

func Connect(address string, tracer jaeger.Tracer) (conn *grpc.ClientConn, err error)

func RegisterClient

func RegisterClient(name string, clientConstructors ...interface{})

RegisterClient register client from application

func RegisterServer

func RegisterServer(register interface{}, server interface{})

RegisterServer register server from application

Types

type ClientConn

type ClientConn grpc.ClientConn

type ClientConnector

type ClientConnector interface {
	// Connect connect the gRPC client
	ConnectWithName(name string, cb interface{}, prop *ClientProperties) (gRPCCli interface{}, err error)
	Connect(address string) (conn *grpc.ClientConn, err error)
}

ClientConnector interface is response for creating grpc client connection

type ClientFactory

type ClientFactory interface {
}

ClientFactory build grpc clients

type ClientProperties

type ClientProperties struct {
	Host      string    `json:"host"`
	Port      string    `json:"port" default:"7575"`
	PlainText bool      `json:"plain_text" default:"true"`
	KeepAlive keepAlive `json:"keep_alive"`
}

ClientProperties used for grpc client injection

type HealthCheckService

type HealthCheckService struct {
	at.HealthCheckService
	// contains filtered or unexported fields
}

controller

func NewHealthCheckService

func NewHealthCheckService(healthClient pb.HealthClient) *HealthCheckService

NewHealthCheckService is the constructor of healthCheckService

func (*HealthCheckService) Name

func (c *HealthCheckService) Name() (name string)

Status return health check display name grpc

func (*HealthCheckService) Status

func (c *HealthCheckService) Status() (up bool)

Status return grpc health check status as bool

type ServerFactory

type ServerFactory interface {
}

ServerFactory build grpc servers