loader

Documentation

Index

• func AllowDotFiles(l *Loader)
• func IgnoreDotFiles(l *Loader)
• type DirectoryRefresher
  • func (d *DirectoryRefresher) ShouldRefresh(path string, op FileSystemOp) bool
  • func (d *DirectoryRefresher) WatchDirectory(runtimePath string, appDirPath string) string
  • func (d *DirectoryRefresher) WatchFileSystemOps(fsops ...FileSystemOp)
• type FileSystemOp
• type IFace
  • func New(runtimePath string, runtimeSubdirectory string, scope stats.Scope, ...) IFace
  • func New2(runtimePath, runtimeSubdirectory string, scope stats.Scope, ...) (IFace, error)
• type Loader
  • func (l *Loader) AddUpdateCallback(callback chan<- int)
  • func (l *Loader) Snapshot() snapshot.IFace
• type Nil
  • func NewNil() Nil
  • func (Nil) AddUpdateCallback(callback chan<- int)
  • func (n Nil) Snapshot() snapshot.IFace
• type Option
• type Refresher
• type SymlinkRefresher
  • func (s *SymlinkRefresher) ShouldRefresh(path string, op FileSystemOp) bool
  • func (s *SymlinkRefresher) WatchDirectory(runtimePath string, appDirPath string) string

Functions

func AllowDotFiles

func AllowDotFiles(l *Loader)

func IgnoreDotFiles

func IgnoreDotFiles(l *Loader)

Types

type DirectoryRefresher

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

func (*DirectoryRefresher) ShouldRefresh

func (d *DirectoryRefresher) ShouldRefresh(path string, op FileSystemOp) bool

func (*DirectoryRefresher) WatchDirectory

func (d *DirectoryRefresher) WatchDirectory(runtimePath string, appDirPath string) string

func (*DirectoryRefresher) WatchFileSystemOps

func (d *DirectoryRefresher) WatchFileSystemOps(fsops ...FileSystemOp)

type FileSystemOp

type FileSystemOp int32

const (
	Create FileSystemOp = iota
	Write
	Remove
	Rename
	Chmod
)

Filesystem operations that are monitored for changes

type IFace

type IFace interface {
	// @return Snapshot the current snapshot. This reference is safe to use forever, but will grow
	//         stale so should not be stored beyond when it is immediately needed.
	Snapshot() snapshot.IFace

	// Add a channel that will be written to when a new snapshot is available. "1" will be written
	// to the channel as a sentinel.
	// @param callback supplies the callback to add.
	AddUpdateCallback(callback chan<- int)
}

func New

func New(runtimePath string, runtimeSubdirectory string, scope stats.Scope, refresher Refresher, opts ...Option) IFace

Deprecated: use New2 instead

func New2

func New2(runtimePath, runtimeSubdirectory string, scope stats.Scope, refresher Refresher, opts ...Option) (IFace, error)

type Loader

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

Implementation of Loader that watches a symlink and reads from the filesystem.

func (*Loader) AddUpdateCallback

func (l *Loader) AddUpdateCallback(callback chan<- int)

func (*Loader) Snapshot

func (l *Loader) Snapshot() snapshot.IFace

type Nil

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

Implementation of Loader with no backing store.

func NewNil

func NewNil() Nil

func (Nil) AddUpdateCallback

func (Nil) AddUpdateCallback(callback chan<- int)

func (Nil) Snapshot

func (n Nil) Snapshot() snapshot.IFace

type Option

type Option func(l *Loader)

type Refresher

type Refresher interface {
	// @return The directory path to watch for changes.
	// @param runtimePath The root of the runtime path
	// @param appDirPath Any app specific path
	WatchDirectory(runtimePath string, appDirPath string) string

	// @return If the runtime needs to be refreshed
	// @param path The path that triggered the FileSystemOp
	// @param The Filesystem op that happened on the directory returned from WatchDirectory
	ShouldRefresh(path string, op FileSystemOp) bool
}

A Refresher is used to determine when to refresh the runtime

type SymlinkRefresher

type SymlinkRefresher struct {
	RuntimePath string
}

func (*SymlinkRefresher) ShouldRefresh

func (s *SymlinkRefresher) ShouldRefresh(path string, op FileSystemOp) bool

func (*SymlinkRefresher) WatchDirectory

func (s *SymlinkRefresher) WatchDirectory(runtimePath string, appDirPath string) string