t

akka.serialization

ByteBufferSerializer

trait ByteBufferSerializer extends AnyRef

Serializer between an object and a ByteBuffer representing that object.

Implementations should typically extend SerializerWithStringManifest and in addition to the ByteBuffer based toBinary and fromBinary methods also implement the array based toBinary and fromBinary methods. The array based methods will be used when ByteBuffer is not used, e.g. in Akka Persistence.

Note that the array based methods can for example be implemented by delegation like this:

 // you need to know the maximum size in bytes of the serialized messages
 val pool = new akka.io.DirectByteBufferPool(defaultBufferSize = 1024 * 1024, maxPoolEntries = 10)


// Implement this method for compatibility with `SerializerWithStringManifest`.
override def toBinary(o: AnyRef): Array[Byte] = {
  val buf = pool.acquire()
  try {
    toBinary(o, buf)
    buf.flip()
    val bytes = Array.ofDim[Byte](buf.remaining)
    buf.get(bytes)
    bytes
  } finally {
    pool.release(buf)
  }
}

// Implement this method for compatibility with `SerializerWithStringManifest`.
override def fromBinary(bytes: Array[Byte], manifest: String): AnyRef =
  fromBinary(ByteBuffer.wrap(bytes), manifest)
Source
Serializer.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
ByteStringSerializer, IntSerializer, LongSerializer, StringSerializer, ByteArraySerializer, DisabledJavaSerializer
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ByteBufferSerializer
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def fromBinary(buf: ByteBuffer, manifest: String): AnyRef

    Produces an object from a ByteBuffer, with an optional type-hint; the class should be loaded using ActorSystem.dynamicAccess.

  2. abstract def toBinary(o: AnyRef, buf: ByteBuffer): Unit

    Serializes the given object into the ByteBuffer.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ByteBufferSerializer to any2stringadd[ByteBufferSerializer] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ByteBufferSerializer, B)
    Implicit
    This member is added by an implicit conversion from ByteBufferSerializer to ArrowAssoc[ByteBufferSerializer] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (ByteBufferSerializer) ⇒ Boolean, msg: ⇒ Any): ByteBufferSerializer
    Implicit
    This member is added by an implicit conversion from ByteBufferSerializer to Ensuring[ByteBufferSerializer] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ByteBufferSerializer) ⇒ Boolean): ByteBufferSerializer
    Implicit
    This member is added by an implicit conversion from ByteBufferSerializer to Ensuring[ByteBufferSerializer] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): ByteBufferSerializer
    Implicit
    This member is added by an implicit conversion from ByteBufferSerializer to Ensuring[ByteBufferSerializer] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ByteBufferSerializer
    Implicit
    This member is added by an implicit conversion from ByteBufferSerializer to Ensuring[ByteBufferSerializer] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ByteBufferSerializer to StringFormat[ByteBufferSerializer] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def →[B](y: B): (ByteBufferSerializer, B)
    Implicit
    This member is added by an implicit conversion from ByteBufferSerializer to ArrowAssoc[ByteBufferSerializer] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ByteBufferSerializer to any2stringadd[ByteBufferSerializer]

Inherited by implicit conversion StringFormat from ByteBufferSerializer to StringFormat[ByteBufferSerializer]

Inherited by implicit conversion Ensuring from ByteBufferSerializer to Ensuring[ByteBufferSerializer]

Inherited by implicit conversion ArrowAssoc from ByteBufferSerializer to ArrowAssoc[ByteBufferSerializer]

Ungrouped