rpc

Documentation

Overview

Package rpc 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:

pkg/staging/rpc/service.proto

Index

• Constants
• func WriteError(resp http.ResponseWriter, err error)
• type Configuration
  • func (*Configuration) Descriptor() ([]byte, []int)
  • func (m *Configuration) GetConfig() []byte
  • func (m *Configuration) GetGitRevision() string
  • func (*Configuration) ProtoMessage()
  • func (m *Configuration) Reset()
  • func (m *Configuration) String() string
  • func (m *Configuration) XXX_DiscardUnknown()
  • func (m *Configuration) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *Configuration) XXX_Merge(src proto.Message)
  • func (m *Configuration) XXX_Size() int
  • func (m *Configuration) XXX_Unmarshal(b []byte) error
• type Empty
  • func (*Empty) Descriptor() ([]byte, []int)
  • func (*Empty) ProtoMessage()
  • func (m *Empty) Reset()
  • func (m *Empty) String() string
  • func (m *Empty) XXX_DiscardUnknown()
  • func (m *Empty) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *Empty) XXX_Merge(src proto.Message)
  • func (m *Empty) XXX_Size() int
  • func (m *Empty) XXX_Unmarshal(b []byte) error
• type HTTPClient
• type RPC
  • func NewRPCJSONClient(addr string, client HTTPClient, opts ...twirp.ClientOption) RPC
  • func NewRPCProtobufClient(addr string, client HTTPClient, opts ...twirp.ClientOption) RPC
• type TwirpServer
  • func NewRPCServer(svc RPC, hooks *twirp.ServerHooks) TwirpServer

Constants

const RPCPathPrefix = "/twirp/samsahai.io.staging.RPC/"

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

type Configuration struct {
	Config               []byte   `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	GitRevision          string   `protobuf:"bytes,2,opt,name=gitRevision,proto3" json:"gitRevision,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*Configuration) Descriptor

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

func (*Configuration) GetConfig

func (m *Configuration) GetConfig() []byte

func (*Configuration) GetGitRevision

func (m *Configuration) GetGitRevision() string

func (*Configuration) ProtoMessage

func (*Configuration) ProtoMessage()

func (*Configuration) Reset

func (m *Configuration) Reset()

func (*Configuration) String

func (m *Configuration) String() string

func (*Configuration) XXX_DiscardUnknown

func (m *Configuration) XXX_DiscardUnknown()

func (*Configuration) XXX_Marshal

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

func (*Configuration) XXX_Merge

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

func (*Configuration) XXX_Size

func (m *Configuration) XXX_Size() int

func (*Configuration) XXX_Unmarshal

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

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 RPC

type RPC interface {
	UpdateConfiguration(context.Context, *Configuration) (*Empty, error)
}

func NewRPCJSONClient

func NewRPCJSONClient(addr string, client HTTPClient, opts ...twirp.ClientOption) RPC

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

func NewRPCProtobufClient

func NewRPCProtobufClient(addr string, client HTTPClient, opts ...twirp.ClientOption) RPC

NewRPCProtobufClient creates a Protobuf client that implements the RPC 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 NewRPCServer

func NewRPCServer(svc RPC, hooks *twirp.ServerHooks) TwirpServer