watcherx

Documentation

Index

• Variables
• func NewChangeFeedConnection(ctx context.Context, l *logrusx.Logger, dsn string) (*sqlx.DB, error)
• func WatchAndServeWS(ctx context.Context, u *url.URL, writer herodot.Writer) (http.HandlerFunc, error)
• type ChangeEvent
  • func (e *ChangeEvent) MarshalJSON() ([]byte, error)
  • func (e *ChangeEvent) Reader() io.Reader
  • func (e ChangeEvent) Source() string
  • func (e *ChangeEvent) String() string
• type ErrorEvent
  • func (e *ErrorEvent) MarshalJSON() ([]byte, error)
  • func (e *ErrorEvent) Reader() io.Reader
  • func (e ErrorEvent) Source() string
  • func (e *ErrorEvent) String() string
• type Event
• type EventChannel
• type RemoveEvent
  • func (e *RemoveEvent) MarshalJSON() ([]byte, error)
  • func (e *RemoveEvent) Reader() io.Reader
  • func (e RemoveEvent) Source() string
  • func (e *RemoveEvent) String() string
• type Watcher
  • func Watch(ctx context.Context, u *url.URL, c EventChannel) (Watcher, error)
  • func WatchChangeFeed(ctx context.Context, cx *sqlx.DB, tableName string, out EventChannel, ...) (_ Watcher, err error)
  • func WatchDirectory(ctx context.Context, dir string, c EventChannel) (Watcher, error)
  • func WatchFile(ctx context.Context, file string, c EventChannel) (Watcher, error)
  • func WatchWebsocket(ctx context.Context, u *url.URL, c EventChannel) (Watcher, error)

Variables

var (
	// ErrSchemeUnknown is just for checking with errors.Is()
	ErrSchemeUnknown     = &errSchemeUnknown{}
	ErrWatcherNotRunning = fmt.Errorf("watcher is not running")
)

Functions

func NewChangeFeedConnection

func NewChangeFeedConnection(ctx context.Context, l *logrusx.Logger, dsn string) (*sqlx.DB, error)

func WatchAndServeWS

func WatchAndServeWS(ctx context.Context, u *url.URL, writer herodot.Writer) (http.HandlerFunc, error)

Types

type ChangeEvent

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

func (*ChangeEvent) MarshalJSON

func (e *ChangeEvent) MarshalJSON() ([]byte, error)

func (*ChangeEvent) Reader

func (e *ChangeEvent) Reader() io.Reader

func (ChangeEvent) Source

func (e ChangeEvent) Source() string

func (*ChangeEvent) String

func (e *ChangeEvent) String() string

type ErrorEvent

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

func (*ErrorEvent) MarshalJSON

func (e *ErrorEvent) MarshalJSON() ([]byte, error)

func (*ErrorEvent) Reader

func (e *ErrorEvent) Reader() io.Reader

func (ErrorEvent) Source

func (e ErrorEvent) Source() string

func (*ErrorEvent) String

func (e *ErrorEvent) String() string

type Event

type Event interface {
	// MarshalJSON is required to work multiple times
	json.Marshaler

	Reader() io.Reader
	Source() string
	String() string
	// contains filtered or unexported methods
}

type EventChannel

type EventChannel chan Event

type RemoveEvent

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

func (*RemoveEvent) MarshalJSON

func (e *RemoveEvent) MarshalJSON() ([]byte, error)

func (*RemoveEvent) Reader

func (e *RemoveEvent) Reader() io.Reader

func (RemoveEvent) Source

func (e RemoveEvent) Source() string

func (*RemoveEvent) String

func (e *RemoveEvent) String() string

type Watcher

type Watcher interface {
	// DispatchNow fires the watcher and causes an event.
	//
	// WARNING: The returned channel must be read or no further events will
	// be propagated due to a deadlock.
	DispatchNow() (<-chan int, error)
}

func Watch

func Watch(ctx context.Context, u *url.URL, c EventChannel) (Watcher, error)

func WatchChangeFeed

func WatchChangeFeed(ctx context.Context, cx *sqlx.DB, tableName string, out EventChannel, cursor time.Time) (_ Watcher, err error)

WatchChangeFeed sends changed rows on the channel. To cancel the execution, cancel the context!

Watcher.DispatchNow() does not have an effect in this method.

This watcher is blocking to allow proper context cancellation and clean up.

func WatchDirectory

func WatchDirectory(ctx context.Context, dir string, c EventChannel) (Watcher, error)

func WatchFile

func WatchFile(ctx context.Context, file string, c EventChannel) (Watcher, error)

WatchFile spawns a background goroutine to watch file, reporting any changes to c. When initially starting to watch the file fails, c is closed. Watching stops when ctx is canceled, at which point c is also closed.

func WatchWebsocket

func WatchWebsocket(ctx context.Context, u *url.URL, c EventChannel) (Watcher, error)