transport

Documentation

Index

• Constants
• type CompoundServiceDesc
  • func NewCompoundServiceDesc(desc ...ServiceDesc) *CompoundServiceDesc
  • func (d *CompoundServiceDesc) Apply(oo ...DescOption)
  • func (d *CompoundServiceDesc) RegisterGRPC(g *grpc.Server)
  • func (d *CompoundServiceDesc) RegisterHTTP(r Router)
  • func (d *CompoundServiceDesc) SwaggerDef(options ...swagger.Option) []byte
• type ConfigurableServiceDesc
• type DescOption
  • func WithSwaggerOptions(o ...swagger.Option) DescOption
  • func WithUnaryInterceptor(i grpc.UnaryServerInterceptor) DescOption
• type Router
• type Service
• type ServiceDesc

Constants

const IsVersion2 = "v2"

IsVersion2 is a static check for lib<->generator version mismatch.

Types

type CompoundServiceDesc

type CompoundServiceDesc struct {
	// contains filtered or unexported fields
}

func NewCompoundServiceDesc

func NewCompoundServiceDesc(desc ...ServiceDesc) *CompoundServiceDesc

func (*CompoundServiceDesc) Apply

func (d *CompoundServiceDesc) Apply(oo ...DescOption)

func (*CompoundServiceDesc) RegisterGRPC

func (d *CompoundServiceDesc) RegisterGRPC(g *grpc.Server)

func (*CompoundServiceDesc) RegisterHTTP

func (d *CompoundServiceDesc) RegisterHTTP(r Router)

func (*CompoundServiceDesc) SwaggerDef

func (d *CompoundServiceDesc) SwaggerDef(options ...swagger.Option) []byte

type ConfigurableServiceDesc

type ConfigurableServiceDesc interface {
	Apply(...DescOption)
}

ConfigurableServiceDesc is implemented by configurable ServiceDescs.

type DescOption

type DescOption interface {
	Apply(*httptransport.DescOptions)
}

DescOption modifies the ServiceDesc's behaviour.

func WithSwaggerOptions

func WithSwaggerOptions(o ...swagger.Option) DescOption

WithSwaggerOptions sets up default Swagger options for the SwaggerDef().

func WithUnaryInterceptor

func WithUnaryInterceptor(i grpc.UnaryServerInterceptor) DescOption

WithUnaryInterceptor sets up the interceptor for incoming calls.

type Router

type Router interface {
	http.Handler
	Handle(pattern string, h http.Handler)
}

Router routes HTTP requests around.

type Service

type Service interface {
	GetDescription() ServiceDesc
}

Service is a registerable collection of endpoints. These functions should be autogenerated by protoc-gen-goclay.

type ServiceDesc

type ServiceDesc interface {
	RegisterGRPC(*grpc.Server)
	RegisterHTTP(Router)
	SwaggerDef(options ...swagger.Option) []byte
}

ServiceDesc is a description of an endpoints' collection. These functions should be autogenerated by protoc-gen-goclay.