kafka.message

ByteBufferMessageSet

class ByteBufferMessageSet extends MessageSet with Logging

A sequence of messages stored in a byte buffer

There are two ways to create a ByteBufferMessageSet

Option 1: From a ByteBuffer which already contains the serialized message set. Consumers will use this method.

Option 2: Give it a list of messages along with instructions relating to serialization format. Producers will use this method.

go to: companion
Inherited
  1. Hide All
  2. Show all
  1. Logging
  2. MessageSet
  3. Iterable
  4. IterableLike
  5. Equals
  6. Traversable
  7. GenericTraversableTemplate
  8. TraversableLike
  9. TraversableOnce
  10. FilterMonadic
  11. HasNewBuilder
  12. AnyRef
  13. Any
Visibility
  1. Public
  2. All

Instance constructors

  1. new ByteBufferMessageSet(messages: Message*)

  2. new ByteBufferMessageSet(compressionCodec: CompressionCodec, messages: Message*)

  3. new ByteBufferMessageSet(buffer: ByteBuffer, initialOffset: Long = 0L, errorCode: Int = kafka.common.ErrorMapping.NoError)

Type Members

  1. type Self = Iterable[MessageAndOffset]

    attributes: protected
    definition classes: TraversableLike

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 ++[B >: MessageAndOffset, That](that: TraversableOnce[B])(implicit bf: CanBuildFrom[Iterable[MessageAndOffset], B, That]): That

    definition classes: TraversableLike
  7. def /:[B](z: B)(op: (B, MessageAndOffset) ⇒ B): B

    definition classes: TraversableOnce
  8. def :\[B](z: B)(op: (MessageAndOffset, B) ⇒ B): B

    definition classes: TraversableOnce
  9. 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
  10. 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
  11. def addString(b: StringBuilder): StringBuilder

    definition classes: TraversableOnce
  12. def addString(b: StringBuilder, sep: String): StringBuilder

    definition classes: TraversableOnce
  13. def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder

    definition classes: TraversableOnce
  14. 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
  15. def canEqual(other: Any): Boolean

    definition classes: ByteBufferMessageSet → IterableLike → Equals
  16. 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
  17. def collect[B, That](pf: PartialFunction[MessageAndOffset, B])(implicit bf: CanBuildFrom[Iterable[MessageAndOffset], B, That]): That

    definition classes: TraversableLike
  18. def companion: GenericCompanion[Iterable[A][A]]

    definition classes: Iterable → Traversable → GenericTraversableTemplate
  19. def copyToArray[B >: MessageAndOffset](xs: Array[B], start: Int, len: Int): Unit

    definition classes: IterableLike → TraversableLike → TraversableOnce
  20. def copyToArray[B >: MessageAndOffset](xs: Array[B]): Unit

    definition classes: TraversableOnce
  21. def copyToArray[B >: MessageAndOffset](xs: Array[B], start: Int): Unit

    definition classes: TraversableOnce
  22. def copyToBuffer[B >: MessageAndOffset](dest: Buffer[B]): Unit

    definition classes: TraversableOnce
  23. def count(p: (MessageAndOffset) ⇒ Boolean): Int

    definition classes: TraversableOnce
  24. def debug(msg: ⇒ String, e: ⇒ Throwable): Unit

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

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

    definition classes: Logging
  27. def drop(n: Int): Iterable[MessageAndOffset]

    definition classes: TraversableLike
  28. def dropRight(n: Int): Iterable[MessageAndOffset]

    definition classes: IterableLike
  29. def dropWhile(p: (MessageAndOffset) ⇒ Boolean): Iterable[MessageAndOffset]

    definition classes: TraversableLike
  30. def elements: Iterator[MessageAndOffset]

    definition classes: IterableLike
      deprecated:
    1. use iterator' instead

  31. 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
  32. def equals(other: 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)).

    returns

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

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

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

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

    definition classes: Logging
  36. def exists(p: (MessageAndOffset) ⇒ Boolean): Boolean

    definition classes: IterableLike → TraversableLike → TraversableOnce
  37. def fatal(msg: ⇒ String, e: ⇒ Throwable): Unit

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

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

    definition classes: Logging
  40. def filter(p: (MessageAndOffset) ⇒ Boolean): Iterable[MessageAndOffset]

    definition classes: TraversableLike
  41. def filterNot(p: (MessageAndOffset) ⇒ Boolean): Iterable[MessageAndOffset]

    definition classes: TraversableLike
  42. 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
  43. def find(p: (MessageAndOffset) ⇒ Boolean): Option[MessageAndOffset]

    definition classes: IterableLike → TraversableLike → TraversableOnce
  44. def first: MessageAndOffset

    definition classes: IterableLike
      deprecated:
    1. use head' instead

  45. def firstOption: Option[MessageAndOffset]

    definition classes: IterableLike
      deprecated:
    1. use headOption' instead

  46. def flatMap[B, That](f: (MessageAndOffset) ⇒ Traversable[B])(implicit bf: CanBuildFrom[Iterable[MessageAndOffset], B, That]): That

    definition classes: TraversableLike → FilterMonadic
  47. def flatten[B](implicit asTraversable: (MessageAndOffset) ⇒ Traversable[B]): Iterable[B]

    definition classes: GenericTraversableTemplate
  48. def foldLeft[B](z: B)(op: (B, MessageAndOffset) ⇒ B): B

    definition classes: TraversableOnce
  49. def foldRight[B](z: B)(op: (MessageAndOffset, B) ⇒ B): B

    definition classes: IterableLike → TraversableOnce
  50. def forall(p: (MessageAndOffset) ⇒ Boolean): Boolean

    definition classes: IterableLike → TraversableLike → TraversableOnce
  51. def foreach[U](f: (MessageAndOffset) ⇒ U): Unit

    definition classes: IterableLike → TraversableLike → TraversableOnce → FilterMonadic
  52. def genericBuilder[B]: Builder[B, Iterable[B]]

    definition classes: GenericTraversableTemplate
  53. def getBuffer: ByteBuffer

  54. 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
  55. def getErrorCode: Int

  56. def getInitialOffset: Long

  57. def groupBy[K](f: (MessageAndOffset) ⇒ K): Map[K, Iterable[MessageAndOffset]]

    definition classes: TraversableLike
  58. def grouped(size: Int): Iterator[Iterable[MessageAndOffset]]

    definition classes: IterableLike
  59. def hasDefiniteSize: Boolean

    definition classes: TraversableLike → TraversableOnce
  60. 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: ByteBufferMessageSet → AnyRef → Any
  61. def head: MessageAndOffset

    definition classes: IterableLike → TraversableLike
  62. def headOption: Option[MessageAndOffset]

    definition classes: TraversableLike
  63. def info(msg: ⇒ String, e: ⇒ Throwable): Unit

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

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

    definition classes: Logging
  66. def init: Iterable[MessageAndOffset]

    definition classes: TraversableLike
  67. def isEmpty: Boolean

    definition classes: IterableLike → TraversableLike → TraversableOnce
  68. 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
  69. def isTraversableAgain: Boolean

    attributes: final
    definition classes: TraversableLike → TraversableOnce
  70. def iterator: Iterator[MessageAndOffset]

    default iterator that iterates over decompressed messages

    default iterator that iterates over decompressed messages

    definition classes: ByteBufferMessageSetMessageSet → IterableLike
  71. def last: MessageAndOffset

    definition classes: TraversableLike
  72. def lastOption: Option[MessageAndOffset]

    definition classes: TraversableLike
  73. var logIdent: String

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

    definition classes: Logging
  75. val loggerName: String

    definition classes: Logging
  76. def map[B, That](f: (MessageAndOffset) ⇒ B)(implicit bf: CanBuildFrom[Iterable[MessageAndOffset], B, That]): That

    definition classes: TraversableLike → FilterMonadic
  77. def max[B >: MessageAndOffset](implicit cmp: Ordering[B]): MessageAndOffset

    definition classes: TraversableOnce
  78. def min[B >: MessageAndOffset](implicit cmp: Ordering[B]): MessageAndOffset

    definition classes: TraversableOnce
  79. def mkString: String

    definition classes: TraversableOnce
  80. def mkString(sep: String): String

    definition classes: TraversableOnce
  81. def mkString(start: String, sep: String, end: String): String

    definition classes: TraversableOnce
  82. 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
  83. def newBuilder: Builder[MessageAndOffset, Iterable[MessageAndOffset]]

    attributes: protected[this]
    definition classes: GenericTraversableTemplate → HasNewBuilder
  84. def nonEmpty: Boolean

    definition classes: TraversableOnce
  85. 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
  86. 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
  87. def partition(p: (MessageAndOffset) ⇒ Boolean): (Iterable[MessageAndOffset], Iterable[MessageAndOffset])

    definition classes: TraversableLike
  88. def product[B >: MessageAndOffset](implicit num: Numeric[B]): B

    definition classes: TraversableOnce
  89. def projection: IterableView[MessageAndOffset, Iterable[MessageAndOffset]]

    definition classes: IterableLike
      deprecated:
    1. use view' instead

  90. def reduceLeft[B >: MessageAndOffset](op: (B, MessageAndOffset) ⇒ B): B

    definition classes: TraversableOnce
  91. def reduceLeftOption[B >: MessageAndOffset](op: (B, MessageAndOffset) ⇒ B): Option[B]

    definition classes: TraversableOnce
  92. def reduceRight[B >: MessageAndOffset](op: (MessageAndOffset, B) ⇒ B): B

    definition classes: IterableLike → TraversableOnce
  93. def reduceRightOption[B >: MessageAndOffset](op: (MessageAndOffset, B) ⇒ B): Option[B]

    definition classes: TraversableOnce
  94. def repr: Iterable[MessageAndOffset]

    definition classes: TraversableLike
  95. def reversed: List[MessageAndOffset]

    attributes: protected[this]
    definition classes: TraversableOnce
  96. def sameElements[B >: MessageAndOffset](that: Iterable[B]): Boolean

    definition classes: IterableLike
  97. def scanLeft[B, That](z: B)(op: (B, MessageAndOffset) ⇒ B)(implicit bf: CanBuildFrom[Iterable[MessageAndOffset], B, That]): That

    definition classes: TraversableLike
  98. def scanRight[B, That](z: B)(op: (MessageAndOffset, B) ⇒ B)(implicit bf: CanBuildFrom[Iterable[MessageAndOffset], B, That]): That

    definition classes: TraversableLike
  99. def serialized(): ByteBuffer

  100. def shallowIterator: Iterator[MessageAndOffset]

    iterator over compressed messages without decompressing

    iterator over compressed messages without decompressing

  101. def size: Int

    definition classes: TraversableOnce
  102. def sizeInBytes: Long

    Gives the total size of this message set in bytes

    Gives the total size of this message set in bytes

    definition classes: ByteBufferMessageSetMessageSet
  103. def slice(from: Int, until: Int): Iterable[MessageAndOffset]

    definition classes: IterableLike → TraversableLike
  104. def sliding[B >: MessageAndOffset](size: Int, step: Int): Iterator[Iterable[MessageAndOffset]]

    definition classes: IterableLike
  105. def sliding[B >: MessageAndOffset](size: Int): Iterator[Iterable[MessageAndOffset]]

    definition classes: IterableLike
  106. def span(p: (MessageAndOffset) ⇒ Boolean): (Iterable[MessageAndOffset], Iterable[MessageAndOffset])

    definition classes: TraversableLike
  107. def splitAt(n: Int): (Iterable[MessageAndOffset], Iterable[MessageAndOffset])

    definition classes: TraversableLike
  108. def stringPrefix: String

    definition classes: TraversableLike
  109. def sum[B >: MessageAndOffset](implicit num: Numeric[B]): B

    definition classes: TraversableOnce
  110. def synchronized[T0](arg0: T0): T0

    attributes: final
    definition classes: AnyRef
  111. def tail: Iterable[MessageAndOffset]

    definition classes: TraversableLike
  112. def take(n: Int): Iterable[MessageAndOffset]

    definition classes: IterableLike → TraversableLike
  113. def takeRight(n: Int): Iterable[MessageAndOffset]

    definition classes: IterableLike
  114. def takeWhile(p: (MessageAndOffset) ⇒ Boolean): Iterable[MessageAndOffset]

    definition classes: IterableLike → TraversableLike
  115. def thisCollection: Iterable[MessageAndOffset]

    attributes: protected[this]
    definition classes: IterableLike → TraversableLike
  116. def toArray[B >: MessageAndOffset](implicit arg0: ClassManifest[B]): Array[B]

    definition classes: TraversableOnce
  117. def toBuffer[B >: MessageAndOffset]: Buffer[B]

    definition classes: TraversableOnce
  118. def toCollection(repr: Iterable[MessageAndOffset]): Iterable[MessageAndOffset]

    attributes: protected[this]
    definition classes: IterableLike → TraversableLike
  119. def toIndexedSeq[B >: MessageAndOffset]: IndexedSeq[B]

    definition classes: TraversableOnce
  120. def toIterable: Iterable[MessageAndOffset]

    definition classes: IterableLike → TraversableOnce
  121. def toIterator: Iterator[MessageAndOffset]

    definition classes: TraversableLike → TraversableOnce
  122. def toList: List[MessageAndOffset]

    definition classes: TraversableOnce
  123. def toMap[T, U](implicit ev: <:<[MessageAndOffset, (T, U)]): Map[T, U]

    definition classes: TraversableOnce
  124. def toSeq: Seq[MessageAndOffset]

    definition classes: IterableLike → TraversableOnce
  125. def toSet[B >: MessageAndOffset]: Set[B]

    definition classes: TraversableOnce
  126. def toStream: Stream[MessageAndOffset]

    definition classes: IterableLike → TraversableLike → TraversableOnce
  127. 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: ByteBufferMessageSet → TraversableLike → AnyRef → Any
  128. def toTraversable: Traversable[MessageAndOffset]

    definition classes: TraversableLike → TraversableOnce
  129. def trace(msg: ⇒ String, e: ⇒ Throwable): Unit

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

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

    definition classes: Logging
  132. def transpose[B](implicit asTraversable: (MessageAndOffset) ⇒ Traversable[B]): Iterable[Iterable[B]]

    definition classes: GenericTraversableTemplate
  133. def unzip[A1, A2](implicit asPair: (MessageAndOffset) ⇒ (A1, A2)): (Iterable[A1], Iterable[A2])

    definition classes: GenericTraversableTemplate
  134. def validBytes: Long

  135. def validate(): Unit

    Validate the checksum of all the messages in the set.

    Validate the checksum of all the messages in the set. Throws an InvalidMessageException if the checksum doesn't match the payload for any message.

    definition classes: MessageSet
  136. def verifyMessageSize(maxMessageSize: Int): Unit

  137. def view(from: Int, until: Int): IterableView[MessageAndOffset, Iterable[MessageAndOffset]]

    definition classes: IterableLike → TraversableLike
  138. def view: IterableView[MessageAndOffset, Iterable[MessageAndOffset]]

    definition classes: IterableLike → TraversableLike
  139. def wait(): Unit

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

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

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

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

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

    definition classes: Logging
  145. def withFilter(p: (MessageAndOffset) ⇒ Boolean): FilterMonadic[MessageAndOffset, Iterable[MessageAndOffset]]

    definition classes: TraversableLike → FilterMonadic
  146. def writeTo(channel: GatheringByteChannel, offset: Long, size: Long): Long

    Write the messages in this set to the given channel

    Write the messages in this set to the given channel

    definition classes: ByteBufferMessageSetMessageSet
  147. def zip[A1 >: MessageAndOffset, B, That](that: Iterable[B])(implicit bf: CanBuildFrom[Iterable[MessageAndOffset], (A1, B), That]): That

    definition classes: IterableLike
  148. def zipAll[B, A1 >: MessageAndOffset, That](that: Iterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[Iterable[MessageAndOffset], (A1, B), That]): That

    definition classes: IterableLike
  149. def zipWithIndex[A1 >: MessageAndOffset, That](implicit bf: CanBuildFrom[Iterable[MessageAndOffset], (A1, Int), That]): That

    definition classes: IterableLike