goose

README

Goose - Go Server-Sent Events

Goose implements Server-Sent Events in Go.

See this example.

Licence

Copyright ©‎ 2014, Ian Kent (http://www.iankent.eu).

Released under MIT license, see LICENSE for details.

Documentation

Index

• Variables
• type EventReceiver
• type EventStream
  • func NewEventStream() *EventStream
  • func (es *EventStream) AddReceiver(w http.ResponseWriter) (*EventReceiver, error)
  • func (es *EventStream) Notify(event string, bytes []byte)

Variables

var (
	// ErrUnableToHijackRequest is returned by AddReceiver if the type
	// conversion to http.Hijacker is unsuccessful
	ErrUnableToHijackRequest = errors.New("Unable to hijack request")
)

Types

type EventReceiver

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

EventReceiver represents a hijacked HTTP connection

type EventStream

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

EventStream represents a collection of receivers

func NewEventStream

func NewEventStream() *EventStream

NewEventStream creates a new event stream

func (*EventStream) AddReceiver

func (es *EventStream) AddReceiver(w http.ResponseWriter) (*EventReceiver, error)

AddReceiver hijacks a http.ResponseWriter and attaches it to the event stream

func (*EventStream) Notify

func (es *EventStream) Notify(event string, bytes []byte)

Notify sends the event to all event stream receivers