Documentation
¶
Index ¶
Constants ¶
const Svc1PathPrefix = "/twirp/twirp.internal.twirptest.multiple.Svc1/"
Svc1PathPrefix 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
const Svc2PathPrefix = "/twirp/twirp.internal.twirptest.multiple.Svc2/"
Svc2PathPrefix 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_multiple1_proto protoreflect.FileDescriptor
var File_multiple2_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 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 Msg1 ¶
type Msg1 struct {
// contains filtered or unexported fields
}
func (*Msg1) Descriptor
deprecated
func (*Msg1) ProtoMessage ¶
func (*Msg1) ProtoMessage()
func (*Msg1) ProtoReflect ¶
func (x *Msg1) ProtoReflect() protoreflect.Message
type Msg2 ¶
type Msg2 struct {
// contains filtered or unexported fields
}
func (*Msg2) Descriptor
deprecated
func (*Msg2) ProtoMessage ¶
func (*Msg2) ProtoMessage()
func (*Msg2) ProtoReflect ¶
func (x *Msg2) ProtoReflect() protoreflect.Message
type Svc1 ¶
func NewSvc1JSONClient ¶
func NewSvc1JSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Svc1
NewSvc1JSONClient creates a JSON client that implements the Svc1 interface. It communicates using JSON and can be configured with a custom HTTPClient.
func NewSvc1ProtobufClient ¶
func NewSvc1ProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Svc1
NewSvc1ProtobufClient creates a Protobuf client that implements the Svc1 interface. It communicates using Protobuf and can be configured with a custom HTTPClient.
type Svc2 ¶
type Svc2 interface {
Send(context.Context, *Msg2) (*Msg2, error)
SamePackageProtoImport(context.Context, *Msg1) (*Msg1, error)
}
func NewSvc2JSONClient ¶
func NewSvc2JSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Svc2
NewSvc2JSONClient creates a JSON client that implements the Svc2 interface. It communicates using JSON and can be configured with a custom HTTPClient.
func NewSvc2ProtobufClient ¶
func NewSvc2ProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Svc2
NewSvc2ProtobufClient creates a Protobuf client that implements the Svc2 interface. It communicates using Protobuf and can be configured with a custom HTTPClient.
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 NewSvc1Server ¶
func NewSvc1Server(svc Svc1, opts ...interface{}) TwirpServer
NewSvc1Server 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).
func NewSvc2Server ¶
func NewSvc2Server(svc Svc2, opts ...interface{}) TwirpServer
NewSvc2Server 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