sse

README

sse

Server sent events publisher in Go

Documentation

Index

• type Event
  • func JSONEvent(kind string, data any) (Event, error)
  • func NewEvent(kind string, data []byte) Event
• type EventServer
  • func NewEventServer() *EventServer
  • func (e *EventServer) Broadcast(name string, event Event) error
  • func (e *EventServer) Create(name string)
  • func (e *EventServer) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Subscriber
  • func NewSubscriber() Subscriber
  • func (s Subscriber) Close()
  • func (s Subscriber) Push(event Event) error
  • func (s Subscriber) WriteEvents(w http.ResponseWriter) error
• type Topic
  • func NewTopic(backlog int) *Topic
  • func (t *Topic) Broadcast(event Event) error
  • func (t *Topic) Subscribe(sub Subscriber)
  • func (t *Topic) Unsubscribe(ctx context.Context, sub Subscriber)
• type Topics
  • func NewTopics() *Topics
  • func (t *Topics) Create(name string) *Topic

Types

type Event

type Event interface {
	Type() string
	Data() []byte
}

func JSONEvent

func JSONEvent(kind string, data any) (Event, error)

func NewEvent

func NewEvent(kind string, data []byte) Event

type EventServer

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

func NewEventServer

func NewEventServer() *EventServer

func (*EventServer) Broadcast

func (e *EventServer) Broadcast(name string, event Event) error

func (*EventServer) Create

func (e *EventServer) Create(name string)

func (*EventServer) ServeHTTP

func (e *EventServer) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Subscriber

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

func NewSubscriber

func NewSubscriber() Subscriber

func (Subscriber) Close

func (s Subscriber) Close()

func (Subscriber) Push

func (s Subscriber) Push(event Event) error

func (Subscriber) WriteEvents

func (s Subscriber) WriteEvents(w http.ResponseWriter) error

type Topic

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

func NewTopic

func NewTopic(backlog int) *Topic

func (*Topic) Broadcast

func (t *Topic) Broadcast(event Event) error

func (*Topic) Subscribe

func (t *Topic) Subscribe(sub Subscriber)

func (*Topic) Unsubscribe

func (t *Topic) Unsubscribe(ctx context.Context, sub Subscriber)

type Topics

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

func NewTopics

func NewTopics() *Topics

func (*Topics) Create

func (t *Topics) Create(name string) *Topic