clientcompat

package
v5.10.1+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 22, 2020 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

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

Constants

View Source 
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

View Source 
var ClientCompatMessage_CompatServiceMethod_name = map[int32]string{
	0: "NOOP",
	1: "METHOD",
}
View Source 
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 (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 ClientCompatMessage 

type ClientCompatMessage struct {
	ServiceAddress       string                                  `protobuf:"bytes,1,opt,name=service_address,json=serviceAddress,proto3" json:"service_address,omitempty"`
	Method               ClientCompatMessage_CompatServiceMethod `` /* 130-byte string literal not displayed */
	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 

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

func (*ClientCompatMessage) XXX_DiscardUnknown 

func (m *ClientCompatMessage) XXX_DiscardUnknown()

func (*ClientCompatMessage) XXX_Marshal 

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

func (*ClientCompatMessage) XXX_Merge 

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

func (*ClientCompatMessage) XXX_Size 

func (m *ClientCompatMessage) XXX_Size() int

func (*ClientCompatMessage) XXX_Unmarshal 

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

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 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(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 

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

func (*Empty) Descriptor 

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

func (*Empty) ProtoMessage 

func (*Empty) ProtoMessage()

func (*Empty) Reset 

func (m *Empty) Reset()

func (*Empty) String 

func (m *Empty) String() string

func (*Empty) XXX_DiscardUnknown 

func (m *Empty) XXX_DiscardUnknown()

func (*Empty) XXX_Marshal 

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

func (*Empty) XXX_Merge 

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

func (*Empty) XXX_Size 

func (m *Empty) XXX_Size() int

func (*Empty) XXX_Unmarshal 

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

type HTTPClient 

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 

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 

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

func (*Req) GetV 

func (m *Req) GetV() string

func (*Req) ProtoMessage 

func (*Req) ProtoMessage()

func (*Req) Reset 

func (m *Req) Reset()

func (*Req) String 

func (m *Req) String() string

func (*Req) XXX_DiscardUnknown 

func (m *Req) XXX_DiscardUnknown()

func (*Req) XXX_Marshal 

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

func (*Req) XXX_Merge 

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

func (*Req) XXX_Size 

func (m *Req) XXX_Size() int

func (*Req) XXX_Unmarshal 

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

type Resp 

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 

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

func (*Resp) GetV 

func (m *Resp) GetV() int32

func (*Resp) ProtoMessage 

func (*Resp) ProtoMessage()

func (*Resp) Reset 

func (m *Resp) Reset()

func (*Resp) String 

func (m *Resp) String() string

func (*Resp) XXX_DiscardUnknown 

func (m *Resp) XXX_DiscardUnknown()

func (*Resp) XXX_Marshal 

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

func (*Resp) XXX_Merge 

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

func (*Resp) XXX_Size 

func (m *Resp) XXX_Size() int

func (*Resp) XXX_Unmarshal 

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

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
	// 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 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.