kafka.log

LogSegment

class LogSegment extends Logging

A segment of the log. Each segment has two components: a log and an index. The log is a FileMessageSet containing the actual messages. The index is an OffsetIndex that maps from logical offsets to physical file positions. Each segment has a base offset which is an offset <= the least offset of any message in this segment and > any offset in any previous segment.

A segment with a base offset of [base_offset] would be stored in two files, a [base_offset].index and a [base_offset].log file.

Inherited
  1. Hide All
  2. Show all
  1. Logging
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All

Instance constructors

  1. new LogSegment(dir: File, startOffset: Long, indexIntervalBytes: Int, maxIndexSize: Int, time: Time)

  2. new LogSegment(log: FileMessageSet, index: OffsetIndex, baseOffset: Long, indexIntervalBytes: Int, time: Time)

Value Members

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

    attributes: final
    definition classes: AnyRef
  2. def !=(arg0: Any): Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ##(): Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf[T0](): T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf[T0](): Boolean

    attributes: final
    definition classes: AnyRef
  6. def ==(arg0: AnyRef): Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def ==(arg0: Any): Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. def append(offset: Long, messages: ByteBufferMessageSet): Unit

    Append the given messages starting with the given offset.

    Append the given messages starting with the given offset. Add an entry to the index if needed.

    It is assumed this method is being called from within a lock.

    offset

    The first offset in the message set.

    messages

    The messages to append.

  9. def asInstanceOf[T0]: T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  10. val baseOffset: Long

  11. def changeFileSuffixes(oldSuffix: String, newSuffix: String): Unit

    Change the suffix for the index and log file for this log segment

    Change the suffix for the index and log file for this log segment

  12. def clone(): AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  13. def close(): Unit

    Close this log segment

    Close this log segment

  14. var created: Long

  15. def debug(msg: ⇒ String, e: ⇒ Throwable): Unit

    definition classes: Logging
  16. def debug(e: ⇒ Throwable): Any

    definition classes: Logging
  17. def debug(msg: ⇒ String): Unit

    definition classes: Logging
  18. def delete(): Unit

    Delete this log segment from the filesystem.

    Delete this log segment from the filesystem.

  19. def eq(arg0: AnyRef): Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  20. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  21. def error(msg: ⇒ String, e: ⇒ Throwable): Unit

    definition classes: Logging
  22. def error(e: ⇒ Throwable): Any

    definition classes: Logging
  23. def error(msg: ⇒ String): Unit

    definition classes: Logging
  24. def fatal(msg: ⇒ String, e: ⇒ Throwable): Unit

    definition classes: Logging
  25. def fatal(e: ⇒ Throwable): Any

    definition classes: Logging
  26. def fatal(msg: ⇒ String): Unit

    definition classes: Logging
  27. def finalize(): Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  28. def flush(): Unit

    Flush this log segment to disk

    Flush this log segment to disk

  29. def getClass(): java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  30. def hashCode(): Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  31. val index: OffsetIndex

  32. val indexIntervalBytes: Int

  33. def info(msg: ⇒ String, e: ⇒ Throwable): Unit

    definition classes: Logging
  34. def info(e: ⇒ Throwable): Any

    definition classes: Logging
  35. def info(msg: ⇒ String): Unit

    definition classes: Logging
  36. def isInstanceOf[T0]: Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  37. def lastModified: Long

    The last modified time of this log segment as a unix time stamp

    The last modified time of this log segment as a unix time stamp

  38. def lastModified_=(ms: Long): Boolean

    Change the last modified time for this log segment

    Change the last modified time for this log segment

  39. val log: FileMessageSet

  40. var logIdent: String

    attributes: protected
    definition classes: Logging
  41. lazy val logger: Logger

    definition classes: Logging
  42. val loggerName: String

    definition classes: Logging
  43. def ne(arg0: AnyRef): Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  44. def nextOffset(): Long

    Calculate the offset that would be used for the next message to be append to this segment.

    Calculate the offset that would be used for the next message to be append to this segment. Note that this is expensive.

  45. def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  46. def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  47. def read(startOffset: Long, maxOffset: Option[Long], maxSize: Int): MessageSet

    Read a message set from this segment beginning with the first offset >= startOffset.

    Read a message set from this segment beginning with the first offset >= startOffset. The message set will include no more than maxSize bytes and will end before maxOffset if a maxOffset is specified.

    startOffset

    A lower bound on the first offset to include in the message set we read

    maxOffset

    An optional maximum offset for the message set we read

    maxSize

    The maximum number of bytes to include in the message set we read

    returns

    The message set read or null if the startOffset is larger than the largest offset in this log.

  48. def recover(maxMessageSize: Int): Int

    Run recovery on the given segment.

    Run recovery on the given segment. This will rebuild the index from the log file and lop off any invalid bytes from the end of the log and index.

    maxMessageSize

    A bound the memory allocation in the case of a corrupt message size--we will assume any message larger than this is corrupt.

    returns

    The number of bytes truncated from the log

  49. def size: Long

  50. def swallow(action: ⇒ Unit): Unit

    definition classes: Logging
  51. def swallowDebug(action: ⇒ Unit): Unit

    definition classes: Logging
  52. def swallowError(action: ⇒ Unit): Unit

    definition classes: Logging
  53. def swallowInfo(action: ⇒ Unit): Unit

    definition classes: Logging
  54. def swallowTrace(action: ⇒ Unit): Unit

    definition classes: Logging
  55. def swallowWarn(action: ⇒ Unit): Unit

    definition classes: Logging
  56. def synchronized[T0](arg0: T0): T0

    attributes: final
    definition classes: AnyRef
  57. def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: LogSegment → AnyRef → Any
  58. def trace(msg: ⇒ String, e: ⇒ Throwable): Unit

    definition classes: Logging
  59. def trace(e: ⇒ Throwable): Any

    definition classes: Logging
  60. def trace(msg: ⇒ String): Unit

    definition classes: Logging
  61. def truncateTo(offset: Long): Int

    Truncate off all index and log entries with offsets >= the given offset.

    Truncate off all index and log entries with offsets >= the given offset. If the given offset is larger than the largest message in this segment, do nothing.

    offset

    The offset to truncate to

    returns

    The number of log bytes truncated

  62. def wait(): Unit

    attributes: final
    definition classes: AnyRef
  63. def wait(arg0: Long, arg1: Int): Unit

    attributes: final
    definition classes: AnyRef
  64. def wait(arg0: Long): Unit

    attributes: final
    definition classes: AnyRef
  65. def warn(msg: ⇒ String, e: ⇒ Throwable): Unit

    definition classes: Logging
  66. def warn(e: ⇒ Throwable): Any

    definition classes: Logging
  67. def warn(msg: ⇒ String): Unit

    definition classes: Logging