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:

rpc/scheduler/scheduler.proto

Index

• Constants
• func WriteError(resp http.ResponseWriter, err 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 Event
  • func (*Event) Descriptor() ([]byte, []int)
  • func (m *Event) GetDelay() int64
  • func (m *Event) GetMessage() string
  • func (*Event) ProtoMessage()
  • func (m *Event) Reset()
  • func (m *Event) String() string
  • func (m *Event) XXX_DiscardUnknown()
  • func (m *Event) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *Event) XXX_Merge(src proto.Message)
  • func (m *Event) XXX_Size() int
  • func (m *Event) XXX_Unmarshal(b []byte) error
• type HTTPClient
• type Scheduler
  • func NewSchedulerJSONClient(addr string, client HTTPClient, opts ...twirp.ClientOption) Scheduler
  • func NewSchedulerProtobufClient(addr string, client HTTPClient, opts ...twirp.ClientOption) Scheduler
• type TwirpServer
  • func NewSchedulerServer(svc Scheduler, hooks *twirp.ServerHooks) TwirpServer

Constants

const SchedulerPathPrefix = "/twirp/scheduler.Scheduler/"

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

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

empty object

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 Event

type Event struct {
	Delay                int64    `protobuf:"varint,1,opt,name=delay,proto3" json:"delay,omitempty"`
	Message              string   `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

scheduled event

func (*Event) Descriptor

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

func (*Event) GetDelay

func (m *Event) GetDelay() int64

func (*Event) GetMessage

func (m *Event) GetMessage() string

func (*Event) ProtoMessage

func (*Event) ProtoMessage()

func (*Event) Reset

func (m *Event) Reset()

func (*Event) String

func (m *Event) String() string

func (*Event) XXX_DiscardUnknown

func (m *Event) XXX_DiscardUnknown()

func (*Event) XXX_Marshal

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

func (*Event) XXX_Merge

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

func (*Event) XXX_Size

func (m *Event) XXX_Size() int

func (*Event) XXX_Unmarshal

func (m *Event) 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 Scheduler

type Scheduler interface {
	Schedule(context.Context, *Event) (*Empty, error)
}

Schedule service

func NewSchedulerJSONClient

func NewSchedulerJSONClient(addr string, client HTTPClient, opts ...twirp.ClientOption) Scheduler

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

func NewSchedulerProtobufClient

func NewSchedulerProtobufClient(addr string, client HTTPClient, opts ...twirp.ClientOption) Scheduler

NewSchedulerProtobufClient creates a Protobuf client that implements the Scheduler 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 NewSchedulerServer

func NewSchedulerServer(svc Scheduler, hooks *twirp.ServerHooks) TwirpServer