account

package
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 6, 2018 License: MIT Imports: 16 Imported by: 0

Documentation

Overview

Package account is a generated protocol buffer package.

It is generated from these files:

proto/account/service.proto

It has these top-level messages:

ProfileReq
ProfileResp

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

It is generated from these files:

proto/account/service.proto

Index

Constants

View Source
const AccountPathPrefix = "/twirp/kithttp.example.account.Account/"

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

Variables

This section is empty.

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 Account

type Account interface {
	Profile(context.Context, *ProfileReq) (*ProfileResp, error)
}

func NewAccountJSONClient

func NewAccountJSONClient(addr string, client HTTPClient) Account

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

func NewAccountProtobufClient

func NewAccountProtobufClient(addr string, client HTTPClient) Account

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

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 ProfileReq

type ProfileReq struct {
	// Required
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
}

func (*ProfileReq) Descriptor

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

func (*ProfileReq) GetId

func (m *ProfileReq) GetId() string

func (*ProfileReq) ProtoMessage

func (*ProfileReq) ProtoMessage()

func (*ProfileReq) Reset

func (m *ProfileReq) Reset()

func (*ProfileReq) String

func (m *ProfileReq) String() string

type ProfileResp

type ProfileResp struct {
	Name    string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Email   string `protobuf:"bytes,2,opt,name=email" json:"email,omitempty"`
	Address string `protobuf:"bytes,3,opt,name=address" json:"address,omitempty"`
}

func (*ProfileResp) Descriptor

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

func (*ProfileResp) GetAddress

func (m *ProfileResp) GetAddress() string

func (*ProfileResp) GetEmail

func (m *ProfileResp) GetEmail() string

func (*ProfileResp) GetName

func (m *ProfileResp) GetName() string

func (*ProfileResp) ProtoMessage

func (*ProfileResp) ProtoMessage()

func (*ProfileResp) Reset

func (m *ProfileResp) Reset()

func (*ProfileResp) String

func (m *ProfileResp) String() string

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
}

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 NewAccountServer

func NewAccountServer(svc Account, hooks *twirp.ServerHooks) TwirpServer

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL