eventhub

README

eventhub

Provides a NewNonBlocking event source to Subscribe and Emit.

[!NOTE]

This repository should be imported as code.cloudfoundry.org/eventhub.

Contributing

See the Contributing.md for more information on how to contribute.

Working Group Charter

This repository is maintained by App Runtime Platform under Diego area.

[!IMPORTANT]

Content in this file is managed by the CI task sync-readme and is generated by CI following a convention.

Documentation

Index

• Variables
• type Event
• type Hub
  • func NewNonBlocking(consumerBufferSize int) Hub
• type Source

Variables

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")

Types

type Event

type Event interface{}

type Hub

type Hub interface {
	Subscribe() (Source, error)
	Emit(Event)
	Close() error
}

func NewNonBlocking

func NewNonBlocking(consumerBufferSize int) Hub

type Source

type Source interface {
	Next() (Event, error)
	Close() error
	// contains filtered or unexported methods
}