Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zyxar/socketio
socket.io/engine.io implementation in Go
https://github.com/zyxar/socketio
engine-io engine-io-server engineio go-socket-io go-socketio socket-io socket-io-server socketio
Last synced: about 5 hours ago
JSON representation
socket.io/engine.io implementation in Go
- Host: GitHub
- URL: https://github.com/zyxar/socketio
- Owner: zyxar
- License: bsd-3-clause
- Created: 2018-07-02T13:36:59.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-25T15:10:42.000Z (over 4 years ago)
- Last Synced: 2024-11-15T04:10:08.269Z (about 2 months ago)
- Topics: engine-io, engine-io-server, engineio, go-socket-io, go-socketio, socket-io, socket-io-server, socketio
- Language: Go
- Homepage:
- Size: 179 KB
- Stars: 19
- Watchers: 9
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# socketio
[socket.io](https://socket.io/)/[engine.io](https://github.com/socketio/engine.io) implementation in Go
[](https://godoc.org/github.com/zyxar/socketio)
[](https://goreportcard.com/report/github.com/zyxar/socketio)
[](https://github.com/zyxar/socketio/blob/master/LICENSE)
[](https://travis-ci.org/zyxar/socketio)
## Install
```shell
go get -v -u github.com/zyxar/socketio
```
## Features
- compatible with official nodejs implementation (w/o room);
- `socket.io` server;
- `socket.io` client (`websocket` only);
- `engine.io` server;
- `engine.io` client (`websocket` only);
- binary data;
- namespace support;
- [socket.io-msgpack-parser](https://github.com/darrachequesne/socket.io-msgpack-parser) support;
## Example
Server:
```go
package main
import (
"log"
"net/http"
"time"
"github.com/zyxar/socketio"
)
func main() {
server, _ := socketio.NewServer(time.Second*25, time.Second*5, socketio.DefaultParser)
server.Namespace("/").
OnConnect(func(so socketio.Socket) {
log.Println("connected:", so.RemoteAddr(), so.Sid(), so.Namespace())
}).
OnDisconnect(func(so socketio.Socket) {
log.Printf("%v %v %q disconnected", so.Sid(), so.RemoteAddr(), so.Namespace())
}).
OnError(func(so socketio.Socket, err ...interface{}) {
log.Println("socket", so.Sid(), so.RemoteAddr(), so.Namespace(), "error:", err)
}).
OnEvent("message", func(so socketio.Socket, data string) {
log.Println(data)
})
http.ListenAndServe(":8081", server)
}
```
Client:
```js
const io = require('socket.io-client');
const socket = io('http://localhost:8081');
var id;
socket.on('connect', function() {
console.log('connected');
if (id === undefined) {
id = setInterval(function() {
socket.emit('message', 'hello there!')
}, 2000);
}
});
socket.on('event', console.log);
socket.on('disconnect', function() {
console.log('disconnected');
if (id) {
clearInterval(id);
id = undefined;
}
});
```
### With Acknowledgements
- Server -> Client
Server:
```go
so.Emit("ack", "foo", func(msg string) {
log.Println(msg)
})
```
Client:
```js
socket.on('ack', function(name, fn) {
console.log(name);
fn('bar');
})
```
- Client -> Server
Server:
```go
server.Namespace("/").OnEvent("foobar", func(data string) (string, string) {
log.Println("foobar:", data)
return "foo", "bar"
})
```
Client:
```js
socket.emit('foobar', '-wow-', function (foo, bar) {
console.log('foobar:', foo, bar);
});
```
### With Binary Data
Server:
```go
server.Namespace("/").
OnEvent("binary", func(data interface{}, b *socketio.Bytes) {
log.Println(data)
bb, _ := b.MarshalBinary()
log.Printf("%x", bb)
}).
OnConnect(func(so socketio.Socket) {
go func() {
for {
select {
case <-time.After(time.Second * 2):
if err := so.Emit("event", "check it out!", time.Now()); err != nil {
log.Println(err)
return
}
}
}
}()
})
```
Client:
```js
var ab = new ArrayBuffer(4);
var a = new Uint8Array(ab);
a.set([1,2,3,4]);
id = setInterval(function() {
socket.emit('binary', 'buf:', ab);
}, 2000);
socket.on('event', console.log);
```
#### Binary Helper for `protobuf`
```go
import (
"github.com/golang/protobuf/proto"
)
type ProtoMessage struct {
proto.Message
}
func (p ProtoMessage) MarshalBinary() ([]byte, error) {
return proto.Marshal(p.Message)
}
func (p *ProtoMessage) UnmarshalBinary(b []byte) error {
return proto.Unmarshal(b, p.Message)
}
```
#### Binary Helper for `MessagePack`
```go
import (
"github.com/tinylib/msgp/msgp"
)
type MessagePack struct {
Message interface {
msgp.MarshalSizer
msgp.Unmarshaler
}
}
func (m MessagePack) MarshalBinary() ([]byte, error) {
return m.Message.MarshalMsg(nil)
}
func (m *MessagePack) UnmarshalBinary(b []byte) error {
_, err := m.Message.UnmarshalMsg(b)
return err
}
```
### Customized Namespace
Server:
```go
server.Namespace("/ditto").OnEvent("disguise", func(msg interface{}, b socketio.Bytes) {
bb, _ := b.MarshalBinary()
log.Printf("%v: %x", msg, bb)
})
```
Client:
```js
let ditto = io('http://localhost:8081/ditto');
ditto.emit('disguise', 'pidgey', new ArrayBuffer(8));
```
## Parser
The `encoder` and `decoder` provided by `socketio.DefaultParser` is compatible with [`socket.io-parser`](https://github.com/socketio/socket.io-parser/), complying with revision 4 of [socket.io-protocol](https://github.com/socketio/socket.io-protocol).
An `Event` or `Ack` Packet with any data satisfying `socketio.Binary` interface (e.g. `socketio.Bytes`) would be encoded as `BinaryEvent` or `BinaryAck` Packet respectively.
`socketio.MsgpackParser`, compatible with [socket.io-msgpack-parser](https://github.com/darrachequesne/socket.io-msgpack-parser), is an alternative custom parser.
## nginx as Reverse Proxy (or TLS Terminator)
```
upstream socketio {
ip_hash;
server localhost:8080;
}
server {
# ...
location /socket.io/ {
if ($request_method = OPTIONS) {
add_header Content-Length 0;
add_header Content-Type text/plain;
add_header Access-Control-Allow-Origin "$http_origin" always;
add_header Access-Control-Allow-Credentials 'true' always;
add_header Access-Control-Allow-Methods "POST,GET,OPTIONS";
add_header Access-Control-Allow-Headers "content-type";
return 204;
}
proxy_pass http://socketio;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header Host $host;
add_header Access-Control-Allow-Origin "$http_origin" always;
add_header Access-Control-Allow-Credentials 'true' always;
}
}
```