sse

Documentation

Index

• func DemoHanderFunc(w http.ResponseWriter, r *http.Request)
• func NewHandler(h Streamer) http.HandlerFunc
• func SSE(w http.ResponseWriter, r *http.Request, h Streamer)
• func Shutdown(w http.ResponseWriter, f http.Flusher) error
• type Event
  • func NewEvent(name string, data any) Event
  • func NewMessage(data any) Event
  • func (e Event) Bytes() []byte
  • func (e Event) RawBytes() []byte
  • func (e Event) Send(w io.Writer, f http.Flusher) error
  • func (e Event) SendRaw(w io.Writer, f http.Flusher) error
• type MsgHandle
• type Streamer

Functions

func DemoHanderFunc

func DemoHanderFunc(w http.ResponseWriter, r *http.Request)

DemoHanderFunc time tick SSE

func NewHandler

func NewHandler(h Streamer) http.HandlerFunc

NewHandler returns a HandlerFunc that writes/loop the event to the ResponseWriter.

func SSE

func SSE(w http.ResponseWriter, r *http.Request, h Streamer)

SSE proxy to Streamer

func Shutdown

func Shutdown(w http.ResponseWriter, f http.Flusher) error

Shutdown send shutdown event to client

Types

type Event

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

Event a single event in SSE stream using json marshal encoding

func NewEvent

func NewEvent(name string, data any) Event

NewEvent creates a new SSE event.

func NewMessage

func NewMessage(data any) Event

NewMessage is a special Event using a single/default message in an SSE stream.

func (Event) Bytes

func (e Event) Bytes() []byte

Bytes marshal the event as a byte slice. Escape '\n' to '\r\n'

func (Event) RawBytes

func (e Event) RawBytes() []byte

RawBytes set marshal the event as a byte slice. Escape '\n' to '\r\n'

func (Event) Send

func (e Event) Send(w io.Writer, f http.Flusher) error

Send syntax sugar

func (Event) SendRaw

func (e Event) SendRaw(w io.Writer, f http.Flusher) error

SendRaw syntax sugar

type MsgHandle

type MsgHandle func(http.ResponseWriter, http.Flusher, any) error

MsgHandle handle a signal message

type Streamer

type Streamer interface {
	Send(context.Context, http.ResponseWriter, http.Flusher)
}

Streamer write endless events to ResponseWriter.