csnotify

README

Cloud storage notifications for Go

Watch objects in S3 buckets and get notifiations when they have changed.

Inspired by fsnotify

Notes

• Specify path in S3: s3://<bucketName>/path/to/object.
• Only supports objects.

Examples

• s3-reload - https://github.com/app-sre/s3-reload

Documentation

Index

• type Event
• type Watcher
  • func NewWatcher() (*Watcher, error)
  • func (w *Watcher) Add(path string)
  • func (w *Watcher) Remove(path string)

Types

type Event

type Event struct {
	Path string // path to object.
}

Event represents an object notification.

type Watcher

type Watcher struct {
	Events chan Event
	Errors chan error
	// contains filtered or unexported fields
}

Watcher watches a set of objects, delivering events to a channel.

func NewWatcher

func NewWatcher() (*Watcher, error)

NewWatcher creates a new session and begins waiting for events.

func (*Watcher) Add

func (w *Watcher) Add(path string)

Add starts watching the specified S3 object path (non-recursively).

func (*Watcher) Remove

func (w *Watcher) Remove(path string)

Remove stops watching the specified S3 object path (non-recursively).