router

type CacheAdaptor interface {
	Set(key []byte, data []byte, ttl time.Duration) error
	Get(key []byte) ([]byte, error)
}

type Client interface {
	IP() string
	Host() string
	Device() Device
	Protocol() string
}

type Context interface {
	Deadline() (time.Time, bool)
	Done() <-chan struct{}
	Err() error
	Value(interface{}) interface{}
	Identity() Identity
	MachineID() string
	ProcessID() string
	Context() context.Context
	Req() *http.Request
	Res() http.ResponseWriter
	Client() Client
	Cache() CacheAdaptor
	Message() MessageAdaptor
	GQLSubscription() GQLSubscriptionAdaptor
	DataLoader(interface{}) DataLoaderAdaptor
	KV() KV
	Cookie() Cookie
	Header() Header
	MustParam(s string) Value
	MustQuery(s string) Value
	MustBody(s string) Value
	Param(s string) (Value, error)
	Query(s string) (Value, error)
	Body(s string) (Value, error)
	File(s string) []byte
	StartSpan(operationName string, opts ...opentracing.StartSpanOption) opentracing.Span
	Tracer() opentracing.Tracer
	Recover() error
	Abort()
	IsAborted() bool
	Proto(ProtoMessage) Context
	Write(b []byte) Context
	Error(error) Context
	Json(o interface{}) Context
	Status(code int) Context
	Child() Context
}

type Cookie interface {
	Set(key string, val string, opts ...cookie.Option)
	Get(key string) (Value, error)
	MustGet(key string) Value
}

type CustomFunc func(v []byte) bool

type DataLoaderAdaptor interface {
	Load(context.Context, interface{}) (interface{}, error)
	LoadMany(context.Context, []interface{}) ([]interface{}, []error)
	Clear(interface{})
	ClearAll()
	Prime(interface{}, interface{})
}

type Device interface {
	Useragent() Useragent
	Hardware() Hardware
	OS() OS
}

type GQLEvent interface {
	Field() string
	Payload() []byte
	Filters() map[string]interface{}
	EqIDs() []int64
	NeIDs() []int64
	EqKeys() []string
	NeKeys() []string
	Strict() bool
}

type GQLSubscriptionAdaptor interface {
	Emit(GQLEvent) error
}

type HandlerFunc func(Context)

type HandlerFuncs []HandlerFunc

type Hardware interface {
	Family() string
	Brand() string
	Model() string
}

type Header interface {
	Set(key string, val string)
	Get(key string) (Value, error)
	MustGet(key string) Value
}

type Identity interface {
	HasID() bool
	GetID() int
	SetID(int)
	HasKey() bool
	GetKey() string
	SetKey(string)
}

type KV interface {
	Set(string, []byte) KV
	Get(string) []byte
}

type MessageAdaptor interface {
	Emit([]byte, []byte) error
	Listen([]byte, message.Handler) message.Close
}

type Model interface {
	Code() int
	Hash() string
}

type OS interface {
	Family() string
	Major() string
	Minor() string
	Patch() string
}

type Option func(*Options)

type Options struct {

	// engine server unique id
	ID string
}

type Param interface {
	Custom(CustomFunc) Param
	Format(int) Param
	Summary(string) Param
	Doc(string) Param
	Default([]byte) Param
	Require(bool) Param
	DependsOn(...Param) Param
	Config() ParamConfig
}

type ParamConfig interface {
	Name() string
	Type() ParamType
	Custom() CustomFunc
	Format() int
	Summary() string
	Doc() string
	Default() []byte
	Require() bool
	DependsOn() []Param
	OneOf() []Param
}

type ParamType int

type ProtoMessage interface {
	Reset()
	String() string
	ProtoMessage()
}

type Route interface {
	Get(string) Route
	Head(string) Route
	Options(string) Route
	Post(string) Route
	Put(string) Route
	Patch(string) Route
	Delete(string) Route
	Namespace(string) Route
	Alias(...string) Route
	Name(string) Route
	Summary(string) Route
	Doc(string) Route
	Params(...Param) Route
	ClearParams() Route
	MaxMemory(int64) Route
	Handle(HandlerFunc) Route
	Catch(HandlerFunc) Route
	Middleware(...HandlerFunc) Route
	ClearMiddleware() Route
	Websocket(bool) Route
	HTTP(bool) Route
	Models(...Model) Route
	Config() RouteConfig
}

type RouteConfig interface {
	Pattern() string
	Aliases() []string
	Method() string
	Name() string
	Summary() string
	Doc() string
	Namespace() bool
	Websocket() bool
	HTTP() bool
	Params() []Param
	ValueIndex(Param) int
	MaxMemory() int64
	Routes() []Route
	Handler() HandlerFunc
	Catch() HandlerFunc
	Middlewares() HandlerFuncs
	Model(int) interface{}
}

type Service interface {
	Start() error
	Stop() error
	Get(string) Route
	Head(string) Route
	Options(string) Route
	Post(string) Route
	Put(string) Route
	Patch(string) Route
	Delete(string) Route
	Namespace(string) Route
	NotFound(HandlerFunc) Service
	MethodNotAllowed(HandlerFunc) Service
	Params(...Param) Service
	Middleware(...HandlerFunc) Service
	RouteNotFound() HandlerFunc
	RouteNotAllowed() HandlerFunc
	Routes() []Route
	String() string
}

type Useragent interface {
	Family() string
	Major() string
	Minor() string
	Patch() string
	String() string
}

type Value interface {
	Key() string
	Val() []byte
	Has() bool
	MustInt() int
	MustI32() int32
	MustI64() int64
	MustU32() uint32
	MustU64() uint64
	MustF32() float32
	MustF64() float64
	MustBool() bool
	MustTime() time.Time
	String() string
}