proto

Documentation

Overview

Package proto is a generated protocol buffer package.

Test to make sure that a package named proto doesn't break

It is generated from these files:

proto.proto

It has these top-level messages:

Msg

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

Test to make sure that a package named proto doesn't break

It is generated from these files:

proto.proto

Index

• Constants
• func WriteError(resp http.ResponseWriter, err error)
• type Msg
  • func (*Msg) Descriptor() ([]byte, []int)
  • func (*Msg) ProtoMessage()
  • func (m *Msg) Reset()
  • func (m *Msg) String() string
• type Svc
  • func NewSvcJSONClient(addr string, client *http.Client) Svc
  • func NewSvcProtobufClient(addr string, client *http.Client) Svc
• type TwirpServer
  • func NewSvcServer(svc Svc, hooks *twirp.ServerHooks) TwirpServer

Constants

const SvcPathPrefix = "/twirp/twirp.internal.twirptest.proto.Svc/"

SvcPathPrefix is used for all URL paths on a twirp Svc server. Requests are always: POST SvcPathPrefix/method It can be used in an HTTP mux to route twirp requests along with non-twirp requests on other routes.

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 Msg

type Msg struct {
}

func (*Msg) Descriptor

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

func (*Msg) ProtoMessage

func (*Msg) ProtoMessage()

func (*Msg) Reset

func (m *Msg) Reset()

func (*Msg) String

func (m *Msg) String() string

type Svc

type Svc interface {
	Send(context.Context, *Msg) (*Msg, error)
}

func NewSvcJSONClient

func NewSvcJSONClient(addr string, client *http.Client) Svc

NewSvcJSONClient creates a JSON client that implements the Svc interface. It communicates using JSON requests and responses instead of protobuf messages.

func NewSvcProtobufClient

func NewSvcProtobufClient(addr string, client *http.Client) Svc

NewSvcProtobufClient creates a Protobuf client that implements the Svc interface. It communicates using protobuf messages and can be configured with a custom http.Client.

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 NewSvcServer

func NewSvcServer(svc Svc, hooks *twirp.ServerHooks) TwirpServer