• Home
• com.madavan
• caustic-common_2.12
• 1.2.9
• source code
• Log.scala

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

caustic.common.cursor.Log.scala Maven / Gradle / Ivy

package caustic.common.cursor

import scala.concurrent.{ExecutionContext, Future}

/**
 * An asynchronous log. Logs are thread-safe.
 *
 * @tparam T Type of log entries.
 */
trait Log[T] {

  /**
   * Asynchronously appends some data to the log. Returns a future containing the log sequence
   * number (sn), which completes when the data is successfully appended. Each lsn is guaranteed to
   * (1) be non-negative, and (2) be larger for entries appended after.
   *
   * @param data Data to be appended.
   * @return Future containing the lsn number of the appended entry.
   */
  def append(data: T)(
    implicit ec: ExecutionContext
  ): Future[Record[T]]

  /**
   * Returns an [[Cursor]] beginning from the specified lsn. Traversal of this cursor asynchronously
   * produces all log records whose lsn is greater than or equal to the specified lsn in the order
   * that they appear in the log.
   *
   * @param from Initial lsn.
   * @return Asynchronous cursor over log entries.
   */
  def read(from: Long): Cursor[T]

}