clientcompat

package
v8.1.1+incompatible Latest Latest
Warning

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

 Go to latest Published: Nov 29, 2021 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

View Source 
const CompatServicePathPrefix = "/twirp/twirp.clientcompat.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

View Source 
var (
	ClientCompatMessage_CompatServiceMethod_name = map[int32]string{
		0: "NOOP",
		1: "METHOD",
	}
	ClientCompatMessage_CompatServiceMethod_value = map[string]int32{
		"NOOP":   0,
		"METHOD": 1,
	}
)

Enum value maps for ClientCompatMessage_CompatServiceMethod.

View Source 
var File_clientcompat_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 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"`
	// contains filtered or unexported fields
}

func (*ClientCompatMessage) Descriptor deprecated 

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

Deprecated: Use ClientCompatMessage.ProtoReflect.Descriptor instead.

func (*ClientCompatMessage) GetMethod 

func (x *ClientCompatMessage) GetMethod() ClientCompatMessage_CompatServiceMethod

func (*ClientCompatMessage) GetRequest 

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

func (*ClientCompatMessage) GetServiceAddress 

func (x *ClientCompatMessage) GetServiceAddress() string

func (*ClientCompatMessage) ProtoMessage 

func (*ClientCompatMessage) ProtoMessage()

func (*ClientCompatMessage) ProtoReflect 

func (x *ClientCompatMessage) ProtoReflect() protoreflect.Message

func (*ClientCompatMessage) Reset 

func (x *ClientCompatMessage) Reset()

func (*ClientCompatMessage) String 

func (x *ClientCompatMessage) String() string

type ClientCompatMessage_CompatServiceMethod 

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

func (ClientCompatMessage_CompatServiceMethod) Descriptor 

func (ClientCompatMessage_CompatServiceMethod) Descriptor() protoreflect.EnumDescriptor

func (ClientCompatMessage_CompatServiceMethod) Enum 

func (x ClientCompatMessage_CompatServiceMethod) Enum() *ClientCompatMessage_CompatServiceMethod

func (ClientCompatMessage_CompatServiceMethod) EnumDescriptor deprecated 

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

Deprecated: Use ClientCompatMessage_CompatServiceMethod.Descriptor instead.

func (ClientCompatMessage_CompatServiceMethod) Number 

func (x ClientCompatMessage_CompatServiceMethod) Number() protoreflect.EnumNumber

func (ClientCompatMessage_CompatServiceMethod) String 

func (x ClientCompatMessage_CompatServiceMethod) String() string

func (ClientCompatMessage_CompatServiceMethod) Type 

func (ClientCompatMessage_CompatServiceMethod) Type() protoreflect.EnumType

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 Empty 

type Empty struct {
	// contains filtered or unexported fields
}

func (*Empty) Descriptor deprecated 

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

Deprecated: Use Empty.ProtoReflect.Descriptor instead.

func (*Empty) ProtoMessage 

func (*Empty) ProtoMessage()

func (*Empty) ProtoReflect 

func (x *Empty) ProtoReflect() protoreflect.Message

func (*Empty) Reset 

func (x *Empty) Reset()

func (*Empty) String 

func (x *Empty) String() string

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"`
	// contains filtered or unexported fields
}

func (*Req) Descriptor deprecated 

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

Deprecated: Use Req.ProtoReflect.Descriptor instead.

func (*Req) GetV 

func (x *Req) GetV() string

func (*Req) ProtoMessage 

func (*Req) ProtoMessage()

func (*Req) ProtoReflect 

func (x *Req) ProtoReflect() protoreflect.Message

func (*Req) Reset 

func (x *Req) Reset()

func (*Req) String 

func (x *Req) String() string

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) Descriptor() ([]byte, []int)

Deprecated: Use Resp.ProtoReflect.Descriptor instead.

func (*Resp) GetV 

func (x *Resp) GetV() int32

func (*Resp) ProtoMessage 

func (*Resp) ProtoMessage()

func (*Resp) ProtoReflect 

func (x *Resp) ProtoReflect() protoreflect.Message

func (*Resp) Reset 

func (x *Resp) Reset()

func (*Resp) String 

func (x *Resp) String() string

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

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.