client

Documentation

Overview

Package client implements a server-sent event API client.

Index

• Variables
• type Event
• type SSEClient
  • func New(url string) *SSEClient
  • func (c *SSEClient) Subscribe(events chan<- *Event, callback func(*Event) error, filterEvents ...string) error

Variables

var ErrInvalidSubscribeArgs = errors.New("must provides at leat a channel or a callback func in order to subscribe")

ErrInvalidSubscribeArgs is returned when a client tries to subscribe without a channel or a callback

Types

type Event

type Event struct {
	Event string // Type of the event (i.e. "hearbeat", or you custom event type)
	Data  []byte // Data field
}

Event holds the event fields

type SSEClient

type SSEClient struct {
	Username, Password string
	// contains filtered or unexported fields
}

SSEClient holds the client state

func New

func New(url string) *SSEClient

New initialize a new client

func (*SSEClient) Subscribe

func (c *SSEClient) Subscribe(events chan<- *Event, callback func(*Event) error, filterEvents ...string) error

Subscribe connects to the server-sent event endpoint.