ws

package

v1.0.19 Latest Latest Go to latest Published: Feb 27, 2026 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cgalvisleon/et

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func SendError(socket *websocket.Conn, err error) error
func Upgrader(w http.ResponseWriter, r *http.Request) (*websocket.Conn, error)
type Channel
type Client
type Hub
- func New() *Hub
type Message
- func DecodeMessage(data []byte) (Message, error)
- func NewMessage(from et.Json, to []string) Message
type Outbound
type Status
type TypeChannel

Constants ¶

View Source

const (
	TextMessage   int = 1
	BinaryMessage int = 2
	CloseMessage  int = 8
	PingMessage   int = 9
	PongMessage   int = 10
)

Variables ¶

This section is empty.

Functions ¶

func SendError ¶ added in v1.0.14

func SendError(socket *websocket.Conn, err error) error

* * SendError * @params socket *websocket.Conn, err error * @return error *

func Upgrader ¶ added in v1.0.12

func Upgrader(w http.ResponseWriter, r *http.Request) (*websocket.Conn, error)

* * Upgrader * @params w http.ResponseWriter, r *http.Request * @return *websocket.Conn, error *

Types ¶

type Channel ¶

type Channel struct {
	Name        string      `json:"name"`
	Type        TypeChannel `json:"type"`
	Subscribers []string    `json:"subscribers"`
	Turn        int         `json:"turn"`
}

type Client ¶

type Client struct {
	Created_at time.Time `json:"created_at"`
	Name       string    `json:"name"`
	Addr       string    `json:"addr"`
	Status     Status    `json:"status"`
	Channels   []string  `json:"channels"`
	// contains filtered or unexported fields
}

func (*Client) Send ¶ added in v1.0.15

func (s *Client) Send(tp int, bt []byte)

* * send * @param tp int, bt []byte *

func (*Client) SendError ¶ added in v1.0.15

func (s *Client) SendError(err error)

* * Error * @param err error *

func (*Client) SendHola ¶ added in v1.0.15

func (s *Client) SendHola()

* * SendHola *

func (*Client) SendMessage ¶

func (s *Client) SendMessage(message interface{})

* * SendMessage * @param message interface{} *

func (*Client) ToJson ¶ added in v1.0.15

func (s *Client) ToJson() et.Json

* * ToJson * @return et.Json *

type Hub ¶

type Hub struct {
	Subscribers map[string]*Client  `json:"subscribers"`
	Channels    map[string]*Channel `json:"channels"`
	// contains filtered or unexported fields
}

func New ¶ added in v1.0.14

func New() *Hub

* * New * @return *Hub *

func (*Hub) Close ¶

func (s *Hub) Close()

* * Close *

func (*Hub) Connect ¶ added in v1.0.12

func (s *Hub) Connect(socket *websocket.Conn, ctx context.Context) (*Client, error)

* * Connect * @param socket *websocket.Conn, context.Context * @return *Client, error *

func (*Hub) OnChannel ¶ added in v1.0.12

func (s *Hub) OnChannel(fn func(Channel))

* * OnChannel * @param fn func(Channel) *

func (*Hub) OnConnection ¶ added in v1.0.12

func (s *Hub) OnConnection(fn func(*Client))

* * OnConnection * @param fn func(*Client) *

func (*Hub) OnDisconnection ¶ added in v1.0.12

func (s *Hub) OnDisconnection(fn func(*Client))

* * OnDisconnection * @param fn func(*Client) *

func (*Hub) OnListener ¶ added in v1.0.15

func (s *Hub) OnListener(fn func(*Client, []byte))

* * OnListener * @param fn func(*Client, []byte) *

func (*Hub) OnPublish ¶ added in v1.0.12

func (s *Hub) OnPublish(fn func(ch Channel, ms Message))

* * OnPublish * @param fn func(ch Channel, ms Message)

func (*Hub) OnRemove ¶ added in v1.0.12

func (s *Hub) OnRemove(fn func(string))

* * OnRemove * @param fn func(string) *

func (*Hub) OnSend ¶ added in v1.0.12

func (s *Hub) OnSend(fn func(to string, ms Message))

* * OnSend * @param fn func(to string, ms Message)

func (*Hub) Publish ¶

func (s *Hub) Publish(channel string, message Message) ([]string, error)

* * Publish * @param channel string, message Message *

func (*Hub) Queue ¶ added in v1.0.12

func (s *Hub) Queue(channel string) *Channel

* * Queue * @param channel string * @return *Channel *

func (*Hub) Remove ¶ added in v1.0.12

func (s *Hub) Remove(channel string) error

* * Remove * @param channel string * @return error *

func (*Hub) SendTo ¶ added in v1.0.12

func (s *Hub) SendTo(to []string, message Message) ([]string, error)

* * SendTo * @param to []string, message Message *

func (*Hub) SetDebug ¶ added in v1.0.12

func (s *Hub) SetDebug(debug bool)

* * SetDebug * @param debug bool *

func (*Hub) Stack ¶

func (s *Hub) Stack(channel string) *Channel

* * Stack * @param channel string * @return *Channel *

func (*Hub) Start ¶

func (s *Hub) Start()

* * Start *

func (s *Hub) Subscribe(channel string, subscribe string) error

* * Subscribe * @param cache string, subscribe string * @return error *

func (*Hub) Topic ¶ added in v1.0.12

func (s *Hub) Topic(channel string) *Channel

* * Topic * @param channel string * @return *Channel *

func (*Hub) Unsubscribe ¶

func (s *Hub) Unsubscribe(cache string, subscribe string) error

* * Unsubscribe * @param cache string, subscribe string * @return error *

type Message ¶

type Message struct {
	Created_at time.Time   `json:"created_at"`
	ID         string      `json:"id"`
	From       et.Json     `json:"from"`
	Channel    string      `json:"channel"`
	To         []string    `json:"to"`
	Ignored    []string    `json:"-"`
	Message    interface{} `json:"message"`
	Verified   bool        `json:"verified"`
}

func DecodeMessage ¶

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

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

func NewMessage ¶

func NewMessage(from et.Json, to []string) Message

* * NewMessage * @param from et.Json, to []string, data et.Json * @return *Message *

func (*Message) Bytes ¶ added in v1.0.12

func (s *Message) Bytes() ([]byte, error)

* * Bytes * @return ([]byte, error) *

func (*Message) ToJson ¶

func (s *Message) ToJson() et.Json