Documentation
¶
Overview ¶
Package health is a generated twirp stub package. This code was generated with github.com/twitchtv/twirp/protoc-gen-twirp v7.1.1.
It is generated from these files:
health.proto
Index ¶
Constants ¶
const HealthPathPrefix = "/twirp/redsail.bosn.Health/"
HealthPathPrefix is a convenience constant that could used to identify URL paths. Should be used with caution, it only matches routes generated by Twirp Go clients, that add a "/twirp" prefix by default, and use CamelCase service and method names. More info: https://twitchtv.github.io/twirp/docs/routing.html
Variables ¶
var File_health_proto protoreflect.FileDescriptor
Functions ¶
func WriteError ¶
func WriteError(resp http.ResponseWriter, err error)
WriteError writes an HTTP response with a valid Twirp error format (code, msg, meta). Useful outside of the Twirp server (e.g. http middleware), but does not trigger hooks. If err is not a twirp.Error, it will get wrapped with twirp.InternalErrorWith(err)
Types ¶
type CheckLive ¶
type CheckLive struct {
// contains filtered or unexported fields
}
func (*CheckLive) Descriptor
deprecated
func (*CheckLive) ProtoMessage ¶
func (*CheckLive) ProtoMessage()
func (*CheckLive) ProtoReflect ¶
func (x *CheckLive) ProtoReflect() protoreflect.Message
type CheckReady ¶
type CheckReady struct {
// contains filtered or unexported fields
}
func (*CheckReady) Descriptor
deprecated
func (*CheckReady) Descriptor() ([]byte, []int)
Deprecated: Use CheckReady.ProtoReflect.Descriptor instead.
func (*CheckReady) ProtoMessage ¶
func (*CheckReady) ProtoMessage()
func (*CheckReady) ProtoReflect ¶
func (x *CheckReady) ProtoReflect() protoreflect.Message
func (*CheckReady) Reset ¶
func (x *CheckReady) Reset()
func (*CheckReady) String ¶
func (x *CheckReady) String() string
type HTTPClient ¶
HTTPClient is the interface used by generated clients to send HTTP requests. It is fulfilled by *(net/http).Client, which is sufficient for most users. Users can provide their own implementation for special retry policies.
HTTPClient implementations should not follow redirects. Redirects are automatically disabled if *(net/http).Client is passed to client constructors. See the withoutRedirects function in this file for more details.
type Health ¶
type Health interface {
// gets if the server is alive
Live(context.Context, *CheckLive) (*LiveCheck, error)
// gets if the server is ready for traffic
Ready(context.Context, *CheckReady) (*ReadyCheck, error)
}
func NewHealthJSONClient ¶
func NewHealthJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Health
NewHealthJSONClient creates a JSON client that implements the Health interface. It communicates using JSON and can be configured with a custom HTTPClient.
func NewHealthProtobufClient ¶
func NewHealthProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Health
NewHealthProtobufClient creates a Protobuf client that implements the Health interface. It communicates using Protobuf and can be configured with a custom HTTPClient.
type LiveCheck ¶
type LiveCheck struct {
// contains filtered or unexported fields
}
func (*LiveCheck) Descriptor
deprecated
func (*LiveCheck) ProtoMessage ¶
func (*LiveCheck) ProtoMessage()
func (*LiveCheck) ProtoReflect ¶
func (x *LiveCheck) ProtoReflect() protoreflect.Message
type ReadyCheck ¶
type ReadyCheck struct {
// contains filtered or unexported fields
}
func (*ReadyCheck) Descriptor
deprecated
func (*ReadyCheck) Descriptor() ([]byte, []int)
Deprecated: Use ReadyCheck.ProtoReflect.Descriptor instead.
func (*ReadyCheck) ProtoMessage ¶
func (*ReadyCheck) ProtoMessage()
func (*ReadyCheck) ProtoReflect ¶
func (x *ReadyCheck) ProtoReflect() protoreflect.Message
func (*ReadyCheck) Reset ¶
func (x *ReadyCheck) Reset()
func (*ReadyCheck) String ¶
func (x *ReadyCheck) String() string
type TwirpServer ¶
type TwirpServer interface {
http.Handler
// ServiceDescriptor returns gzipped bytes describing the .proto file that
// this service was generated from. Once unzipped, the bytes can be
// unmarshalled as a
// github.com/golang/protobuf/protoc-gen-go/descriptor.FileDescriptorProto.
//
// The returned integer is the index of this particular service within that
// FileDescriptorProto's 'Service' slice of ServiceDescriptorProtos. This is a
// low-level field, expected to be used for reflection.
ServiceDescriptor() ([]byte, int)
// ProtocGenTwirpVersion is the semantic version string of the version of
// twirp used to generate this file.
ProtocGenTwirpVersion() string
// PathPrefix returns the HTTP URL path prefix for all methods handled by this
// service. This can be used with an HTTP mux to route Twirp requests.
// The path prefix is in the form: "/<prefix>/<package>.<Service>/"
// that is, everything in a Twirp route except for the <Method> at the end.
PathPrefix() string
}
TwirpServer is the interface generated server structs will support: they're HTTP handlers with additional methods for accessing metadata about the service. Those accessors are a low-level API for building reflection tools. Most people can think of TwirpServers as just http.Handlers.
func NewHealthServer ¶
func NewHealthServer(svc Health, opts ...interface{}) TwirpServer
NewHealthServer builds a TwirpServer that can be used as an http.Handler to handle HTTP requests that are routed to the right method in the provided svc implementation. The opts are twirp.ServerOption modifiers, for example twirp.WithServerHooks(hooks).
Source Files