websocket

Documentation

Index

• Constants
• Variables
• func DisableLog()
• func UseLogger(logger elalog.Logger)
• type Config
• type Handler
• type Response
• type Server
  • func NewServer(orgCfg *Config) *Server
  • func (s *Server) GetSessionList() *SessionList
  • func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (s *Server) Start() error
  • func (s *Server) Stop() error
• type Session
  • func (s *Session) IsTimeout() bool
  • func (s *Session) Send(data []byte) error
• type SessionList
  • func (sl *SessionList) CloseSession(session *Session)
  • func (sl *SessionList) ForEach(closure func(*Session))
  • func (sl *SessionList) NewSession(conn *websocket.Conn) *Session

Constants

const (

	// PFBlock indicates push block info (JSON format) message to online
	// list when a block added to chain.
	PFBlock uint32 = 1 << iota

	// PFRawBlock indicates push RAW block message to online list when a
	// block added to chain.
	PFRawBlock

	// PFBlockTxs indicates push block transactions info (JSON format) message
	// to online list when a block added to chain.
	PFBlockTxs

	// PFBlockTxs indicates push new transaction info (JSON format) message to
	// online list when a transaction added to mempool.
	PFNewTx
)

Variables

var (
	ErrSessionExpired    = errors.New("session expired")
	ErrIllegalDataFormat = errors.New("illegal data format")
	ErrInvalidRequest    = errors.New("invalid request")
	ErrInvalidMethod     = errors.New("invalid method")
)

Functions

func DisableLog

func DisableLog()

DisableLog disables all library log output. Logging output is disabled by default until either UseLogger or SetLogWriter are called.

func UseLogger

func UseLogger(logger elalog.Logger)

UseLogger uses a specified Logger to output package logging info. This should be used in preference to SetLogWriter if the caller is also using elalog.

Types

type Config

type Config struct {
	ServiceCfg        *service.Config
	ServePort         uint16
	Flags             uint32
	HeartbeatInterval time.Duration
	Service           *service.HttpService
}

type Handler

type Handler func(htp.Params) (interface{}, error)

Handler is the registered method to handle a http request.

type Response

type Response struct {
	Action string
	Result interface{}
	Error  int
	Desc   string
}

Response represent the response data structure.

type Server

type Server struct {
	websocket.Upgrader
	// contains filtered or unexported fields
}

func NewServer

func NewServer(orgCfg *Config) *Server

func (*Server) GetSessionList

func (s *Server) GetSessionList() *SessionList

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*Server) Start

func (s *Server) Start() error

func (*Server) Stop

func (s *Server) Stop() error

type Session

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

func (*Session) IsTimeout

func (s *Session) IsTimeout() bool

func (*Session) Send

func (s *Session) Send(data []byte) error

type SessionList

type SessionList struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func (*SessionList) CloseSession

func (sl *SessionList) CloseSession(session *Session)

func (*SessionList) ForEach

func (sl *SessionList) ForEach(closure func(*Session))

func (*SessionList) NewSession

func (sl *SessionList) NewSession(conn *websocket.Conn) *Session