Documentation
¶
Overview ¶
Package twirpcompat holds compatibility tests for Twirp.
Index ¶
- Constants
- Variables
- func DRPCRegisterCompatService(mux drpc.Mux, impl DRPCCompatServiceServer) error
- func WriteError(resp http.ResponseWriter, err error)
- type CompatService
- type DRPCCompatServiceClient
- type DRPCCompatServiceDescription
- type DRPCCompatServiceServer
- type DRPCCompatServiceUnimplementedServer
- type DRPCCompatService_MethodStream
- type DRPCCompatService_NoopMethodStream
- type Empty
- type HTTPClient
- type Req
- type Resp
- type TwirpServer
Constants ¶
const CompatServicePathPrefix = "/twirp/compat.CompatService/"
CompatServicePathPrefix is a convenience constant that may identify URL paths. Should be used with caution, it only matches routes generated by Twirp Go clients, with the default "/twirp" prefix and default CamelCase service and method names. More info: https://twitchtv.github.io/twirp/docs/routing.html
Variables ¶
var File_clientcompat_proto protoreflect.FileDescriptor
Functions ¶
func DRPCRegisterCompatService ¶
func DRPCRegisterCompatService(mux drpc.Mux, impl DRPCCompatServiceServer) error
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 CompatService ¶
type CompatService interface {
Method(context.Context, *Req) (*Resp, error)
NoopMethod(context.Context, *Empty) (*Empty, error)
}
func NewCompatServiceJSONClient ¶
func NewCompatServiceJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) CompatService
NewCompatServiceJSONClient creates a JSON client that implements the CompatService interface. It communicates using JSON and can be configured with a custom HTTPClient.
func NewCompatServiceProtobufClient ¶
func NewCompatServiceProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) CompatService
NewCompatServiceProtobufClient creates a Protobuf client that implements the CompatService interface. It communicates using Protobuf and can be configured with a custom HTTPClient.
type DRPCCompatServiceClient ¶
type DRPCCompatServiceClient interface {
DRPCConn() drpc.Conn
Method(ctx context.Context, in *Req) (*Resp, error)
NoopMethod(ctx context.Context, in *Empty) (*Empty, error)
}
func NewDRPCCompatServiceClient ¶
func NewDRPCCompatServiceClient(cc drpc.Conn) DRPCCompatServiceClient
type DRPCCompatServiceDescription ¶
type DRPCCompatServiceDescription struct{}
func (DRPCCompatServiceDescription) NumMethods ¶
func (DRPCCompatServiceDescription) NumMethods() int
type DRPCCompatServiceServer ¶
type DRPCCompatServiceUnimplementedServer ¶
type DRPCCompatServiceUnimplementedServer struct{}
func (*DRPCCompatServiceUnimplementedServer) NoopMethod ¶
type Empty ¶
type Empty struct {
// contains filtered or unexported fields
}
func (*Empty) Descriptor
deprecated
func (*Empty) ProtoMessage ¶
func (*Empty) ProtoMessage()
func (*Empty) ProtoReflect ¶
func (x *Empty) ProtoReflect() protoreflect.Message
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 Req ¶
type Req struct {
V string `protobuf:"bytes,1,opt,name=v,proto3" json:"v,omitempty"`
// contains filtered or unexported fields
}
func (*Req) Descriptor
deprecated
func (*Req) ProtoMessage ¶
func (*Req) ProtoMessage()
func (*Req) ProtoReflect ¶
func (x *Req) ProtoReflect() protoreflect.Message
type Resp ¶
type Resp struct {
V int32 `protobuf:"varint,1,opt,name=v,proto3" json:"v,omitempty"`
// contains filtered or unexported fields
}
func (*Resp) Descriptor
deprecated
func (*Resp) ProtoMessage ¶
func (*Resp) ProtoMessage()
func (*Resp) ProtoReflect ¶
func (x *Resp) ProtoReflect() protoreflect.Message
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
// google.golang.org/protobuf/types/descriptorpb.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 NewCompatServiceServer ¶
func NewCompatServiceServer(svc CompatService, opts ...interface{}) TwirpServer
NewCompatServiceServer 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