ws

package
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 3, 2024 License: MIT Imports: 19 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	MSG_CLIENT_CONNECT          = "Client connected %s to Hub:%s"
	MSG_CLIENT_DISCONNECT       = "Client disconnected %s to Hub:%s"
	ERR_SERVER_NOT_FOUND        = "Server not found"
	ERR_CLIENT_NOT_FOUND        = "Client not found"
	ERR_CLIENT_IS_CLOSED        = "Client is closed"
	ERR_NOT_WS_SERVICE          = "Not websocket service"
	ERR_NOT_DEFINE_CLIENTID     = "Not define clientId"
	ERR_NOT_DEFINE_USERNAME     = "Not define username"
	ERR_NOT_CONNECT_WS          = "Not connect socket"
	ERR_CHANNEL_NOT_FOUND       = "Channel not found"
	ERR_CHANNEL_NOT_SUBSCRIBERS = "Channel not subscribers - %s"
	ERR_CHANNEL_EMPTY           = "Channel is empty"
	ERR_PARAM_NOT_FOUND         = "Param not found"
	ERR_CLIENT_ID_EMPTY         = "Client id is empty"
	ERR_MESSAGE_UNFORMATTED     = "Message unformatted"
	ERR_REDISADAPTER_NOT_FOUND  = "Redis adapter not found"
	PARAMS_UPDATED              = "Params updated"
)

Variables

This section is empty.

Functions

func Close 

func Close() error

* * Close the Websocket Hub * @return error *

func ConnectWs added in v0.0.177 

func ConnectWs(host, scheme, clientId, name string) (*websocket.Conn, error)

* * ConnectWs connect to the server using the websocket * @param host string * @param scheme string * @param clientId string * @param name string * @return *websocket.Conn * @return error *

Types

type Channel 

type Channel struct {
	Name        string
	Group       map[string]int
	Subscribers []*Client
}

* * Channel *

func (*Channel) Broadcast added in v0.0.177 

func (ch *Channel) Broadcast(message []byte)

* * Broadcast a message to all subscribers * @param message []byte *

func (*Channel) Count added in v0.0.177 

func (ch *Channel) Count() int

* * Count return the number of subscribers * @return int *

func (*Channel) Low added in v0.0.177 

func (ch *Channel) Low() string

* * Low return the channel name in lowercase * @return string *

func (*Channel) NextTurn added in v0.0.177 

func (ch *Channel) NextTurn(queue string) *Client

* * NextTurn return the next subscriber * @return *Client *

func (*Channel) QueueSubscribe added in v0.0.177 

func (ch *Channel) QueueSubscribe(client *Client, queue string)

* * QueueSubscribe a client to channel * @param client *Client *

func (*Channel) Subscribe added in v0.0.177 

func (ch *Channel) Subscribe(client *Client)

* * Subscribe a client to channel * @param client *Client *

func (*Channel) Unsubcribe 

func (ch *Channel) Unsubcribe(clientId string) error

* * Unsubcribe a client from channel * @param clientId string * @return error *

func (*Channel) Up added in v0.0.177 

func (ch *Channel) Up() string

* * Up return the channel name in uppercase * @return string *

type Client 

type Client struct {
	Created_at time.Time

	Id   string
	Name string
	Addr string

	Channels []string
	// contains filtered or unexported fields
}

func ConnectHttp added in v0.0.177 

func ConnectHttp(w http.ResponseWriter, r *http.Request) (*Client, error)

* * ConnectHttp connect to the server using the http * @param w http.ResponseWriter * @param r *http.Request * @return *Client * @return error *

func (*Client) From added in v0.0.177 

func (c *Client) From() et.Json

* * From * @return et.Json *

type ClientWS added in v0.0.138 

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

func Cliente added in v0.0.138 

func Cliente(host string, reciveFn func(message []byte)) *ClientWS

Create a new client websocket connection

func (*ClientWS) Close added in v0.0.138 

func (s *ClientWS) Close()

Close the client websocket connection

func (*ClientWS) Write added in v0.0.138 

func (s *ClientWS) Write(message string) error

type Hub 

type Hub struct {
	Id     string
	Name   string
	Params *HubParams
	// contains filtered or unexported fields
}

func NewHub 

func NewHub() *Hub

* * NewHub * @return *Hub *

func Server added in v0.0.177 

func Server() (*Hub, error)

* * Server creates a new Websocket Hub * @return *Hub *

func (*Hub) Close added in v0.0.177 

func (h *Hub) Close()

* * Close *

func (*Hub) GetSubscribers 

func (h *Hub) GetSubscribers(channel string) []*Client

* * GetSubscribers * @param channel string * @return []*Client *

func (*Hub) Identify added in v0.0.177 

func (h *Hub) Identify() et.Json

* * Identify the hub * @return et.Json *

func (*Hub) Mute added in v0.0.177 

func (h *Hub) Mute(channel string, msg Message, ignored []string, from et.Json) error

* * Mute a message to a channel * @param channel string * @param msg Message * @param ignored []string * @param from et.Json * @return error *

func (*Hub) Publish 

