stream

Documentation

Index

• Constants
• type BroadcastClient
• type Client
  • func (c *Client) Close()
  • func (c *Client) Notify(t, b string)
  • func (c *Client) UpdateInfo(msg Message)
  • func (c *Client) Write(payload []byte) (err error)
  • func (c *Client) WritePump()
• type Hub
  • func NewHub() *Hub
  • func (h *Hub) AddClient(client *Client)
  • func (h *Hub) Broadcast(message []byte)
  • func (h *Hub) Clients() (clients []*Client)
  • func (h *Hub) Recv(client *Client, b []byte)
  • func (h *Hub) Run()
  • func (h *Hub) Send(client *Client, message []byte)
  • func (h *Hub) Subscribe(command string, f func(client IStreamClient, msg Message))
  • func (h *Hub) Subscriber(command string) (f func(client IStreamClient, msg Message))
  • func (h *Hub) UnSubscribe(command string)
• type IStreamClient
• type Message
  • func NewMessage(b []byte) (message Message, err error)
  • func (m *Message) Error(err error) *Message
  • func (m *Message) IsError() (err error)
  • func (m *Message) Pack() []byte
  • func (m *Message) Response(payload map[string]interface{}) *Message
  • func (m *Message) Success() *Message
• type StreamService
  • func NewStreamService(hub *Hub) *StreamService
  • func (s *StreamService) Broadcast(message []byte)
  • func (s *StreamService) Subscribe(command string, f func(client IStreamClient, msg Message))
  • func (s *StreamService) UnSubscribe(command string)
  • func (w *StreamService) Ws(ctx *gin.Context)

Constants

const (
	// Request ...
	Request = "request"
	// Response ...
	Response = "response"
	// StatusSuccess ...
	StatusSuccess = "success"
	// StatusError ...
	StatusError = "error"
	// Notify ...
	Notify = "notify"
	// Broadcast ...
	Broadcast = "broadcast"
)

Types

type BroadcastClient

type BroadcastClient interface {
	Broadcast(message []byte)
}

BroadcastClient ...

type Client

type Client struct {
	Ip        string
	Referer   string
	UserAgent string
	Width     int
	Height    int
	Cookie    bool
	Language  string
	Platform  string
	Location  string
	Href      string
	Send      chan []byte // message buffered channel

	Connect *websocket.Conn
	// contains filtered or unexported fields
}

Client ...

func (*Client) Close

func (c *Client) Close()

Close ...

func (*Client) Notify

func (c *Client) Notify(t, b string)

Notify ...

func (*Client) UpdateInfo

func (c *Client) UpdateInfo(msg Message)

UpdateInfo ...

func (*Client) Write

func (c *Client) Write(payload []byte) (err error)

Write ...

func (*Client) WritePump

func (c *Client) WritePump()

send message to client

type Hub

type Hub struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Hub ...

func NewHub

func NewHub() *Hub

NewHub ...

func (*Hub) AddClient

func (h *Hub) AddClient(client *Client)

AddClient ...

func (*Hub) Broadcast

func (h *Hub) Broadcast(message []byte)

Broadcast ...

func (*Hub) Clients

func (h *Hub) Clients() (clients []*Client)

Clients ...

func (*Hub) Recv

func (h *Hub) Recv(client *Client, b []byte)

Recv ...

func (*Hub) Run

func (h *Hub) Run()

Run ...

func (*Hub) Send

func (h *Hub) Send(client *Client, message []byte)

Send ...

func (*Hub) Subscribe

func (h *Hub) Subscribe(command string, f func(client IStreamClient, msg Message))

Subscribe ...

func (*Hub) Subscriber

func (h *Hub) Subscriber(command string) (f func(client IStreamClient, msg Message))

Subscriber ...

func (*Hub) UnSubscribe

func (h *Hub) UnSubscribe(command string)

UnSubscribe ...

type IStreamClient

type IStreamClient interface {
	Write(payload []byte) error
	Notify(t, b string)
}

IStreamClient ...

type Message

type Message struct {
	Id      uuid.UUID              `json:"id"`
	Command string                 `json:"command"`
	Payload map[string]interface{} `json:"payload"`
	Forward string                 `json:"forward"`
	Status  string                 `json:"status"`
	Type    string                 `json:"type"`
}

Message ...

func NewMessage

func NewMessage(b []byte) (message Message, err error)

NewMessage ...

func (*Message) Error

func (m *Message) Error(err error) *Message

Error ...

func (*Message) IsError

func (m *Message) IsError() (err error)

IsError ...

func (*Message) Pack

func (m *Message) Pack() []byte

Pack ...

func (*Message) Response

func (m *Message) Response(payload map[string]interface{}) *Message

Response ...

func (*Message) Success

func (m *Message) Success() *Message

Success ...

type StreamService

type StreamService struct {
	Hub *Hub
}

StreamService ...

func NewStreamService

func NewStreamService(hub *Hub) *StreamService

NewStreamService ...

func (*StreamService) Broadcast

func (s *StreamService) Broadcast(message []byte)

Broadcast ...

func (*StreamService) Subscribe

func (s *StreamService) Subscribe(command string, f func(client IStreamClient, msg Message))

Subscribe ...

func (*StreamService) UnSubscribe

func (s *StreamService) UnSubscribe(command string)

UnSubscribe ...

func (*StreamService) Ws

func (w *StreamService) Ws(ctx *gin.Context)

Ws ...