README
¶
GoSocketIO
GoSocketIO is a Socket.IO client and server library for Go, compatible with Socket.IO v3 and v4. This package allows you to build real-time, bidirectional communication applications with ease.
This library is based off the GoLang SocketIO Framework
This library was built with previous contributions by:
Features
- Socket.IO v3 and v4 Compatible: Fully compatible with the latest versions of Socket.IO.
- Extra Headers Support: Customize HTTP headers for WebSocket connections.
- Event-based Architecture: Simplified event handling for connection, disconnection, and custom events.
- Room Support: Easily broadcast messages to specific groups of clients.
- Ping/Pong Mechanism: Built-in heartbeat mechanism to keep connections alive.
Installation
To install GoSocketIO, use go get:
go get github.com/TymekV/gosf-socketio
Usage
Server Example
Here’s a simple WebSocket server using GoSocketIO:
package main
import (
"fmt"
"log"
"net/http"
"github.com/TymekV/gosf-socketio"
"github.com/TymekV/gosf-socketio/transport"
)
func main() {
server := gosocketio.NewServer(transport.GetDefaultWebsocketTransport())
server.On(gosocketio.OnConnection, func(c *gosocketio.Channel) {
fmt.Println("New client connected:", c.Id())
c.Join("chat")
})
server.On(gosocketio.OnDisconnection, func(c *gosocketio.Channel) {
fmt.Println("Client disconnected:", c.Id())
})
server.On("chat message", func(c *gosocketio.Channel, message string) {
fmt.Printf("Received message from %s: %s\n", c.Id(), message)
server.BroadcastTo("chat", "chat message", message)
})
http.Handle("/socket.io/", server)
addr := "localhost:8080"
fmt.Printf("Serving at %s...\n", addr)
log.Fatal(http.ListenAndServe(addr, nil))
}
For more details, see the Server Example
Go Client Example
Here’s how you can create a Go client that connects to the server:
package main
import (
"fmt"
"log"
"time"
"github.com/TymekV/gosf-socketio"
"github.com/TymekV/gosf-socketio/transport"
)
func main() {
wsTransport := transport.GetDefaultWebsocketTransport()
options := &gosocketio.Options{
ExtraHeaders: []gosocketio.ExtraHeaders{
{Key: "Content-Type", Value: "application/json"},
{Key: "Authorization", Value: "Bearer YOUR_ACCESS_TOKEN"},
},
PingTimeout: 60 * time.Second,
PingInterval: 30 * time.Second,
}
client, err := gosocketio.Dial("ws://localhost:8080/socket.io/?EIO=3&transport=websocket", wsTransport, options)
if err != nil {
log.Fatalf("Failed to connect to server: %v", err)
}
defer client.Close()
client.On(gosocketio.OnConnection, func(c *gosocketio.Channel) {
fmt.Println("Connected to server")
})
client.On(gosocketio.OnDisconnection, func(c *gosocketio.Channel) {
fmt.Println("Disconnected from server")
})
client.On("chat message", func(c *gosocketio.Channel, message string) {
fmt.Printf("Received message: %s\n", message)
})
err = client.Emit("chat message", "Hello, Server!")
if err != nil {
log.Printf("Failed to send message: %v", err)
}
select {}
}
For more details, see the Go Client Example
JavaScript Client Example
Here’s a simple JavaScript client using Socket.IO:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Socket.IO Client</title>
</head>
<body>
<h1>WebSocket Chat</h1>
<div id="chat">
<ul id="messages"></ul>
</div>
<form id="form" action="">
<input id="input" autocomplete="off" /><button>Send</button>
</form>
<script src="https://cdn.socket.io/4.0.1/socket.io.min.js"></script>
<script>
var socket = io('http://localhost:8080');
socket.on('connect', function() {
console.log('Connected to server');
});
socket.on('disconnect', function() {
console.log('Disconnected from server');
});
socket.on('chat message', function(msg) {
var item = document.createElement('li');
item.textContent = msg;
document.getElementById('messages').appendChild(item);
});
document.getElementById('form').addEventListener('submit', function(e) {
e.preventDefault();
var input = document.getElementById('input');
socket.emit('chat message', input.value);
input.value = '';
});
</script>
</body>
</html>
For more details, see the JavaScript Client Example
Contributing
We welcome contributions! Please check out the Contributing Guide for more details.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Documentation
¶
Index ¶
- Constants
- Variables
- func GetUrl(host string, port int, secure bool) string
- type Channel
- func (c *Channel) Ack(method string, args interface{}, timeout time.Duration) (string, error)
- func (c *Channel) Amount(room string) int
- func (c *Channel) BroadcastTo(room, method string, args interface{})
- func (c *Channel) Close()
- func (c *Channel) Emit(method string, args interface{}) error
- func (c *Channel) Id() string
- func (c *Channel) Ip() string
- func (c *Channel) IsAlive() bool
- func (c *Channel) Join(room string) error
- func (c *Channel) Leave(room string) error
- func (c *Channel) List(room string) []*Channel
- func (c *Channel) Request() *http.Request
- func (c *Channel) RequestHeader() http.Header
- type Client
- type Header
- type Server
- func (s *Server) AddHeader(name string, value string)
- func (s *Server) Amount(room string) int
- func (s *Server) AmountOfRooms() int64
- func (s *Server) AmountOfSids() int64
- func (s *Server) BroadcastTo(room, method string, args interface{})
- func (s *Server) BroadcastToAll(method string, args interface{})
- func (s *Server) EnableCORS(domain string)
- func (s *Server) GetChannel(sid string) (*Channel, error)
- func (s *Server) List(room string) []*Channel
- func (m *Server) On(method string, f interface{}) error
- func (s *Server) SendOpenSequence(c *Channel)
- func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
- func (s *Server) SetupEventLoop(conn transport.Connection, remoteAddr string, r *http.Request)
- func (s *Server) UpdateTransport(tr transport.Transport)
Constants ¶
View Source
const ( OnConnection = "connection" OnDisconnection = "disconnection" OnError = "error" )
View Source
const (
HeaderForward = "X-Forwarded-For"
)
Variables ¶
View Source
var ( ErrorCallerNotFunc = errors.New("f is not function") ErrorCallerMaxOneValue = errors.New("f should return not more than one value") )
View Source
var ( ErrorSendTimeout = errors.New("Timeout") ErrorSocketOverflood = errors.New("Socket overflood") )
View Source
var ( ErrorServerNotSet = errors.New("Server not set") ErrorConnectionNotFound = errors.New("Connection not found") )
View Source
var (
ErrorWaiterNotFound = errors.New("Waiter not found")
)
View Source
var ErrorWrongHeader = errors.New("Wrong header")
Functions ¶
Types ¶
type Channel ¶
type Channel struct {
// contains filtered or unexported fields
}
func (*Channel) BroadcastTo ¶
func (*Channel) RequestHeader ¶
Get request header of this connection
type Client ¶
type Client struct {
Channel
// contains filtered or unexported fields
}
type Header ¶
type Header struct {
Sid string `json:"sid"`
Upgrades []string `json:"upgrades"`
PingInterval int `json:"pingInterval"`
PingTimeout int `json:"pingTimeout"`
}
Header represents engine.io header to send or receive
type Server ¶
socket.io server instance
func (*Server) AmountOfRooms ¶
Get amount of rooms with at least one channel(or sid) joined
func (*Server) AmountOfSids ¶
Get amount of current connected sids
func (*Server) BroadcastTo ¶
Broadcast message to all room channels
func (*Server) BroadcastToAll ¶
Broadcast to all clients
func (*Server) GetChannel ¶
Get channel by its sid
func (*Server) SendOpenSequence ¶
func (*Server) ServeHTTP ¶
func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
implements ServeHTTP function from http.Handler
func (*Server) SetupEventLoop ¶
Setup event loop for given connection
func (*Server) UpdateTransport ¶
Replaces the pre-configured transport
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.