websocket

Documentation

Index

• func RegisterChannelCreator(prefix string, fn channelCreator)
• func RemoveSubscriberAllChannels(client *Client)
• type Channel
  • func (c *Channel) AddMessage(msg *message.WebSocketMessage)
  • func (c *Channel) AddSubscriber(client *Client)
  • func (c *Channel) GetID() string
  • func (c *Channel) MessagesChan() chan *message.WebSocketMessage
  • func (c *Channel) RemoveSubscriber(ID string)
  • func (c *Channel) SubScribeChan() chan *Client
  • func (c *Channel) UnsubscribeChan() chan string
• type Client
  • func NewClient(conn clientConn) *Client
  • func (c *Client) AddLoginAddress(address string)
  • func (c *Client) CheckLogin(address string) bool
  • func (c *Client) Close()
  • func (c *Client) SendMsg(msg interface{})
• type ClientRequest
• type IChannel
• type Server
  • func New(ctx context.Context, msgChan chan interface{}) *Server
  • func (s *Server) Start() error

Functions

func RegisterChannelCreator

func RegisterChannelCreator(prefix string, fn channelCreator)

func RemoveSubscriberAllChannels

func RemoveSubscriberAllChannels(client *Client)

Types

type Channel

type Channel struct {
	ID      string
	Clients sync.Map

	Subscribe   chan *Client
	Unsubscribe chan string
	Messages    chan *message.WebSocketMessage
}

Channel is a basic type implemented IChannel

func (*Channel) AddMessage

func (c *Channel) AddMessage(msg *message.WebSocketMessage)

func (*Channel) AddSubscriber

func (c *Channel) AddSubscriber(client *Client)

func (*Channel) GetID

func (c *Channel) GetID() string

func (*Channel) MessagesChan

func (c *Channel) MessagesChan() chan *message.WebSocketMessage

func (*Channel) RemoveSubscriber

func (c *Channel) RemoveSubscriber(ID string)

func (*Channel) SubScribeChan

func (c *Channel) SubScribeChan() chan *Client

func (*Channel) UnsubscribeChan

func (c *Channel) UnsubscribeChan() chan string

type Client

type Client struct {
	ID   string
	Conn clientConn

	LoginAddresses map[string]struct{}
	// mu       sync.Mutex
	// for orderbook channel
	Group    int
	Depth    int
	Interval int
	// contains filtered or unexported fields
}

func NewClient

func NewClient(conn clientConn) *Client

func (*Client) AddLoginAddress

func (c *Client) AddLoginAddress(address string)

func (*Client) CheckLogin

func (c *Client) CheckLogin(address string) bool

func (*Client) Close

func (c *Client) Close()

func (*Client) SendMsg

func (c *Client) SendMsg(msg interface{})

type ClientRequest

type ClientRequest struct {
	Type     string   `json:"type"`
	Jwt      string   `json:"jwt"`
	MaiToken string   `json:"maiAuth"`
	Channels []string `json:"channels"`
}

type IChannel

type IChannel interface {
	GetID() string

	// Thread safe calls
	AddSubscriber(*Client)
	RemoveSubscriber(string)
	AddMessage(message *message.WebSocketMessage)

	UnsubscribeChan() chan string
	SubScribeChan() chan *Client
	MessagesChan() chan *message.WebSocketMessage
	// contains filtered or unexported methods
}

type Server

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

func New

func New(ctx context.Context, msgChan chan interface{}) *Server

func (*Server) Start

func (s *Server) Start() error