ktcp

Documentation

Index

• Constants
• Variables
• func NewContext() *routerCtx
• type CallBack
• type Context
• type Handler
• type Server
  • func NewServer(handler Handler, opts ...ServerOption) *Server
  • func (s *Server) GracefulStop()
  • func (s *Server) Serve() error
  • func (s *Server) Stop(ctx context.Context) (err error)
• type ServerOption
  • func Address(addr string) ServerOption
  • func Logger(logger log.Logger) ServerOption
  • func Middleware(m ...middleware.Middleware) ServerOption
  • func Network(network string) ServerOption
  • func ReadTimeout(readTimeout time.Duration) ServerOption
  • func WriteTimeout(writeTimeout time.Duration) ServerOption
• type Session
  • func (s *Session) Close()
  • func (s *Session) Codec() encoding.Codec
  • func (s *Session) ID() string
  • func (s *Session) Send(ctx Context) (err error)
  • func (s *Session) SendMsg(id uint32, data interface{}) (err error)

Constants

const (
	B = 1 << (10 * iota)
	KB
	MB
	GB
	TB
	PB
	EB
)

Byte unit helpers.

Variables

var ErrServerStopped = errors.New("ktcp: the server has been stopped")

ErrServerStopped is returned when server stopped.

var ErrSessionClosed = fmt.Errorf("session closed")

ErrSessionClosed is returned when session stopped.

Functions

func NewContext

func NewContext() *routerCtx

Types

type CallBack

type CallBack interface {
	OnMessage(c Context)
	OnClose(c *Session)
}

type Context

type Context interface {
	context.Context
	GetSession() *Session
	ForwardHandler(c CallBack)
	GetReqMsg() *message.Message
	Bind(v interface{}) error
	Response() *message.Message
	Send(id uint32, resp interface{}) error
	SendError(id uint32, resp interface{}) error
	Middleware(middleware.Handler) middleware.Handler
	Reset(sess *Session, reqMsg *message.Message)
	AppendToStorage(saver storage.Saver)
	Save() (err error)
}

Context is a generic context in a message routing. It allows us to pass variables between handler and middlewares.

type Handler

type Handler interface {
	CallBack
	OnConnect(s *Session)
}

Handler Server

type Server

type Server struct {
	Listener net.Listener
	Packer   packing.Packer // Packer is the message packer, will be passed to session.
	Codec    encoding.Codec // Codec is the message codec, will be passed to session.
	// contains filtered or unexported fields
}

Server is a server for TCP connections.

func NewServer

func NewServer(handler Handler, opts ...ServerOption) *Server

NewServer creates an TCP server by options.

func (*Server) GracefulStop

func (s *Server) GracefulStop()

TODO GracefulStop

func (*Server) Serve

func (s *Server) Serve() error

Serve the TCP server

func (*Server) Stop

func (s *Server) Stop(ctx context.Context) (err error)

Stop the TCP server.

type ServerOption

type ServerOption func(*Server)

ServerOption is an HTTP server option.

func Address

func Address(addr string) ServerOption

Address with server address.

func Logger

func Logger(logger log.Logger) ServerOption

Logger with server logger.

func Middleware

func Middleware(m ...middleware.Middleware) ServerOption

Middleware with service middleware option.

func Network

func Network(network string) ServerOption

Network with server network.

func ReadTimeout

func ReadTimeout(readTimeout time.Duration) ServerOption

ReadTimeout with server timeout.

func WriteTimeout

func WriteTimeout(writeTimeout time.Duration) ServerOption

WriteTimeout with server timeout.

type Session

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

Session is a server side network connection.

func (*Session) Close

func (s *Session) Close()

Close closes the session, but doesn't close the connection.

func (*Session) Codec

func (s *Session) Codec() encoding.Codec

func (*Session) ID

func (s *Session) ID() string

ID returns the session's ID.

func (*Session) Send

func (s *Session) Send(ctx Context) (err error)

Send pushes response message entry to respQueue.

func (*Session) SendMsg

func (s *Session) SendMsg(id uint32, data interface{}) (err error)

SendMsg sends message to session.