apiserver

Documentation

Index

• func MarshallCommands(cmds ...CmdNamer) []byte
• func NewHandler(f handlerFunc, middleware []MiddlewareFunc) *handler
• type ClientCommandDesciption
• type Closer
• type CmdNamer
• type CommandIn
• type CommandOut
• type Conn
• type Connection
  • func (self *Connection) Close()
  • func (self *Connection) Send(buf []byte) error
  • func (self *Connection) Session() interface{}
  • func (self *Connection) SetSession(v interface{})
  • func (self *Connection) Start()
• type Describer
  • func NewDescriber(tm map[reflect.Type]string) *Describer
  • func (self *Describer) Describe(t reflect.Type) interface{}
• type EmptyLogger
  • func (EmptyLogger) Println(v ...interface{})
• type ErrorCommand
  • func ApiError(typ, message string) *ErrorCommand
  • func (ErrorCommand) CmdName() string
  • func (e ErrorCommand) Error() string
• type FakeConn
  • func NewFakeConn() *FakeConn
  • func (*FakeConn) Close()
  • func (self *FakeConn) Send(buf []byte) error
  • func (self *FakeConn) Session() interface{}
  • func (self *FakeConn) SetSession(v interface{})
• type IRouter
• type Logger
• type MiddlewareFunc
• type PacketIn
• type PacketOut
• type Router
  • func NewRouter() *Router
  • func (self *Router) DescribeApi(tm map[reflect.Type]string) (scmds []*ServerCommandDesciption, ccmds []*ClientCommandDesciption)
  • func (self *Router) ProcessCommand(conn Conn, version int, command string, data json.RawMessage) (res []CommandOut)
  • func (self *Router) ProcessPacket(conn Conn, packetBuf []byte)
  • func (self *Router) RegisterApiHandler(version int, command string, handler handlerFunc)
  • func (self *Router) RegisterApiHandlerWithMiddleware(version int, command string, handler handlerFunc, middle []MiddlewareFunc)
  • func (self *Router) RegisterGetVersion(cb func(conn Conn) int)
  • func (self *Router) SetLogger(l Logger)
  • func (self *Router) With(mw MiddlewareFunc) *middlewareWrapper
• type Server
  • func NewServer(opts ServerOpts) (*Server, error)
  • func (self *Server) HandleWs(ws *websocket.Conn)
  • func (self *Server) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type ServerCommandDesciption
• type ServerOpts

Functions

func MarshallCommands

func MarshallCommands(cmds ...CmdNamer) []byte

func NewHandler

func NewHandler(f handlerFunc, middleware []MiddlewareFunc) *handler

Types

type ClientCommandDesciption

type ClientCommandDesciption struct {
	Name   string
	Params interface{}
}

type Closer

type Closer interface {
	Close()
}

type CmdNamer

type CmdNamer interface {
	CmdName() string
}

type CommandIn

type CommandIn struct {
	Name string          `json:"name"`
	Data json.RawMessage `json:"data,omitempty"`
}

type CommandOut

type CommandOut struct {
	Name string      `json:"name"`
	Data interface{} `json:"data,omitempty"`
}

type Conn

type Conn interface {
	Send([]byte) error
	Session() interface{}
	SetSession(v interface{})
	Close()
}

type Connection

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

func (*Connection) Close

func (self *Connection) Close()

func (*Connection) Send

func (self *Connection) Send(buf []byte) error

func (*Connection) Session

func (self *Connection) Session() interface{}

func (*Connection) SetSession

func (self *Connection) SetSession(v interface{})

func (*Connection) Start

func (self *Connection) Start()

type Describer

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

func NewDescriber

func NewDescriber(tm map[reflect.Type]string) *Describer

func (*Describer) Describe

func (self *Describer) Describe(t reflect.Type) interface{}

type EmptyLogger

type EmptyLogger struct{}

func (EmptyLogger) Println

func (EmptyLogger) Println(v ...interface{})

type ErrorCommand

type ErrorCommand struct {
	Type    string `json:"type"`
	Message string `json:"msg"`
}

func ApiError

func ApiError(typ, message string) *ErrorCommand

func (ErrorCommand) CmdName

func (ErrorCommand) CmdName() string

func (ErrorCommand) Error

func (e ErrorCommand) Error() string

type FakeConn

type FakeConn struct {
	SessionValue interface{}
	Written      [][]byte
}

func NewFakeConn

func NewFakeConn() *FakeConn

func (*FakeConn) Close

func (*FakeConn) Close()

func (*FakeConn) Send

func (self *FakeConn) Send(buf []byte) error

func (*FakeConn) Session

func (self *FakeConn) Session() interface{}

func (*FakeConn) SetSession

func (self *FakeConn) SetSession(v interface{})

type IRouter

type IRouter interface {
	RegisterApiHandler(version int, command string, handler handlerFunc)
}

type Logger

type Logger interface {
	Println(v ...interface{})
}

type MiddlewareFunc

type MiddlewareFunc func(conn Conn) (commands []CmdNamer, next bool)

type PacketIn

type PacketIn struct {
	Commands []CommandIn `json:"cmds"`
	Cid      int32       `json:"cid,omitempty"`
}

type PacketOut

type PacketOut struct {
	Commands []CommandOut `json:"cmds"`
	Cid      int32        `json:"cid,omitempty"`
}

type Router

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

func NewRouter

func NewRouter() *Router

func (*Router) DescribeApi

func (self *Router) DescribeApi(tm map[reflect.Type]string) (scmds []*ServerCommandDesciption, ccmds []*ClientCommandDesciption)

func (*Router) ProcessCommand

func (self *Router) ProcessCommand(conn Conn, version int, command string, data json.RawMessage) (res []CommandOut)

func (*Router) ProcessPacket

func (self *Router) ProcessPacket(conn Conn, packetBuf []byte)

func (*Router) RegisterApiHandler

func (self *Router) RegisterApiHandler(version int, command string, handler handlerFunc)

handlerFunc Must be func(*Conn,*SomeType) *SomeRetType,error Or func(*Conn,*SomeType) *SomeRetType,*SomeOtherRetType,error Or func(*Conn,*SomeType) []interface{},error Or func(*Conn,*SomeType) error

func (*Router) RegisterApiHandlerWithMiddleware

func (self *Router) RegisterApiHandlerWithMiddleware(version int, command string, handler handlerFunc, middle []MiddlewareFunc)

func (*Router) RegisterGetVersion

func (self *Router) RegisterGetVersion(cb func(conn Conn) int)

func (*Router) SetLogger

func (self *Router) SetLogger(l Logger)

func (*Router) With

func (self *Router) With(mw MiddlewareFunc) *middlewareWrapper

type Server

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

func NewServer

func NewServer(opts ServerOpts) (*Server, error)

func (*Server) HandleWs

func (self *Server) HandleWs(ws *websocket.Conn)

func (*Server) ServeHTTP

func (self *Server) ServeHTTP(w http.ResponseWriter, req *http.Request)

type ServerCommandDesciption

type ServerCommandDesciption struct {
	Name           string
	ReplayCommands []string
	Params         interface{}
}

type ServerOpts

type ServerOpts struct {
	Router       *Router
	NewSessionFn func() interface{}
	Logger       Logger
}