sse

Documentation

Overview

Package see helps you send Sever-Sent Event streams over HTTP.

Index

• Variables
• func SetHeaders(h http.Header)
• func Write(w io.Writer, m Message) (int, error)
• type Message
  • func (m *Message) WriteTo(w io.Writer) (int64, error)

Variables

var (
	ErrBadFormat = errors.New("can't have newline")
)

Functions

func SetHeaders

func SetHeaders(h http.Header)

SetHeaders adds the required SSE headers to the output Headers.

func Write

func Write(w io.Writer, m Message) (int, error)

Write writes the given SSE message to the io.Writer.

Types

type Message

type Message struct {
	Comment string
	Event   string
	ID      string
	Retry   time.Duration
	Data    interface{}
	JSON    bool
}

Message represents a message that can be sent over Server-Sent Events.

func (*Message) WriteTo

func (m *Message) WriteTo(w io.Writer) (int64, error)

WriteTo nominally implements io.WriteTo.