dashing

package module

v0.0.0-...-8a21f24 Latest Latest Go to latest Published: Nov 17, 2014 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

A Go port of shopify/dashing, built upon Martini.

To generate a dashboard using this library, please use the Yeoman dashing-go generator.

For a live demo, here's the default sample dashboard.

All endpoints have been ported over! Full functionality is available.
For an example of how to write jobs in dashing-go, please refer to the demo dashboard source.

Much of the code is referenced from golang-sse-todo by @rwynn.

This section is empty.

This section is empty.

func NewServer(staticDirectory string) *dashingServer

func Register(j Job)

Register a job to be kicked off upon starting the server.

func Start()

Start all jobs and listen to requests.

func StartWithStaticDirectory(staticDirectory string)

type Broker struct {
	// contains filtered or unexported fields
}

A Broker broadcasts events to multiple clients.

func NewBroker() *Broker

NewBroker creates a Broker instance.

func (b *Broker) Start()

Start managing client connections and event broadcasts.

type Event struct {
	ID     string
	Body   map[string]interface{}
	Target string
}

An Event contains the widget ID, a body of data, and an optional target (only "dashboard" for now).

type Job interface {
	Work(send chan *Event)
}

A Job does periodic work and sends events to a channel.