no_package_name_importer

Documentation

Overview

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

It is generated from these files:

no_package_name_importer.proto

Index

• Constants
• func WriteError(resp http.ResponseWriter, err error)
• type HTTPClient
• type Svc2
  • func NewSvc2JSONClient(addr string, client HTTPClient) Svc2
  • func NewSvc2ProtobufClient(addr string, client HTTPClient) Svc2
• type TwirpServer
  • func NewSvc2Server(svc Svc2, hooks *twirp.ServerHooks) TwirpServer

Constants

const Svc2PathPrefix = "/twirp/Svc2/"

Svc2PathPrefix is used for all URL paths on a twirp Svc2 server. Requests are always: POST Svc2PathPrefix/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 (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 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 Svc2

type Svc2 interface {
	Method(context.Context, *no_package_name.Msg) (*no_package_name.Msg, error)
}

func NewSvc2JSONClient

func NewSvc2JSONClient(addr string, client HTTPClient) Svc2

NewSvc2JSONClient creates a JSON client that implements the Svc2 interface. It communicates using JSON and can be configured with a custom HTTPClient.

func NewSvc2ProtobufClient

func NewSvc2ProtobufClient(addr string, client HTTPClient) Svc2

NewSvc2ProtobufClient creates a Protobuf client that implements the Svc2 interface. It communicates using Protobuf and can be configured with a custom HTTPClient.

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 NewSvc2Server

func NewSvc2Server(svc Svc2, hooks *twirp.ServerHooks) TwirpServer