hellword

Documentation

Overview

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

helloword.proto

Index

• Constants
• func RegisterGreeterServer(s *grpc.Server, srv GreeterServer)
• func WriteError(resp http.ResponseWriter, err error)
• type Greeter
  • func NewGreeterJSONClient(addr string, client HTTPClient) Greeter
  • func NewGreeterProtobufClient(addr string, client HTTPClient) Greeter
• type GreeterClient
  • func NewGreeterClient(cc *grpc.ClientConn) GreeterClient
• type GreeterServer
• type HTTPClient
• type HelloRequest
  • func (*HelloRequest) Descriptor() ([]byte, []int)
  • func (m *HelloRequest) GetName() string
  • func (*HelloRequest) ProtoMessage()
  • func (m *HelloRequest) Reset()
  • func (m *HelloRequest) String() string
  • func (m *HelloRequest) XXX_DiscardUnknown()
  • func (m *HelloRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *HelloRequest) XXX_Merge(src proto.Message)
  • func (m *HelloRequest) XXX_Size() int
  • func (m *HelloRequest) XXX_Unmarshal(b []byte) error
• type HelloResponse
  • func (*HelloResponse) Descriptor() ([]byte, []int)
  • func (m *HelloResponse) GetMessage() string
  • func (*HelloResponse) ProtoMessage()
  • func (m *HelloResponse) Reset()
  • func (m *HelloResponse) String() string
  • func (m *HelloResponse) XXX_DiscardUnknown()
  • func (m *HelloResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *HelloResponse) XXX_Merge(src proto.Message)
  • func (m *HelloResponse) XXX_Size() int
  • func (m *HelloResponse) XXX_Unmarshal(b []byte) error
• type TwirpServer
  • func NewGreeterServer(svc Greeter, hooks *twirp.ServerHooks) TwirpServer
• type UnimplementedGreeterServer
  • func (*UnimplementedGreeterServer) SayHello(ctx context.Context, req *HelloRequest) (*HelloResponse, error)

Constants

const GreeterPathPrefix = "/twirp/hellword.Greeter/"

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

Functions

func RegisterGreeterServer

func RegisterGreeterServer(s *grpc.Server, srv GreeterServer)

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 Greeter

type Greeter interface {
	SayHello(context.Context, *HelloRequest) (*HelloResponse, error)
}

func NewGreeterJSONClient

func NewGreeterJSONClient(addr string, client HTTPClient) Greeter

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

func NewGreeterProtobufClient

func NewGreeterProtobufClient(addr string, client HTTPClient) Greeter

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

type GreeterClient

type GreeterClient interface {
	SayHello(ctx context.Context, in *HelloRequest, opts ...grpc.CallOption) (*HelloResponse, error)
}

GreeterClient is the client API for Greeter service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewGreeterClient

func NewGreeterClient(cc *grpc.ClientConn) GreeterClient

type GreeterServer

type GreeterServer interface {
	SayHello(context.Context, *HelloRequest) (*HelloResponse, error)
}

GreeterServer is the server API for Greeter service.

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 HelloRequest

type HelloRequest struct {
	Name                 string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*HelloRequest) Descriptor

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

func (*HelloRequest) GetName

func (m *HelloRequest) GetName() string

func (*HelloRequest) ProtoMessage

func (*HelloRequest) ProtoMessage()

func (*HelloRequest) Reset

func (m *HelloRequest) Reset()

func (*HelloRequest) String

func (m *HelloRequest) String() string

func (*HelloRequest) XXX_DiscardUnknown

func (m *HelloRequest) XXX_DiscardUnknown()

func (*HelloRequest) XXX_Marshal

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

func (*HelloRequest) XXX_Merge

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

func (*HelloRequest) XXX_Size

func (m *HelloRequest) XXX_Size() int

func (*HelloRequest) XXX_Unmarshal

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

type HelloResponse

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

func (*HelloResponse) Descriptor

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

func (*HelloResponse) GetMessage

func (m *HelloResponse) GetMessage() string

func (*HelloResponse) ProtoMessage

func (*HelloResponse) ProtoMessage()

func (*HelloResponse) Reset

func (m *HelloResponse) Reset()

func (*HelloResponse) String

func (m *HelloResponse) String() string

func (*HelloResponse) XXX_DiscardUnknown

func (m *HelloResponse) XXX_DiscardUnknown()

func (*HelloResponse) XXX_Marshal

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

func (*HelloResponse) XXX_Merge

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

func (*HelloResponse) XXX_Size

func (m *HelloResponse) XXX_Size() int

func (*HelloResponse) XXX_Unmarshal

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

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 NewGreeterServer

func NewGreeterServer(svc Greeter, hooks *twirp.ServerHooks) TwirpServer

type UnimplementedGreeterServer

type UnimplementedGreeterServer struct {
}

UnimplementedGreeterServer can be embedded to have forward compatible implementations.

func (*UnimplementedGreeterServer) SayHello

func (*UnimplementedGreeterServer) SayHello(ctx context.Context, req *HelloRequest) (*HelloResponse, error)