sealed abstract class Watcher[F[_]] extends AnyRef
Allows watching the file system for changes to directories and files by using the platform's WatchService.
- Source
- DeprecatedWatcher.scala
- Alphabetic
- By Inheritance
- Watcher
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def events(pollTimeout: FiniteDuration = 1.second): Stream[F, Event]
Stream of events for paths that have been registered or watched.
Stream of events for paths that have been registered or watched.
- pollTimeout
amount of time for which the underlying platform is polled for events
- abstract def register(path: Path, types: Seq[EventType] = Nil, modifiers: Seq[Modifier] = Nil): F[F[Unit]]
Registers for events on the specified path.
Registers for events on the specified path.
This is a low-level abstraction on the platform's
Path#register. The supplied path must be a directory and events are raised for only direct descendants of the path. Use watch for a higher level API.Returns a cancellation task that unregisters the path for events. Unregistration is optional - the
Watcherwill free all resources when it is finalized. Unregistration is only needed when aWatcherwill continue to be used after unregistration.- path
directory to watch for events
- types
event types to register for; if
Nil, all standard event types are registered- modifiers
modifiers to pass to the underlying
WatchServicewhen registering- returns
unregistration task
- abstract def watch(path: Path, types: Seq[EventType] = Nil, modifiers: Seq[Modifier] = Nil): F[F[Unit]]
Registers for events on the specified path.
Registers for events on the specified path.
This is more feature-rich than the platform's
Path#register. The supplied path may be a file or directory and events may raised for all descendants of the path. Use register for a lower-level API.Returns a cancellation task that unregisters the path for events. Unregistration is optional - the
Watcherwill free all resources when it is finalized. Unregistration is only needed when aWatcherwill continue to be used after unregistration.- path
file or directory to watch for events
- types
event types to register for; if
Nil, all standard event types are registered- modifiers
modifiers to pass to the underlying
WatchServicewhen registering- returns
unregistration task
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])