Documentation
¶
Overview ¶
Package clientcompat is a generated protocol buffer package.
It is generated from these files:
clientcompat.proto
It has these top-level messages:
Empty Req Resp ClientCompatMessage
Package clientcompat is a generated twirp stub package. This code was generated with github.com/twitchtv/twirp/protoc-gen-twirp v5.0.0.
It is generated from these files:
clientcompat.proto
Index ¶
- Constants
- Variables
- func WriteError(resp http.ResponseWriter, err error)
- type ClientCompatMessage
- func (*ClientCompatMessage) Descriptor() ([]byte, []int)
- func (m *ClientCompatMessage) GetMethod() ClientCompatMessage_CompatServiceMethod
- func (m *ClientCompatMessage) GetRequest() []byte
- func (m *ClientCompatMessage) GetServiceAddress() string
- func (*ClientCompatMessage) ProtoMessage()
- func (m *ClientCompatMessage) Reset()
- func (m *ClientCompatMessage) String() string
- type ClientCompatMessage_CompatServiceMethod
- type CompatService
- type Empty
- type Req
- type Resp
- type TwirpServer
Constants ¶
const CompatServicePathPrefix = "/twirp/twirp.clientcompat.CompatService/"
CompatServicePathPrefix is used for all URL paths on a twirp CompatService server. Requests are always: POST CompatServicePathPrefix/method It can be used in an HTTP mux to route twirp requests along with non-twirp requests on other routes.
Variables ¶
var ClientCompatMessage_CompatServiceMethod_name = map[int32]string{
0: "NOOP",
1: "METHOD",
}
var ClientCompatMessage_CompatServiceMethod_value = map[string]int32{
"NOOP": 0,
"METHOD": 1,
}
Functions ¶
func WriteError ¶
func WriteError(resp http.ResponseWriter, err error)
WriteError writes an HTTP response with a valid Twirp error format. If err is not a twirp.Error, it will get wrapped with twirp.InternalErrorWith(err)
Types ¶
type ClientCompatMessage ¶
type ClientCompatMessage struct {
ServiceAddress string `protobuf:"bytes,1,opt,name=service_address,json=serviceAddress" json:"service_address,omitempty"`
Method ClientCompatMessage_CompatServiceMethod `protobuf:"varint,2,opt,name=method,enum=twirp.clientcompat.ClientCompatMessage_CompatServiceMethod" json:"method,omitempty"`
Request []byte `protobuf:"bytes,3,opt,name=request,proto3" json:"request,omitempty"`
}
func (*ClientCompatMessage) Descriptor ¶
func (*ClientCompatMessage) Descriptor() ([]byte, []int)
func (*ClientCompatMessage) GetMethod ¶
func (m *ClientCompatMessage) GetMethod() ClientCompatMessage_CompatServiceMethod
func (*ClientCompatMessage) GetRequest ¶
func (m *ClientCompatMessage) GetRequest() []byte
func (*ClientCompatMessage) GetServiceAddress ¶
func (m *ClientCompatMessage) GetServiceAddress() string
func (*ClientCompatMessage) ProtoMessage ¶
func (*ClientCompatMessage) ProtoMessage()
func (*ClientCompatMessage) Reset ¶
func (m *ClientCompatMessage) Reset()
func (*ClientCompatMessage) String ¶
func (m *ClientCompatMessage) String() string
type ClientCompatMessage_CompatServiceMethod ¶
type ClientCompatMessage_CompatServiceMethod int32
const ( ClientCompatMessage_NOOP ClientCompatMessage_CompatServiceMethod = 0 ClientCompatMessage_METHOD ClientCompatMessage_CompatServiceMethod = 1 )
func (ClientCompatMessage_CompatServiceMethod) EnumDescriptor ¶
func (ClientCompatMessage_CompatServiceMethod) EnumDescriptor() ([]byte, []int)
func (ClientCompatMessage_CompatServiceMethod) String ¶
func (x ClientCompatMessage_CompatServiceMethod) String() string
type CompatService ¶
type CompatService interface {
Method(context.Context, *Req) (*Resp, error)
NoopMethod(context.Context, *Empty) (*Empty, error)
}
func NewCompatServiceJSONClient ¶
func NewCompatServiceJSONClient(addr string, client *http.Client) CompatService
NewCompatServiceJSONClient creates a JSON client that implements the CompatService interface. It communicates using JSON requests and responses instead of protobuf messages.
func NewCompatServiceProtobufClient ¶
func NewCompatServiceProtobufClient(addr string, client *http.Client) CompatService
NewCompatServiceProtobufClient creates a Protobuf client that implements the CompatService interface. It communicates using protobuf messages and can be configured with a custom http.Client.
type Empty ¶
type Empty struct {
}
func (*Empty) Descriptor ¶
func (*Empty) ProtoMessage ¶
func (*Empty) ProtoMessage()
type Req ¶
type Req struct {
V string `protobuf:"bytes,1,opt,name=v" json:"v,omitempty"`
}
func (*Req) Descriptor ¶
func (*Req) ProtoMessage ¶
func (*Req) ProtoMessage()
type Resp ¶
type Resp struct {
V int32 `protobuf:"varint,1,opt,name=v" json:"v,omitempty"`
}
func (*Resp) Descriptor ¶
func (*Resp) ProtoMessage ¶
func (*Resp) ProtoMessage()
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
// unmarshaled 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
}
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, hooks *twirp.ServerHooks) TwirpServer
Source Files