Documentation
¶
Index ¶
Constants ¶
View Source
const ( DefaultWatchMethod = WatchMethodPolling DefaultWatchInterval = 100 * time.Millisecond DefaultWatchFileRecursive bool = true DefaultWatchFilterScope = WatchFilterScopeFilename DefaultWatchFilterInclude bool = true DefaultWatchFilterType = WatchFilterTypeRegex DefaultRateLimitStrategy = RateLimitStrategyNone DefaultRateLimitWait time.Duration = 0 DefaultKillSignal = syscall.SIGTERM DefaultKillTimeout time.Duration = 0 )
Variables ¶
View Source
var ( ErrConfiguratorAlreadyRegistered = errors.New("a configurator has been already registered") ErrNoRegisteredConfigurator = errors.New("no configurator has been registered") )
View Source
var ( DefaultWatcher = Watcher{ Name: "", Watch: DefaultWatch, RateLimit: DefaultRateLimit, Kill: DefaultKill, Command: DefaultCommand, } DefaultCommand = Command{ Shell: "/bin/sh -c", Path: ".", Env: os.Environ(), Exec: "", } DefaultWatch = Watch{ Method: DefaultWatchMethod, Interval: DefaultWatchInterval, Files: nil, Filters: nil, } DefaultWatchFile = WatchFile{ Path: "", Recursive: DefaultWatchFileRecursive, } DefaultWatchFilter = WatchFilter{ On: DefaultWatchFilterScope, Include: DefaultWatchFilterInclude, Type: DefaultWatchFilterType, List: nil, } DefaultRateLimit = RateLimit{ Strategy: DefaultRateLimitStrategy, Wait: DefaultRateLimitWait, } DefaultKill = Kill{ Signal: DefaultKillSignal, Timeout: DefaultKillTimeout, } )
Functions ¶
func Register ¶
func Register(cfr Configurator)
Types ¶
type Configurator ¶
type RateLimit ¶
type RateLimit struct {
Strategy RateLimitStrategy `json:"strategy"`
Wait time.Duration `json:"wait"`
}
type RateLimitStrategy ¶
type RateLimitStrategy string
const ( RateLimitStrategyNone RateLimitStrategy = "none" RateLimitStrategyDebounce RateLimitStrategy = "debounce" RateLimitStrategyThrottle RateLimitStrategy = "throttle" RateLimitStrategyAudit RateLimitStrategy = "audit" RateLimitStrategySample RateLimitStrategy = "sample" )
type Watch ¶
type Watch struct {
Method WatchMethod `json:"method"`
Interval time.Duration `json:"interval"`
Files []WatchFile `json:"files"`
Filters []WatchFilter `json:"filters"`
}
type WatchFilter ¶
type WatchFilter struct {
On WatchFilterScope `json:"on"`
Include bool `json:"include"`
Type WatchFilterType `json:"type"`
List []string `json:"list"`
}
type WatchFilterScope ¶
type WatchFilterScope string
const ( WatchFilterScopeFilename WatchFilterScope = "filename" WatchFilterScopeOperation WatchFilterScope = "operation" )
type WatchFilterType ¶
type WatchFilterType string
const ( WatchFilterTypeRegex WatchFilterType = "regex" WatchFilterTypeList WatchFilterType = "list" )
type WatchMethod ¶
type WatchMethod string
const ( WatchMethodPolling WatchMethod = "polling" WatchMethodFsnotify WatchMethod = "fsnotify" )
Click to show internal directories.
Click to hide internal directories.