https://github.com/synw/centcom
A Go API for Centrifugo
https://github.com/synw/centcom
centrifugo
Last synced: 3 months ago
JSON representation
A Go API for Centrifugo
- Host: GitHub
- URL: https://github.com/synw/centcom
- Owner: synw
- Created: 2017-03-07T15:36:15.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-15T12:28:37.000Z (over 7 years ago)
- Last Synced: 2025-04-19T10:09:23.375Z (6 months ago)
- Topics: centrifugo
- Language: Go
- Size: 15.6 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Centcom
Go API for the Centrifugo websockets server.
## Quick example
Initialize connection:
```go
cli := centcom.New("locahost:8001", "secret_key")
cli, err := centcom.Connect(cli)
if err != nil {
fmt.Println(err)
return
}
defer centcom.Disconnect(cli)
```
Subscribe and listen to a channel:
```go
err = cli.Subscribe("public:data")
if err != nil {
fmt.Println(err)
}
// listen
go func() {
fmt.Println("Listening ...")
for msg := range(cli.Channels) {
if msg.Channel == "public:data" {
fmt.Println("PAYLOAD", msg.Payload, msg.UID)
}
}
}()
```
Publish into a channel using client drivers (the namespace has to be set `public=true` in Centrifugo's config):
```go
payload := []int{1}
err = cli.Publish("public:data", payload)
if err != nil {
fmt.Println(err)
}
```
Publish to a channel using the server drivers (no restrictions):
```go
d := []int{1, 2}
dataBytes, err := json.Marshal(d)
if err != nil {
fmt.Println(err)
}
ok, err := cli.Http.Publish("$somechannel", dataBytes)
if err != nil {
fmt.Println(err, ok)
}
```
Check the [examples](https://github.com/synw/centcom/tree/master/examples)
## API
#### Centcom methods:
`centcom.New(host string, port int, key string)`: initialize client
`centcom.Connect(cli *Cli)`: connect the client drivers
`centcom.Disconnect(cli *Cli)`: disconnect the client drivers
#### Cli methods:
`cli.CheckHttp()`: verify the server side drivers connection
`cli.Subscribe(channel string)`: subscribe to a channel
`cli.Unsubscribe(channel string)`: unsubscribe to a channel
`cli.Publish(channel string, payload interface{})`: publish into a channel using client drivers
`cli.Http` is a *gocent.Client with all its method: check the [Gocent API](https://godoc.org/github.com/centrifugal/gocent)
#### Data structures:
```go
type Cli struct {
Addr string
Key string
Http *gocent.Client
Conn centrifuge.Centrifuge
SubEvents *centrifuge.SubEventHandler
Subs map[string]centrifuge.Sub
Channels chan *Msg
HttpOk bool
IsConnected bool
}
type Msg struct {
UID string
Channel string
Payload interface{}
}
```