ws

Documentation

Index

• type Conn
• type ConnOption
• type Msg
• type Option
  • func WithHBInterval(hbInterval time.Duration) Option
  • func WithHandShakeTime(hst time.Duration) Option
  • func WithIn(in int) Option
  • func WithOut(out int) Option
  • func WithReadBuffer(rb int) Option
  • func WithReadLimit(rLimit int64) Option
  • func WithWriteBuffer(wb int) Option
  • func WithWriteTime(wt time.Duration) Option
• type Server
  • func NewServer(opts ...ServerOption) *Server
  • func (s *Server) Handler(handler http.HandlerFunc)
  • func (s *Server) NewSession(w http.ResponseWriter, r *http.Request) (*Session, error)
  • func (s *Server) Start() error
  • func (s *Server) Stop(ctx context.Context) error
• type ServerOption
  • func Address(addr string) ServerOption
  • func ConnOpt(opts ...Option) ServerOption
  • func Handle(handlers ...middleware.HTTPMiddleware) ServerOption
  • func Logger(l logger.Logger) ServerOption
  • func Path(path string) ServerOption
  • func Timeout(rTimeout, wTimeout time.Duration) ServerOption
  • func WithNetwork(network string) ServerOption
• type Session
  • func (s *Session) Close()
  • func (s *Session) Context() interface{}
  • func (s *Session) ID() string
  • func (s *Session) Receive() (*Msg, error)
  • func (s *Session) Send(m *Msg) error
  • func (s *Session) SetContext(ctx interface{})

Types

type Conn

type Conn interface {
	ID() string
	Context() interface{}
	SetContext(ctx interface{})
	Close()
	Receive() (*Msg, error)
	Send(m *Msg) error
}

type ConnOption

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

type Msg

type Msg struct {
	Type    int
	Payload []byte
	// contains filtered or unexported fields
}

type Option

type Option func(opt *ConnOption)

func WithHBInterval

func WithHBInterval(hbInterval time.Duration) Option

func WithHandShakeTime

func WithHandShakeTime(hst time.Duration) Option

func WithIn

func WithIn(in int) Option

func WithOut

func WithOut(out int) Option

func WithReadBuffer

func WithReadBuffer(rb int) Option

func WithReadLimit

func WithReadLimit(rLimit int64) Option

func WithWriteBuffer

func WithWriteBuffer(wb int) Option

func WithWriteTime

func WithWriteTime(wt time.Duration) Option

type Server

type Server struct {
	*http.Server

	*ConnOption
	// contains filtered or unexported fields
}

func NewServer

func NewServer(opts ...ServerOption) *Server

func (*Server) Handler

func (s *Server) Handler(handler http.HandlerFunc)

func (*Server) NewSession

func (s *Server) NewSession(w http.ResponseWriter, r *http.Request) (*Session, error)

func (*Server) Start

func (s *Server) Start() error

func (*Server) Stop

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

type ServerOption

type ServerOption func(*Server)

func Address

func Address(addr string) ServerOption

func ConnOpt

func ConnOpt(opts ...Option) ServerOption

func Handle

func Handle(handlers ...middleware.HTTPMiddleware) ServerOption

func Logger

func Logger(l logger.Logger) ServerOption

func Path

func Path(path string) ServerOption

func Timeout

func Timeout(rTimeout, wTimeout time.Duration) ServerOption

func WithNetwork

func WithNetwork(network string) ServerOption

type Session

type Session struct {
	sync.Mutex // avoid close chan duplicated
	*ConnOption
	// contains filtered or unexported fields
}

func (*Session) Close

func (s *Session) Close()

func (*Session) Context

func (s *Session) Context() interface{}

func (*Session) ID

func (s *Session) ID() string

func (*Session) Receive

func (s *Session) Receive() (*Msg, error)

func (*Session) Send

func (s *Session) Send(m *Msg) error

func (*Session) SetContext

func (s *Session) SetContext(ctx interface{})