events

Documentation

Index

• Constants
• Variables
• func NewCloseError(err error) error
• func NewEventFromModelEvent(eventID int, event models.Event) (sse.Event, error)
• func NewInvalidPayloadError(payloadType string, protoErr error) error
• func NewRawEventSourceError(rawError error) error
• type EventSource
  • func NewEventSource(raw RawEventSource) EventSource
• type Hub
  • func NewHub(logger lager.Logger) Hub
• type RawEventSource

Constants

const MAX_PENDING_SUBSCRIBER_EVENTS = 1024

Variables

var (
	ErrUnrecognizedEventType = errors.New("unrecognized event type")
	ErrSourceClosed          = errors.New("source closed")
	ErrNoData                = errors.New("event with no data")
)

var ErrHubAlreadyClosed = errors.New("hub already closed")

var ErrReadFromClosedSource = errors.New("read from closed source")

var ErrSendToClosedSource = errors.New("send to closed source")

var ErrSlowConsumer = errors.New("slow consumer")

var ErrSourceAlreadyClosed = errors.New("source already closed")

var ErrSubscribedToClosedHub = errors.New("subscribed to closed hub")

Functions

func NewCloseError

func NewCloseError(err error) error

func NewEventFromModelEvent

func NewEventFromModelEvent(eventID int, event models.Event) (sse.Event, error)

func NewInvalidPayloadError

func NewInvalidPayloadError(payloadType string, protoErr error) error

func NewRawEventSourceError

func NewRawEventSourceError(rawError error) error

Types

type EventSource

type EventSource interface {
	// Next reads the next event from the source. If the connection is lost, it
	// automatically reconnects.
	//
	// If the end of the stream is reached cleanly (which should actually never
	// happen), io.EOF is returned. If called after or during Close,
	// ErrSourceClosed is returned.
	Next() (models.Event, error)

	// Close releases the underlying response, interrupts any in-flight Next, and
	// prevents further calls to Next.
	Close() error
}

EventSource provides sequential access to a stream of events.

func NewEventSource

func NewEventSource(raw RawEventSource) EventSource

type Hub

type Hub interface {
	Subscribe() (EventSource, error)
	Emit(models.Event)
	Close() error

	RegisterCallback(func(count int))
	UnregisterCallback()
}

func NewHub

func NewHub(logger lager.Logger) Hub

type RawEventSource

type RawEventSource interface {
	Next() (sse.Event, error)
	Close() error
}