grpc: google.golang.org/grpc/health/grpc_health_v1 Index | Files

package grpc_health_v1

import "google.golang.org/grpc/health/grpc_health_v1"

Index

Package Files

health.pb.go

Variables

var HealthCheckResponse_ServingStatus_name = map[int32]string{
    0:  "UNKNOWN",
    1:  "SERVING",
    2:  "NOT_SERVING",
    3:  "SERVICE_UNKNOWN",
}
var HealthCheckResponse_ServingStatus_value = map[string]int32{
    "UNKNOWN":         0,
    "SERVING":         1,
    "NOT_SERVING":     2,
    "SERVICE_UNKNOWN": 3,
}

func RegisterHealthServer Uses

func RegisterHealthServer(s *grpc.Server, srv HealthServer)

type HealthCheckRequest Uses

type HealthCheckRequest struct {
    Service              string   `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

func (*HealthCheckRequest) Descriptor Uses

func (*HealthCheckRequest) Descriptor() ([]byte, []int)

func (*HealthCheckRequest) GetService Uses

func (m *HealthCheckRequest) GetService() string

func (*HealthCheckRequest) ProtoMessage Uses

func (*HealthCheckRequest) ProtoMessage()

func (*HealthCheckRequest) Reset Uses

func (m *HealthCheckRequest) Reset()

func (*HealthCheckRequest) String Uses

func (m *HealthCheckRequest) String() string

func (*HealthCheckRequest) XXX_DiscardUnknown Uses

func (m *HealthCheckRequest) XXX_DiscardUnknown()

func (*HealthCheckRequest) XXX_Marshal Uses

func (m *HealthCheckRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*HealthCheckRequest) XXX_Merge Uses

func (dst *HealthCheckRequest) XXX_Merge(src proto.Message)

func (*HealthCheckRequest) XXX_Size Uses

func (m *HealthCheckRequest) XXX_Size() int

func (*HealthCheckRequest) XXX_Unmarshal Uses

func (m *HealthCheckRequest) XXX_Unmarshal(b []byte) error

type HealthCheckResponse Uses

type HealthCheckResponse struct {
    Status               HealthCheckResponse_ServingStatus `protobuf:"varint,1,opt,name=status,proto3,enum=grpc.health.v1.HealthCheckResponse_ServingStatus" json:"status,omitempty"`
    XXX_NoUnkeyedLiteral struct{}                          `json:"-"`
    XXX_unrecognized     []byte                            `json:"-"`
    XXX_sizecache        int32                             `json:"-"`
}

func (*HealthCheckResponse) Descriptor Uses

func (*HealthCheckResponse) Descriptor() ([]byte, []int)

func (*HealthCheckResponse) GetStatus Uses

func (m *HealthCheckResponse) GetStatus() HealthCheckResponse_ServingStatus

func (*HealthCheckResponse) ProtoMessage Uses

func (*HealthCheckResponse) ProtoMessage()

func (*HealthCheckResponse) Reset Uses

func (m *HealthCheckResponse) Reset()

func (*HealthCheckResponse) String Uses

func (m *HealthCheckResponse) String() string

func (*HealthCheckResponse) XXX_DiscardUnknown Uses

func (m *HealthCheckResponse) XXX_DiscardUnknown()

func (*HealthCheckResponse) XXX_Marshal Uses

func (m *HealthCheckResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*HealthCheckResponse) XXX_Merge Uses

func (dst *HealthCheckResponse) XXX_Merge(src proto.Message)

func (*HealthCheckResponse) XXX_Size Uses

func (m *HealthCheckResponse) XXX_Size() int

func (*HealthCheckResponse) XXX_Unmarshal Uses

func (m *HealthCheckResponse) XXX_Unmarshal(b []byte) error

type HealthCheckResponse_ServingStatus Uses

type HealthCheckResponse_ServingStatus int32
const (
    HealthCheckResponse_UNKNOWN         HealthCheckResponse_ServingStatus = 0
    HealthCheckResponse_SERVING         HealthCheckResponse_ServingStatus = 1
    HealthCheckResponse_NOT_SERVING     HealthCheckResponse_ServingStatus = 2
    HealthCheckResponse_SERVICE_UNKNOWN HealthCheckResponse_ServingStatus = 3
)

func (HealthCheckResponse_ServingStatus) EnumDescriptor Uses

func (HealthCheckResponse_ServingStatus) EnumDescriptor() ([]byte, []int)

func (HealthCheckResponse_ServingStatus) String Uses

func (x HealthCheckResponse_ServingStatus) String() string

type HealthClient Uses

type HealthClient interface {
    // If the requested service is unknown, the call will fail with status
    // NOT_FOUND.
    Check(ctx context.Context, in *HealthCheckRequest, opts ...grpc.CallOption) (*HealthCheckResponse, 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.
    Watch(ctx context.Context, in *HealthCheckRequest, opts ...grpc.CallOption) (Health_WatchClient, error)
}

HealthClient is the client API for Health service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewHealthClient Uses

func NewHealthClient(cc *grpc.ClientConn) HealthClient

type HealthServer Uses

type HealthServer interface {
    // If the requested service is unknown, the call will fail with status
    // NOT_FOUND.
    Check(context.Context, *HealthCheckRequest) (*HealthCheckResponse, 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.
    Watch(*HealthCheckRequest, Health_WatchServer) error
}

HealthServer is the server API for Health service.

type Health_WatchClient Uses

type Health_WatchClient interface {
    Recv() (*HealthCheckResponse, error)
    grpc.ClientStream
}

type Health_WatchServer Uses

type Health_WatchServer interface {
    Send(*HealthCheckResponse) error
    grpc.ServerStream
}

Package grpc_health_v1 imports 5 packages (graph) and is imported by 207 packages. Updated 2018-11-15. Refresh now. Tools for package owners.