twirp: github.com/twitchtv/twirp/clientcompat/internal/clientcompat Index | Files

package clientcompat

import "github.com/twitchtv/twirp/clientcompat/internal/clientcompat"

Package clientcompat is a generated twirp stub package. This code was generated with github.com/twitchtv/twirp/protoc-gen-twirp v5.10.1.

It is generated from these files:

clientcompat.proto

Index

Package Files

clientcompat.pb.go clientcompat.twirp.go

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,
}

func WriteError Uses

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)

type ClientCompatMessage Uses

type ClientCompatMessage struct {
    ServiceAddress       string                                  `protobuf:"bytes,1,opt,name=service_address,json=serviceAddress,proto3" json:"service_address,omitempty"`
    Method               ClientCompatMessage_CompatServiceMethod `protobuf:"varint,2,opt,name=method,proto3,enum=twirp.clientcompat.ClientCompatMessage_CompatServiceMethod" json:"method,omitempty"`
    Request              []byte                                  `protobuf:"bytes,3,opt,name=request,proto3" json:"request,omitempty"`
    XXX_NoUnkeyedLiteral struct{}                                `json:"-"`
    XXX_unrecognized     []byte                                  `json:"-"`
    XXX_sizecache        int32                                   `json:"-"`
}

func (*ClientCompatMessage) Descriptor Uses

func (*ClientCompatMessage) Descriptor() ([]byte, []int)

func (*ClientCompatMessage) GetMethod Uses

func (m *ClientCompatMessage) GetMethod() ClientCompatMessage_CompatServiceMethod

func (*ClientCompatMessage) GetRequest Uses

func (m *ClientCompatMessage) GetRequest() []byte

func (*ClientCompatMessage) GetServiceAddress Uses

func (m *ClientCompatMessage) GetServiceAddress() string

func (*ClientCompatMessage) ProtoMessage Uses

func (*ClientCompatMessage) ProtoMessage()

func (*ClientCompatMessage) Reset Uses

func (m *ClientCompatMessage) Reset()

func (*ClientCompatMessage) String Uses

func (m *ClientCompatMessage) String() string

func (*ClientCompatMessage) XXX_DiscardUnknown Uses

func (m *ClientCompatMessage) XXX_DiscardUnknown()

func (*ClientCompatMessage) XXX_Marshal Uses

func (m *ClientCompatMessage) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ClientCompatMessage) XXX_Merge Uses

func (m *ClientCompatMessage) XXX_Merge(src proto.Message)

func (*ClientCompatMessage) XXX_Size Uses

func (m *ClientCompatMessage) XXX_Size() int

func (*ClientCompatMessage) XXX_Unmarshal Uses

func (m *ClientCompatMessage) XXX_Unmarshal(b []byte) error

type ClientCompatMessage_CompatServiceMethod Uses

type ClientCompatMessage_CompatServiceMethod int32
const (
    ClientCompatMessage_NOOP   ClientCompatMessage_CompatServiceMethod = 0
    ClientCompatMessage_METHOD ClientCompatMessage_CompatServiceMethod = 1
)

func (ClientCompatMessage_CompatServiceMethod) EnumDescriptor Uses

func (ClientCompatMessage_CompatServiceMethod) EnumDescriptor() ([]byte, []int)

func (ClientCompatMessage_CompatServiceMethod) String Uses

func (x ClientCompatMessage_CompatServiceMethod) String() string

type CompatService Uses

type CompatService interface {
    Method(context.Context, *Req) (*Resp, error)

    NoopMethod(context.Context, *Empty) (*Empty, error)
}

func NewCompatServiceJSONClient Uses

func NewCompatServiceJSONClient(addr 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 Uses

func NewCompatServiceProtobufClient(addr 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 Empty Uses

type Empty struct {
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

func (*Empty) Descriptor Uses

func (*Empty) Descriptor() ([]byte, []int)

func (*Empty) ProtoMessage Uses

func (*Empty) ProtoMessage()

func (*Empty) Reset Uses

func (m *Empty) Reset()

func (*Empty) String Uses

func (m *Empty) String() string

func (*Empty) XXX_DiscardUnknown Uses

func (m *Empty) XXX_DiscardUnknown()

func (*Empty) XXX_Marshal Uses

func (m *Empty) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Empty) XXX_Merge Uses

func (m *Empty) XXX_Merge(src proto.Message)

func (*Empty) XXX_Size Uses

func (m *Empty) XXX_Size() int

func (*Empty) XXX_Unmarshal Uses

func (m *Empty) XXX_Unmarshal(b []byte) error

type HTTPClient Uses

type HTTPClient interface {
    Do(req *http.Request) (*http.Response, error)
}

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 Uses

type Req struct {
    V                    string   `protobuf:"bytes,1,opt,name=v,proto3" json:"v,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

func (*Req) Descriptor Uses

func (*Req) Descriptor() ([]byte, []int)

func (*Req) GetV Uses

func (m *Req) GetV() string

func (*Req) ProtoMessage Uses

func (*Req) ProtoMessage()

func (*Req) Reset Uses

func (m *Req) Reset()

func (*Req) String Uses

func (m *Req) String() string

func (*Req) XXX_DiscardUnknown Uses

func (m *Req) XXX_DiscardUnknown()

func (*Req) XXX_Marshal Uses

func (m *Req) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Req) XXX_Merge Uses

func (m *Req) XXX_Merge(src proto.Message)

func (*Req) XXX_Size Uses

func (m *Req) XXX_Size() int

func (*Req) XXX_Unmarshal Uses

func (m *Req) XXX_Unmarshal(b []byte) error

type Resp Uses

type Resp struct {
    V                    int32    `protobuf:"varint,1,opt,name=v,proto3" json:"v,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

func (*Resp) Descriptor Uses

func (*Resp) Descriptor() ([]byte, []int)

func (*Resp) GetV Uses

func (m *Resp) GetV() int32

func (*Resp) ProtoMessage Uses

func (*Resp) ProtoMessage()

func (*Resp) Reset Uses

func (m *Resp) Reset()

func (*Resp) String Uses

func (m *Resp) String() string

func (*Resp) XXX_DiscardUnknown Uses

func (m *Resp) XXX_DiscardUnknown()

func (*Resp) XXX_Marshal Uses

func (m *Resp) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Resp) XXX_Merge Uses

func (m *Resp) XXX_Merge(src proto.Message)

func (*Resp) XXX_Size Uses

func (m *Resp) XXX_Size() int

func (*Resp) XXX_Unmarshal Uses

func (m *Resp) XXX_Unmarshal(b []byte) error

type TwirpServer Uses

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
    // alongside non-twirp requests on one HTTP listener.
    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 Uses

func NewCompatServiceServer(svc CompatService, hooks *twirp.ServerHooks) TwirpServer

Package clientcompat imports 15 packages (graph) and is imported by 6 packages. Updated 2020-03-31. Refresh now. Tools for package owners.