README
¶
$ mkdir grpc_health_v1
$ protoc --proto_path=v1 --go_out=grpc_health_v1 --go_opt=paths=source_relative \
--go-grpc_out=grpc_health_v1 --go-grpc_opt=paths=source_relative health.proto
Documentation
¶
Index ¶
- type Server
- func (s *Server) Check(ctx context.Context, in *pb.HealthCheckRequest) (*pb.HealthCheckResponse, error)
- func (s *Server) Resume()
- func (s *Server) SetServingStatus(service string, servingStatus pb.HealthCheckResponse_ServingStatus)
- func (s *Server) Shutdown()
- func (s *Server) Watch(in *pb.HealthCheckRequest, stream pb.Health_WatchServer) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Server ¶
type Server struct {
pb.UnimplementedHealthServer
// contains filtered or unexported fields
}
func (*Server) Check ¶
func (s *Server) Check(ctx context.Context, in *pb.HealthCheckRequest) (*pb.HealthCheckResponse, error)
func (*Server) Resume ¶
func (s *Server) Resume()
Resume sets all serving status to SERVING, and configures the server to accept all future status changes. This changes serving status for all services. To set status for a particular services, call SetServingStatus().
func (*Server) SetServingStatus ¶
func (s *Server) SetServingStatus(service string, servingStatus pb.HealthCheckResponse_ServingStatus)
SetServingStatus is called when need to reset the serving status of a service or insert a new service entry into the statusMap.
func (*Server) Shutdown ¶
func (s *Server) Shutdown()
Shutdown sets all serving status to NOT_SERVING, and configures the server to ignore all future status changes. This changes serving status for all services. To set status for a particular services, call SetServingStatus().
func (*Server) Watch ¶
func (s *Server) Watch(in *pb.HealthCheckRequest, stream pb.Health_WatchServer) error
Watch implements `service Health`.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.