sse

Documentation

Index

• Variables
• type BadResponseError
  • func (err BadResponseError) Error() string
• type Event
  • func (event Event) Encode() string
  • func (event Event) Write(destination io.Writer) error
• type EventSource
  • func Connect(client *http.Client, defaultRetryInterval time.Duration, ...) (*EventSource, error)
  • func NewEventSource(client *http.Client, defaultRetryInterval time.Duration, ...) *EventSource
  • func (source *EventSource) Close() error
  • func (source *EventSource) Next() (Event, error)
• type ReadCloser
  • func NewReadCloser(source io.ReadCloser) *ReadCloser
  • func (rc *ReadCloser) Close() error
  • func (rc *ReadCloser) Next() (Event, error)

Variables

var ErrSourceClosed = errors.New("source closed")

Types

type BadResponseError

type BadResponseError struct {
	Response *http.Response
}

func (BadResponseError) Error

func (err BadResponseError) Error() string

type Event

type Event struct {
	ID    string
	Name  string
	Data  []byte
	Retry time.Duration
}

func (Event) Encode

func (event Event) Encode() string

func (Event) Write

func (event Event) Write(destination io.Writer) error

type EventSource

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

EventSource behaves like the EventSource interface from the Server-Sent Events spec implemented in many browsers. See http://www.w3.org/TR/eventsource/#the-eventsource-interface for details.

To use, optionally call Connect(), and then call Next(). If Next() is called prior to Connect(), it will connect for you.

Next() is often called asynchronously in a loop so that the event source can be closed. Next() will block on reading from the server.

If Close() is called while reading an event, Next() will return early, and subsequent calls to Next() will return early. To read new events, Connect() must be called.

If an EOF is received, Next() returns io.EOF, and subsequent calls to Next() will return early. To read new events, Connect() must be called.

func Connect

func Connect(client *http.Client, defaultRetryInterval time.Duration, requestCreator func() *http.Request) (*EventSource, error)

func NewEventSource

func NewEventSource(client *http.Client, defaultRetryInterval time.Duration, requestCreator func() *http.Request) *EventSource

func (*EventSource) Close

func (source *EventSource) Close() error

func (*EventSource) Next

func (source *EventSource) Next() (Event, error)

type ReadCloser

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

func NewReadCloser

func NewReadCloser(source io.ReadCloser) *ReadCloser

func (*ReadCloser) Close

func (rc *ReadCloser) Close() error

func (*ReadCloser) Next

func (rc *ReadCloser) Next() (Event, error)