server

Documentation

Index

• Constants
• type HealhCheck
  • func NewHealhCheck() *HealhCheck
  • func (hc *HealhCheck) Check(context.Context, *health.HealthCheckRequest) (*health.HealthCheckResponse, error)
  • func (hc *HealhCheck) Watch(*health.HealthCheckRequest, health.Health_WatchServer) error
• type HealthCheckStatus
• type Server
  • func NewServer(adapter *adapters.GRPCAdapter) (*Server, error)
  • func (srv *Server) GracefulShutdown(cb func(os.Signal))
  • func (srv *Server) Start(port int) error

Constants

const (
	HealthCheckStatus_UNKNOWN         = 0
	HealthCheckStatus_SERVING         = 1
	HealthCheckStatus_NOT_SERVING     = 2
	HealthCheckStatus_SERVICE_UNKNOWN = 3 // Used only by the Watch method.
)

Types

type HealhCheck

type HealhCheck struct {
	Status HealthCheckStatus
}

HealhCheck

func NewHealhCheck

func NewHealhCheck() *HealhCheck

func (*HealhCheck) Check

func (hc *HealhCheck) Check(context.Context, *health.HealthCheckRequest) (*health.HealthCheckResponse, error)

If the requested service is unknown, the call will fail with status NOT_FOUND.

func (*HealhCheck) Watch

func (hc *HealhCheck) Watch(*health.HealthCheckRequest, health.Health_WatchServer) error

Performs a watch for the serving status of the requested service. The server will immediately send back a message indicating the current serving status. It will then subsequently send a new message whenever the service's serving status changes.

If the requested service is unknown when the call is received, the server will send a message setting the serving status to SERVICE_UNKNOWN but will *not* terminate the call. If at some future point, the serving status of the service becomes known, the server will send a new message with the service's serving status.

If the call terminates with status UNIMPLEMENTED, then clients should assume this method is not supported and should not retry the call. If the call terminates with any other status (including OK), clients should retry the call with appropriate exponential backoff.

type HealthCheckStatus

type HealthCheckStatus int32

type Server

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

func NewServer

func NewServer(adapter *adapters.GRPCAdapter) (*Server, error)

NewServer

func (*Server) GracefulShutdown

func (srv *Server) GracefulShutdown(cb func(os.Signal))

GracefulShutdown

func (*Server) Start

func (srv *Server) Start(port int) error

StartServer