Messages

Type Members

1. sealed trait BossyMessage extends AnyRef

   

   Trait to make a message definition "Bossy", meaning it will remove all other callbacks for a specific path and event type

2. sealed case class EventAtPath(event: Kind[_], path: Path) extends Product with Serializable

   

   Message case class for telling a MonitorActor that an event has happened and at what path

   Message case class for telling a MonitorActor that an event has happened and at what path

   event

   WatchEvent.Kind[Path], one of ENTRY_CREATE, ENTRY_MODIFY, ENTRY_DELETE

   path

   Path (Java object) pointing to a file/directory

3. sealed abstract class ForwardToSubscriber extends AnyRef

   

   Abstract class to make it easy to define a registration that forwards EvenAtPath messages to a particular ActorRef

4. sealed case class PerformCallback(path: Path, callback: Callback) extends Product with Serializable

   

   Message case class for telling a CallbackActor to perform a callback

   Message case class for telling a CallbackActor to perform a callback

   path

   Path (Java object) pointing to a file/directory

   callback

   (Path) => Unit type function

5. sealed case class RegisterBossyCallback(event: Kind[Path], path: Path, callback: Callback, modifier: Option[Modifier] = None, recursive: Boolean = false, persistent: Boolean = false) extends RegisterCallbackMessage with BossyMessage with Product with Serializable

   

   Message case class for telling a MonitorActor that the callback contained will be the ONLY callback registered for the specific path.

   Message case class for telling a MonitorActor that the callback contained will be the ONLY callback registered for the specific path.

   Mostly intended to be used with RxMonitor; hence the terrible name.

   event

   WatchEvent.Kind[Path], one of ENTRY_CREATE, ENTRY_MODIFY, ENTRY_DELETE

   path

   Path (Java object) pointing to a file/directory

   callback

   (Path) => Unit type function

   modifier

   Optional Modifier that qualifies how a Watchable is registered with a WatchService.

   recursive

   Boolean to specify to recursively register the callback or not, defaults to false

   persistent

   Boolean To automatically add the same callback to new files or not, defaults to false

6. sealed case class RegisterBossySubscriber(event: Kind[Path], path: Path, subscriber: ActorRef, modifier: Option[Modifier] = None, recursive: Boolean = false, persistent: Boolean = false) extends ForwardToSubscriber with RegisterCallbackMessage with BossyMessage with Product with Serializable

   

   Message case class for registering an ActorRef to receive EventAtPath messages when something happens at a path.

   Message case class for registering an ActorRef to receive EventAtPath messages when something happens at a path.

   This is different from RegisterSubscriber in that when something happens at the provided path, the only thing that will happen is the ActorRef you provided will get notified.

   event

   WatchEvent.Kind[Path], one of ENTRY_CREATE, ENTRY_MODIFY, ENTRY_DELETE

   path

   Path (Java object) pointing to a file/directory

   subscriber

   ActorRef that you want to receive notifications on

   modifier

   Optional Modifier that qualifies how a Watchable is registered with a WatchService.

   recursive

   Boolean To recursively register the callback or not, defaults to false

   persistent

   Boolean To automatically add the same callback to new files or not, defaults to false

7. sealed case class RegisterCallback(event: Kind[Path], path: Path, callback: Callback, modifier: Option[Modifier] = None, recursive: Boolean = false, persistent: Boolean = false) extends RegisterCallbackMessage with Product with Serializable

   

   Message case class for telling a MonitorActor to register a path for callback

   Message case class for telling a MonitorActor to register a path for callback

   event

   WatchEvent.Kind[Path], one of ENTRY_CREATE, ENTRY_MODIFY, ENTRY_DELETE

   path

   Path (Java object) pointing to a file/directory

   callback

   (Path) => Unit type function

   recursive

   Boolean To recursively register the callback or not, defaults to false

   persistent

   Boolean To automatically add the same callback to new files or not, defaults to false

8. sealed trait RegisterCallbackMessage extends AnyRef

   

   Base trait for registering callbacks

9. sealed case class RegisterSubscriber(event: Kind[Path], path: Path, subscriber: ActorRef, modifier: Option[Modifier] = None, recursive: Boolean = false, persistent: Boolean = false) extends ForwardToSubscriber with RegisterCallbackMessage with Product with Serializable

   

   Message case class for registering an ActorRef to receive EventAtPath messages when something happens at a path

   Message case class for registering an ActorRef to receive EventAtPath messages when something happens at a path

   event

   WatchEvent.Kind[Path], one of ENTRY_CREATE, ENTRY_MODIFY, ENTRY_DELETE

   path

   Path (Java object) pointing to a file/directory

   subscriber

   ActorRef that you want to receive notifications on

   modifier

   Optional Modifier that qualifies how a Watchable is registered with a WatchService.

   recursive

   Boolean To recursively register the callback or not, defaults to false

   persistent

   Boolean To automatically add the same callback to new files or not, defaults to false

10. sealed case class UnRegisterCallback(event: Kind[Path], path: Path, recursive: Boolean = false) extends Product with Serializable

    

    Message case class for telling a MonitorActor to un-register a path for callback

    Message case class for telling a MonitorActor to un-register a path for callback

    Note that this does not remove the event listeners from the Java API, because such functionality does not exist. All this does is make sure that the callbacks registered to a specific path do not get fired. Depending on your use case, it may make more sense to just kill the monitor actor to start fresh.

    event

    WatchEvent.Kind[Path], one of ENTRY_CREATE, ENTRY_MODIFY, ENTRY_DELETE

    path

    Path (Java object) pointing to a file/directory

    recursive

    Boolean to specify to recursively register the callback or not, defaults to false