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
• type Subscription

Constants

const BufferSize = 64

Variables

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

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 interface {
	suture.Service
	Log(t EventType, data interface{})
	Subscribe(mask EventType) Subscription
}

var NoopLogger Logger = &noopLogger{}

func NewLogger

func NewLogger() Logger

type Subscription

type Subscription interface {
	C() <-chan Event
	Poll(timeout time.Duration) (Event, error)
	Unsubscribe()
}