sse

Documentation

Index

• type Event
• type SSE
  • func NewSSE(r io.Reader) *SSE
  • func (sse *SSE) AutoFlush(af bool)
  • func (sse *SSE) KeepAlive(w io.Writer) error
  • func (sse *SSE) Read() (Event, bool)
  • func (sse *SSE) Write(w io.Writer, event Event) error

Types

type Event

type Event map[string]string

type SSE

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

func NewSSE

func NewSSE(r io.Reader) *SSE

func (*SSE) AutoFlush

func (sse *SSE) AutoFlush(af bool)

AutoFlush allows changing the auto-flush behavior. Default is to auto-flush after each event.

func (*SSE) KeepAlive

func (sse *SSE) KeepAlive(w io.Writer) error

func (*SSE) Read

func (sse *SSE) Read() (Event, bool)

Read will return an event, which may be empty if nothing but a keep-alive was received thus far. The boolean flag indicates EOF. If true, no more reads should be performed on this SSE.

func (*SSE) Write

func (sse *SSE) Write(w io.Writer, event Event) error