org.eligosource.eventsourced.journal.journalio

JournalioJournalProps

case class JournalioJournalProps(dir: File, name: Option[String] = scala.None, dispatcherName: Option[String] = scala.None, fsync: Boolean = false, checksum: Boolean = false, snapshotDir: Path = ..., snapshotSerializer: SnapshotSerializer = ..., snapshotLoadTimeout: FiniteDuration = ..., snapshotSaveTimeout: FiniteDuration = ..., snapshotFilesystem: FileSystem = ..., readOnly: Boolean = false) extends JournalProps with HadoopFilesystemSnapshottingProps[JournalioJournalProps] with Product with Serializable

Configuration object for a Journal.IO based journal. It has the following properties.

Pros:

Cons:

Journal actors can be created from a configuration object as follows:

import java.io.File

import akka.actor._

import org.eligosource.eventsourced.core.Journal
import org.eligosource.eventsourced.journal.journalio.JournalioJournalProps

implicit val system: ActorSystem = ...

val journalDir: File = ...
val journal: ActorRef = Journal(JournalioJournalProps(journalDir))
dir

Journal directory.

name

Optional journal actor name.

dispatcherName

Optional journal actor dispatcher name.

fsync

true if every write is physically synced. Default is false.

checksum

true if checksums are verified on read. Default is false.

Linear Supertypes
Serializable, Serializable, Product, Equals, HadoopFilesystemSnapshottingProps[JournalioJournalProps], JournalProps, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. JournalioJournalProps
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. HadoopFilesystemSnapshottingProps
  7. JournalProps
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new JournalioJournalProps(dir: File, name: Option[String] = scala.None, dispatcherName: Option[String] = scala.None, fsync: Boolean = false, checksum: Boolean = false, snapshotDir: Path = ..., snapshotSerializer: SnapshotSerializer = ..., snapshotLoadTimeout: FiniteDuration = ..., snapshotSaveTimeout: FiniteDuration = ..., snapshotFilesystem: FileSystem = ..., readOnly: Boolean = false)

    dir

    Journal directory.

    name

    Optional journal actor name.

    dispatcherName

    Optional journal actor dispatcher name.

    fsync

    true if every write is physically synced. Default is false.

    checksum

    true if checksums are verified on read. Default is false.

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. val checksum: Boolean

    true if checksums are verified on read.

    true if checksums are verified on read. Default is false.

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. def createJournal(implicit actorRefFactory: ActorRefFactory): ActorRef

    Creates and starts a new journal using the settings of this configuration object.

    Creates and starts a new journal using the settings of this configuration object.

    Definition Classes
    JournalProps

  10. def createJournalActor: Actor

    Creates a journal actor instance.

    Creates a journal actor instance.

    Definition Classes
    JournalioJournalProps → JournalProps

  11. val dir: File

    Journal directory.

  12. val dispatcherName: Option[String]

    Optional journal actor dispatcher name.

    Optional journal actor dispatcher name.

    Definition Classes
    JournalioJournalProps → JournalProps

  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  14. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. val fsync: Boolean

    true if every write is physically synced.

    true if every write is physically synced. Default is false.

  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  17. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  18. val name: Option[String]

    Optional journal actor name.

    Optional journal actor name.

    Definition Classes
    JournalioJournalProps → JournalProps

  19. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  22. val readOnly: Boolean

    Make journal read only (e.

    Make journal read only (e.g. offline snapshot)

    Definition Classes
    JournalioJournalProps → JournalProps

  23. val snapshotDir: Path

  24. val snapshotFilesystem: FileSystem

    Hadoop filesystem for storing snapshots.

    Hadoop filesystem for storing snapshots.

    Definition Classes
    JournalioJournalProps → HadoopFilesystemSnapshottingProps

  25. val snapshotLoadTimeout: FiniteDuration

    Timeout for loading a snapshot.

    Timeout for loading a snapshot.

    Definition Classes
    JournalioJournalProps → HadoopFilesystemSnapshottingProps

  26. val snapshotPath: Path

    Path where snapshots are stored on snapshotFilesystem.

    Path where snapshots are stored on snapshotFilesystem. A relative path is relative to snapshotFilesystem's working directory.

    Definition Classes
    JournalioJournalProps → HadoopFilesystemSnapshottingProps

  27. val snapshotSaveTimeout: FiniteDuration

    Timeout for saving a snapshot.

    Timeout for saving a snapshot.

    Definition Classes
    JournalioJournalProps → HadoopFilesystemSnapshottingProps

  28. val snapshotSerializer: SnapshotSerializer

    Serializer for writing and reading snapshots.

    Serializer for writing and reading snapshots.

    Definition Classes
    JournalioJournalProps → HadoopFilesystemSnapshottingProps

  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  30. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. def withChecksum(checksum: Boolean): JournalioJournalProps

    Java API.

    Java API.

    Returns a new JournalioJournalProps with specified checksum verification setting.

  34. def withDispatcherName(dispatcherName: String): JournalioJournalProps

    Java API.

    Java API.

    Returns a new JournalioJournalProps with specified journal actor dispatcher name.

  35. def withFsync(fsync: Boolean): JournalioJournalProps

    Java API.

    Java API.

    Returns a new JournalioJournalProps with specified physical sync setting.

  36. def withName(name: String): JournalioJournalProps

    Java API.

    Java API.

    Returns a new JournalioJournalProps with specified journal actor name.

  37. def withReadOnly(ro: Boolean): JournalioJournalProps

    Java API.

    Java API.

    Returns a new JournalioJournalProps with specified read only property

  38. def withSnapshotDir(snapshotDir: Path): JournalioJournalProps

    Java API.

    Java API.

    Returns a new JournalioJournalProps with specified snapshot dir.

  39. def withSnapshotFilesystem(snapshotFilesystem: FileSystem): JournalioJournalProps

    Java API.

    Java API.

    Returns a new JournalioJournalProps with specified snapshot filesystem.

    Definition Classes
    JournalioJournalProps → HadoopFilesystemSnapshottingProps

  40. def withSnapshotLoadTimeout(snapshotLoadTimeout: FiniteDuration): JournalioJournalProps

    Java API.

    Java API.

    Returns a new JournalioJournalProps with specified snapshot load timeout.

    Definition Classes
    JournalioJournalProps → HadoopFilesystemSnapshottingProps

  41. def withSnapshotSaveTimeout(snapshotSaveTimeout: FiniteDuration): JournalioJournalProps

    Java API.

    Java API.

    Returns a new JournalioJournalProps with specified snapshot save timeout.

    Definition Classes
    JournalioJournalProps → HadoopFilesystemSnapshottingProps

  42. def withSnapshotSerializer(snapshotSerializer: SnapshotSerializer): JournalioJournalProps

    Java API.

    Java API.

    Returns a new JournalioJournalProps with specified snapshot serializer.

    Definition Classes
    JournalioJournalProps → HadoopFilesystemSnapshottingProps

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from HadoopFilesystemSnapshottingProps[JournalioJournalProps]

Inherited from JournalProps

Inherited from AnyRef

Inherited from Any

Ungrouped