sseclient

README

sseclient

Client for Server sent events for Golang

Documentation

Overview

Package sseclient is the client of server side events

Index

• Variables
• type CancelFunc
  • func Notify(client *http.Client, req *http.Request, ch chan *Event) (CancelFunc, error)
• type Event

Examples

• Notify

Variables

var (
	ErrClientNil = errors.New("sse: client is nil")
	ErrReqNil    = errors.New("sse: req is nil")
	ErrChanNil   = errors.New("sse: channel is nil")
)

Errors

Types

type CancelFunc

type CancelFunc func()

CancelFunc is the function use for cancel notify

func Notify

func Notify(client *http.Client, req *http.Request, ch chan *Event) (CancelFunc, error)

Notify does a request and notify to given channel when receive event CancelFunc use to close response body and channel Do not manually close channel

Example

req, err := http.NewRequest(http.MethodGet, "https://dinosaur-facts.firebaseio.com/dinosaurs.json", nil)
if err != nil {
	log.Fatal(err)
}
client := &http.Client{}
eventChan := make(chan *Event)
cancel, err := Notify(client, req, eventChan)
if err != nil {
	log.Fatal(err)
}
go func() {
	// cancel after 10 seconds passed
	time.Sleep(10 * time.Second)
	cancel()
}()
for event := range eventChan {
	log.Printf("%s: %s", event.Type, string(event.Data))
}

type Event

type Event struct {
	Type string
	Data []byte
}

Event is the event sent from server