func (h *Hub) Publish(channel string, msg Message, ignored []string, from et.Json) error

* * Publish a message to a channel * @param channel string * @param msg Message * @param ignored []string * @param from et.Json * @return error *

func (*Hub) RedisAdapter added in v0.0.177 

func (h *Hub) RedisAdapter(params *RedisAdapterParams) error

* * RedisAdapter is a struct to manage the Redis connection * to broadcast messages to all clients in the cluster hub * @param params *RedisAdapterParams * @return error *

func (*Hub) Run 

func (h *Hub) Run()

* * Run *

func (*Hub) SendMessage 

func (h *Hub) SendMessage(clientId string, msg Message) error

* * SendMessage * @param clientId string * @param msg Message * @return error *

func (*Hub) SetName added in v0.0.177 

func (h *Hub) SetName(name string)

* * SetName * @param name string *

func (*Hub) Stack added in v0.0.177 

func (h *Hub) Stack(clientId string, channel, queue string) error

* * Stack a client to hub channels * @param clientId string * @param channel string * @return error *

func (*Hub) Subscribe added in v0.0.44 

func (h *Hub) Subscribe(clientId string, channel string) error

* * Subscribe a client to hub channels * @param clientId string * @param channel string * @return error *

func (*Hub) Unsubscribe added in v0.0.44 

func (h *Hub) Unsubscribe(clientId string, channel string) error

* * Unsubscribe a client from hub channels * @param clientId string * @param channel string * @return error *

type HubParams added in v0.0.177 

type HubParams struct {
	Id   string
	Name string
}

type Message added in v0.0.177 

type Message struct {
	Created_at time.Time `json:"created_at"`
	Id         string    `json:"id"`
	From       et.Json   `json:"from"`

	Ignored []string    `json:"ignored"`
	Tp      m.TpMessage `json:"tp"`
	Channel string      `json:"channel"`
	Queue   string      `json:"queue"`
	Data    interface{} `json:"data"`
	// contains filtered or unexported fields
}

func DecodeMessage added in v0.0.177 

func DecodeMessage(data []byte) (Message, error)

* * DecodeMessage * @param []byte * @return Message * @return error *

func NewMessage added in v0.0.177 

func NewMessage(from et.Json, message interface{}, tp m.TpMessage) Message

* * NewMessage * @param et.Json * @param interface{} * @param m.TpMessage * @return Message *

func (Message) Encode added in v0.0.177 

func (e Message) Encode() ([]byte, error)

* * Encode * @return []byte * @return error *

func (Message) Json added in v0.0.177 

func (e Message) Json() (et.Json, error)

* * Json * @return et.Json * @return error *

func (Message) ToString added in v0.0.177 

func (e Message) ToString() string

* * ToString * @return string *

func (Message) Type added in v0.0.177 

func (e Message) Type() m.TpMessage

* * Type * @return m.TpMessage *

type MessageBroadcast added in v0.0.177 

type MessageBroadcast struct {
	Kind    TpBroadcast `json:"kind"`
	To      string      `json:"channel"`
	Msg     Message     `json:"msg"`
	Ignored []string    `json:"ignored"`
	From    et.Json     `json:"from"`
}

* * MessageBroadcast is a struct to manage the message to broadcast *

func (MessageBroadcast) Encode added in v0.0.177 

func (m MessageBroadcast) Encode() ([]byte, error)

* * Encode return the message as byte array * @return []byte * @return error *

type RedisAdapter added in v0.0.177 

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

func NewRedisAdapter added in v0.0.177 

func NewRedisAdapter(params *RedisAdapterParams) (*RedisAdapter, error)

* * NewRedisAdapter return a new RedisAdapter * @param params *RedisAdapterParams * @return *RedisAdapter * @return error *

func (*RedisAdapter) Broadcast added in v0.0.177 

func (a *RedisAdapter) Broadcast(to string, msg Message, ignored []string, from et.Json) error

* * Broadcast a message to all clients in the cluster hub * @param to string * @param msg Message * @param ignored []string * @param from et.Json * @return error *

func (*RedisAdapter) Close added in v0.0.177 

func (a *RedisAdapter) Close() error

* * Close the RedisAdapter * @return error *

func (*RedisAdapter) Command added in v0.0.177 

func (a *RedisAdapter) Command(command string, params et.Json) error

* * Command send a command to all clients in the cluster hub * @param command string * @param params et.Json * @return error *

func (*RedisAdapter) Direct added in v0.0.177 

func (a *RedisAdapter) Direct(to string, msg Message) error

* * Direct send a message to a specific client in the cluster hub * @param to string * @param msg Message * @return error *

type RedisAdapterParams added in v0.0.177 

type RedisAdapterParams struct {
	Addr     string
	Password string
	DB       int
}

* * RedisAdapter is a struct to manage the Redis connection * to broadcast messages to all clients in the cluster hub *

type TpBroadcast added in v0.0.177 

type TpBroadcast int
const (
	TpAll TpBroadcast = iota
	TpDirect
)

type WsMessage 

type WsMessage struct {
	Type    string      `json:"type"`
	Payload interface{} `json:"payload"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.