events

Documentation

Overview

Package events based on https://thoughtbot.com/blog/writing-a-server-sent-events-server-in-go

Index

• Constants
• type Broker
  • func GetBroker() Broker
• type Event
• type KeepAlive
  • func (e *KeepAlive) Data(evt Event) string
  • func (e *KeepAlive) Name(evt Event) string
• type RefreshResource
  • func (rr *RefreshResource) Data(evt Event) string
  • func (e *RefreshResource) Name(evt Event) string
  • func (rr *RefreshResource) With(resource string, ids ...string) *RefreshResource
• type ScanStatus
  • func (e *ScanStatus) Data(evt Event) string
  • func (e *ScanStatus) Name(evt Event) string
• type ServerStart
  • func (e *ServerStart) Data(evt Event) string
  • func (e *ServerStart) Name(evt Event) string

Constants

const Any = "*"

Types

type Broker

type Broker interface {
	http.Handler
	SendMessage(ctx context.Context, event Event)
}

func GetBroker

func GetBroker() Broker

type Event

type Event interface {
	Name(Event) string
	Data(Event) string
}

type KeepAlive

type KeepAlive struct {
	TS int64 `json:"ts"`
	// contains filtered or unexported fields
}

func (*KeepAlive) Data

func (e *KeepAlive) Data(evt Event) string

func (*KeepAlive) Name

func (e *KeepAlive) Name(evt Event) string

type RefreshResource

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

func (*RefreshResource) Data

func (rr *RefreshResource) Data(evt Event) string

func (*RefreshResource) Name

func (e *RefreshResource) Name(evt Event) string

func (*RefreshResource) With

func (rr *RefreshResource) With(resource string, ids ...string) *RefreshResource

type ScanStatus

type ScanStatus struct {
	Scanning    bool  `json:"scanning"`
	Count       int64 `json:"count"`
	FolderCount int64 `json:"folderCount"`
	// contains filtered or unexported fields
}

func (*ScanStatus) Data

func (e *ScanStatus) Data(evt Event) string

func (*ScanStatus) Name

func (e *ScanStatus) Name(evt Event) string

type ServerStart

type ServerStart struct {
	StartTime time.Time `json:"startTime"`
	Version   string    `json:"version"`
	// contains filtered or unexported fields
}

func (*ServerStart) Data

func (e *ServerStart) Data(evt Event) string

func (*ServerStart) Name

func (e *ServerStart) Name(evt Event) string