Packages

trait Sys[S <: Sys[S]] extends stm.Sys[S]

This is analogous to a ConfluentLike trait. Since there is only one system in LucreConfluent, it was decided to just name it confluent.Sys.

S

the implementing system

Linear Supertypes
stm.Sys[S], Base[S], Closeable, AutoCloseable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Sys
  2. Sys
  3. Base
  4. Closeable
  5. AutoCloseable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final type Acc = Access[S]

    The path access type for objects if they carry a temporal trace.

    The path access type for objects if they carry a temporal trace. This is used by confluently persistent systems, while it is typically Unit for ephemeral systems.

    Definition Classes
    SysBase
  2. abstract type D <: DurableLike[D]
  3. abstract type I <: InMemoryLike[I]
    Definition Classes
    SysSysBase
  4. final type Id = Identifier[S]

    The identifier type of the system.

    The identifier type of the system. This is an opaque type about which the user only knows that it uniquely identifies and object (or an object along with its access path in the confluent case). It is thus valid to assume that two objects are equal if their identifiers are equal.

    Definition Classes
    SysBase
  5. abstract type Tx <: Txn[S]

    The transaction type of the system.

    The transaction type of the system.

    Definition Classes
    SysSysBase
  6. final type Var[A] = confluent.Var[S, A]

    The variable type of the system.

    The variable type of the system. Variables allow transactional storage and retrieval both of immutable and mutable values. Specific systems may extend the minimum capabilities described by the Var trait.

    Definition Classes
    SysBase

Abstract Value Members

  1. abstract def close(): Unit

    Closes the underlying database (if the system is durable).

    Closes the underlying database (if the system is durable). The STM cannot be used beyond this call. An in-memory system should have a no-op implementation.

    Definition Classes
    Base → Closeable → AutoCloseable
  2. abstract def cursorRoot[A, B](init: (S.Tx) ⇒ A)(result: (S.Tx) ⇒ (A) ⇒ B)(implicit serializer: Serializer[S.Tx, Access[S], A]): (confluent.Var[S, A], B)

    Initializes the data structure, by either reading an existing entry or generating the root entry with the init function.

    Initializes the data structure, by either reading an existing entry or generating the root entry with the init function. The method than allows the execution of another function within the same transaction, passing it the data structure root of type A. This is typically used to generate access mechanisms, such as extracting a cursor from the data structure, or instantiating a new cursor. The method then returns both the access point to the data structure and the result of the second function.

    A

    type of data structure

    B

    type of result from the second function. typically this is an stm.Cursor[S]

    init

    a function to initialize the data structure (if the database is fresh)

    result

    a function to process the data structure

    serializer

    a serializer to read or write the data structure

    returns

    the access to the data structure along with the result of the second function.

  3. abstract def debugPrintIndex(index: Access[S])(implicit tx: S.Tx): String
  4. abstract def durable: D
  5. abstract def durableTx(tx: S.Tx): D.Tx
  6. abstract def inMemory: I
    Definition Classes
    Base
  7. abstract def inMemoryTx(tx: S.Tx): I.Tx
    Definition Classes
    Base
  8. abstract def newCursor(init: Access[S])(implicit tx: S.Tx): Cursor[S, D]
  9. abstract def newCursor()(implicit tx: S.Tx): Cursor[S, D]
  10. abstract def readCursor(in: DataInput)(implicit tx: S.Tx): Cursor[S, D]
  11. abstract def readPath(in: DataInput): Access[S]
  12. abstract def root[A](init: (S.Tx) ⇒ A)(implicit serializer: Serializer[S.Tx, S.Acc, A]): stm.Source[S.Tx, A]

    Reads the root object representing the stored data structure, or provides a newly initialized one via the init argument, if no root has been stored yet.

    Reads the root object representing the stored data structure, or provides a newly initialized one via the init argument, if no root has been stored yet.

    Definition Classes
    Sys
  13. abstract def rootWithDurable[A, B](confluent: (S.Tx) ⇒ A)(durable: (D.Tx) ⇒ B)(implicit aSer: Serializer[S.Tx, Access[S], A], bSer: Serializer[D.Tx, Unit, B]): (stm.Source[S.Tx, A], B)

    Initializes the data structure both with a confluently persisted and an ephemeral-durable value.

    Initializes the data structure both with a confluently persisted and an ephemeral-durable value.

    A

    type of confluent data structure

    B

    type of ephemeral data structure

    confluent

    a function that provides the initial confluent data (if the database is fresh)

    durable

    a function that provides the initial ephemeral data (if the database is fresh)

    aSer

    a serializer to read or write the confluent data structure

    bSer

    a serializer to read or write the ephemeral data structure

    returns

    a tuple consisting of a handle to the confluent structure and the ephemeral datum. The ephemeral datum, although written to disk, does not require an stm.Source because D#Acc is Unit and does not need refresh.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from stm.Sys[S]

Inherited from Base[S]

Inherited from Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped