healthcheck

package
v1.26.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 29, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package healthcheck defines the RPC interface for the sansshell HealthCheck actions.

Index

Constants

This section is empty.

Variables

View Source
var File_healthcheck_proto protoreflect.FileDescriptor
View Source
var HealthCheck_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "HealthCheck.HealthCheck",
	HandlerType: (*HealthCheckServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Ok",
			Handler:    _HealthCheck_Ok_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "healthcheck.proto",
}

HealthCheck_ServiceDesc is the grpc.ServiceDesc for HealthCheck service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterHealthCheckServer

func RegisterHealthCheckServer(s grpc.ServiceRegistrar, srv HealthCheckServer)

Types

type HealthCheckClient

type HealthCheckClient interface {
	// Ok merely signals if the endpoint is reachable.
	Ok(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

HealthCheckClient is the client API for HealthCheck service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type HealthCheckClientProxy

type HealthCheckClientProxy interface {
	HealthCheckClient
	OkOneMany(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (<-chan *OkManyResponse, error)
}

HealthCheckClientProxy is the superset of HealthCheckClient which additionally includes the OneMany proxy methods

func NewHealthCheckClientProxy

func NewHealthCheckClientProxy(cc *proxy.Conn) HealthCheckClientProxy

NewHealthCheckClientProxy creates a HealthCheckClientProxy for use in proxied connections. NOTE: This takes a proxy.Conn instead of a generic ClientConnInterface as the methods here are only valid in proxy.Conn contexts.

type HealthCheckServer

type HealthCheckServer interface {
	// Ok merely signals if the endpoint is reachable.
	Ok(context.Context, *emptypb.Empty) (*emptypb.Empty, error)
}

HealthCheckServer is the server API for HealthCheck service. All implementations should embed UnimplementedHealthCheckServer for forward compatibility

type OkManyResponse

type OkManyResponse struct {
	Target string
	// As targets can be duplicated this is the index into the slice passed to proxy.Conn.
	Index int
	Resp  *emptypb.Empty
	Error error
}

OkManyResponse encapsulates a proxy data packet. It includes the target, index, response and possible error returned.

type UnimplementedHealthCheckServer

type UnimplementedHealthCheckServer struct {
}

UnimplementedHealthCheckServer should be embedded to have forward compatible implementations.

func (UnimplementedHealthCheckServer) Ok

type UnsafeHealthCheckServer

type UnsafeHealthCheckServer interface {
	// contains filtered or unexported methods
}

UnsafeHealthCheckServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to HealthCheckServer will result in compilation errors.

Directories

Path Synopsis
Package client provides the client interface for 'healthcheck'
Package client provides the client interface for 'healthcheck'
Package server implements the sansshell 'HealthCheck' service.
Package server implements the sansshell 'HealthCheck' service.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL