sphere

go-sphere

Go-Sphere is an open source realtime framework to scale websocket horizontally (across multiple hosts) via pub/sub synchronization. Sphere supports both real-time bidirectional event-based communication and group communication.

Usage

To create websocket server with gin webserver

package main

import (
  "github.com/samuelngs/go-sphere"
  "github.com/gin-gonic/gin"
)

func main() {
    // create websocket server
    s := sphere.Default()
    // create http server
    r := gin.Default()
    // attach websocket handler
    r.GET("/sync", func(c *gin.Context) {
      s.Handler(c.Writer, c.Request)
    })
    // listen and serve on 0.0.0.0:8080
    r.Run(":8080") 
}

Scale websocket horizontally via pub/sub (broker) synchronization

b := sphere.DefaultRedisBroker()
s := sphere.Default(b) // <= pass in redis broker when creates websocket server

Use custom pubsub broker/agent

package main

import "github.com/samuelngs/go-sphere"

type MessageBroker struct {
	*sphere.Broker
}

func (broker *MessageBroker) OnSubscribe(channel *sphere.Channel, done chan<- sphere.IError) { }

func (broker *MessageBroker) OnUnsubscribe(channel *sphere.Channel, done chan<- sphere.IError) { }

func (broker *MessageBroker) OnPublish(channel *sphere.Channel, data *sphere.Packet) error {
	return nil
}

func (broker *MessageBroker) OnMessage(channel *sphere.Channel, data *sphere.Packet) error {
	return nil
}

func main() {
  customBroker := &MessageBroker{ExtendBroker()}
  s := sphere.Default(customBroker)
}

Custom channel events

package main

import "github.com/samuelngs/go-sphere"

// SphereUserAccount Model
type SphereUserAccount struct{}

// Namespace represents the namespace of the model
func (m *SphereUserAccount) Namespace() string {
	return "user-account"
}

// Subscribe decides whether accept the connection into channel or not, return true => accept, false => reject
func (m *SphereUserAccount) Subscribe(room string, connection *sphere.Connection) (bool, sphere.IError) {
	return true, nil
}

// Disconnect defines the action when user disconnect from channel
func (m *SphereUserAccount) Disconnect(room string, connection *sphere.Connection) sphere.IError {
	return nil
}

// Receive defines the action when websocket server receive message from user in this channel
func (m *SphereUserAccount) Receive(event string, message string) (string, sphere.IError) {
	return "", nil
}

func main() {
  s := sphere.Default()
  s.Models(&SphereUserAccount{})
}

Client-side

The sphere-client library can be found at https://github.com/samuelngs/sphere-client

Documentation

go doc format documentation for this project can be viewed online without installing the package by using the GoDoc page at: https://godoc.org/github.com/samuelngs/go-sphere

Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help:

• Report bugs
• Fix bugs and submit pull requests
• Write, clarify, or fix documentation
• Suggest or add new features

License

This project is distributed under the MIT license found in the LICENSE file.

The MIT License (MIT)

Copyright (c) 2015 Samuel

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.