aboutsummaryrefslogtreecommitdiff
path: root/core/src/main/scala/spark/storage/BlockObjectWriter.scala
blob: 42e2b07d5ca5a6f2d906afcbcd5ee1ec8b56fe40 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
package spark.storage

import java.nio.ByteBuffer


/**
 * An interface for writing JVM objects to some underlying storage. This interface allows
 * appending data to an existing block, and can guarantee atomicity in the case of faults
 * as it allows the caller to revert partial writes.
 *
 * This interface does not support concurrent writes.
 */
abstract class BlockObjectWriter(val blockId: String) {

  var closeEventHandler: () => Unit = _

  def open(): BlockObjectWriter

  def close() {
    closeEventHandler()
  }

  def isOpen: Boolean

  def registerCloseEventHandler(handler: () => Unit) {
    closeEventHandler = handler
  }

  /**
   * Flush the partial writes and commit them as a single atomic block. Return the
   * number of bytes written for this commit.
   */
  def commit(): Long

  /**
   * Reverts writes that haven't been flushed yet. Callers should invoke this function
   * when there are runtime exceptions.
   */
  def revertPartialWrites()

  /**
   * Writes an object.
   */
  def write(value: Any)

  /**
   * Size of the valid writes, in bytes.
   */
  def size(): Long
}