events

Documentation

Overview

Package events provides event subscription and polling functionality.

Index

• Constants
• Variables
• type BufferedSubscription
  • func NewBufferedSubscription(s *Subscription, size int) *BufferedSubscription
  • func (s *BufferedSubscription) Since(id int, into []Event) []Event
• type Event
• type EventType
  • func (t EventType) MarshalText() ([]byte, error)
  • func (t EventType) String() string
• type Logger
  • func NewLogger() *Logger
  • func (l *Logger) Log(t EventType, data interface{})
  • func (l *Logger) Subscribe(mask EventType) *Subscription
  • func (l *Logger) Unsubscribe(s *Subscription)
• type Subscription
  • func (s *Subscription) C() <-chan Event
  • func (s *Subscription) Poll(timeout time.Duration) (Event, error)

Constants

const BufferSize = 64

Variables

var (
	ErrTimeout = errors.New("timeout")
	ErrClosed  = errors.New("closed")
)

var Default = NewLogger()

Types

type BufferedSubscription

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

func NewBufferedSubscription

func NewBufferedSubscription(s *Subscription, size int) *BufferedSubscription

func (*BufferedSubscription) Since

func (s *BufferedSubscription) Since(id int, into []Event) []Event

type Event

type Event struct {
	ID   int         `json:"id"`
	Time time.Time   `json:"time"`
	Type EventType   `json:"type"`
	Data interface{} `json:"data"`
}

type EventType

type EventType int

const (
	Ping EventType = 1 << iota
	Starting
	StartupComplete
	DeviceDiscovered
	DeviceConnected
	DeviceDisconnected
	DeviceRejected
	LocalIndexUpdated
	RemoteIndexUpdated
	ItemStarted
	ItemFinished
	StateChanged
	FolderRejected
	ConfigSaved
	DownloadProgress
	FolderSummary
	FolderCompletion

	AllEvents = (1 << iota) - 1
)

func (EventType) MarshalText

func (t EventType) MarshalText() ([]byte, error)

func (EventType) String

func (t EventType) String() string

type Logger

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

func NewLogger

func NewLogger() *Logger

func (*Logger) Log

func (l *Logger) Log(t EventType, data interface{})

func (*Logger) Subscribe

func (l *Logger) Subscribe(mask EventType) *Subscription

func (*Logger) Unsubscribe

func (l *Logger) Unsubscribe(s *Subscription)

type Subscription

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

func (*Subscription) C

func (s *Subscription) C() <-chan Event

func (*Subscription) Poll

func (s *Subscription) Poll(timeout time.Duration) (Event, error)