events

Documentation

Overview

Package events provides event subscription and polling functionality.

Index

• Constants
• Variables
• func Error(err error) *string
• type BufferedSubscription
  • func NewBufferedSubscription(s *Subscription, size int) BufferedSubscription
• type Event
• type EventType
  • func UnmarshalEventType(s string) EventType
  • func (t EventType) MarshalText() ([]byte, error)
  • func (t EventType) String() string
  • func (t *EventType) UnmarshalJSON(b []byte) error
• 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()

Functions

func Error

func Error(err error) *string

Error returns a string pointer suitable for JSON marshalling errors. It retains the "null on success" semantics, but ensures the error result is a string regardless of the underlying concrete error type.

Types

type BufferedSubscription

type BufferedSubscription interface {
	Since(id int, into []Event, timeout time.Duration) []Event
}

func NewBufferedSubscription

func NewBufferedSubscription(s *Subscription, size int) BufferedSubscription

type Event

type Event struct {
	// Per-subscription sequential event ID. Named "id" for backwards compatibility with the REST API
	SubscriptionID int `json:"id"`
	// Global ID of the event across all subscriptions
	GlobalID int         `json:"globalID"`
	Time     time.Time   `json:"time"`
	Type     EventType   `json:"type"`
	Data     interface{} `json:"data"`
}

type EventType

type EventType int

const (
	Starting EventType = 1 << iota
	StartupComplete
	DeviceDiscovered
	DeviceConnected
	DeviceDisconnected
	DeviceRejected
	DevicePaused
	DeviceResumed
	LocalChangeDetected
	RemoteChangeDetected
	LocalIndexUpdated
	RemoteIndexUpdated
	ItemStarted
	ItemFinished
	StateChanged
	FolderRejected
	ConfigSaved
	DownloadProgress
	RemoteDownloadProgress
	FolderSummary
	FolderCompletion
	FolderErrors
	FolderScanProgress
	FolderPaused
	FolderResumed
	FolderWatchStateChanged
	ListenAddressesChanged
	LoginAttempt

	AllEvents = (1 << iota) - 1
)

func UnmarshalEventType

func UnmarshalEventType(s string) EventType

func (EventType) MarshalText

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

func (EventType) String

func (t EventType) String() string

func (*EventType) UnmarshalJSON

func (t *EventType) UnmarshalJSON(b []byte) error

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)

Poll returns an event from the subscription or an error if the poll times out of the event channel is closed. Poll should not be called concurrently from multiple goroutines for a single subscription.