client

package

v0.0.0-...-1949828 Latest Latest Go to latest Published: Dec 2, 2018 License: MIT Imports: 5 Imported by: 2

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

Package client implements a server-sent event API client.

This section is empty.

View Source

var ErrInvalidSubscribeArgs = errors.New("must provides at leat a channel or a callback func in order to subscribe")

ErrInvalidSubscribeArgs is returned when a client tries to subscribe without a channel or a callback

This section is empty.

type Event struct {
	Event string // Type of the event (i.e. "hearbeat", or you custom event type)
	Data  []byte // Data field
}

Event holds the event fields

type SSEClient struct {
	Username, Password string
	// contains filtered or unexported fields
}

SSEClient holds the client state

func New(url string) *SSEClient

New initialize a new client

func (c *SSEClient) Subscribe(events chan<- *Event, callback func(*Event) error, filterEvents ...string) error

Subscribe connects to the server-sent event endpoint.