ByteBufferSerializer

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 = new Array[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

ByteArraySerializer, DisabledJavaSerializer

Type Hierarchy

Abstract Value Members

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.
Produces an object from a ByteBuffer, with an optional type-hint; the class should be loaded using ActorSystem.dynamicAccess.

Annotations
@throws( classOf[NotSerializableException] )
abstract def toBinary(o: AnyRef, buf: ByteBuffer): Unit

Serializes the given object into the ByteBuffer.

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from ByteBufferSerializer to any2stringadd[ByteBufferSerializer] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (ByteBufferSerializer, B)

Implicit information
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()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def ensuring(cond: (ByteBufferSerializer) ⇒ Boolean, msg: ⇒ Any): ByteBufferSerializer

Implicit information
This member is added by an implicit conversion from ByteBufferSerializer to Ensuring[ByteBufferSerializer] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (ByteBufferSerializer) ⇒ Boolean): ByteBufferSerializer

Implicit information
This member is added by an implicit conversion from ByteBufferSerializer to Ensuring[ByteBufferSerializer] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): ByteBufferSerializer

Implicit information
This member is added by an implicit conversion from ByteBufferSerializer to Ensuring[ByteBufferSerializer] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): ByteBufferSerializer

Implicit information
This member is added by an implicit conversion from ByteBufferSerializer to Ensuring[ByteBufferSerializer] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit information
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()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (ByteBufferSerializer, B)

Implicit information
This member is added by an implicit conversion from ByteBufferSerializer to ArrowAssoc[ByteBufferSerializer] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Related Doc: package serialization

trait ByteBufferSerializer extends AnyRef

Abstract Value Members

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

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

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (ByteBufferSerializer, B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def ensuring(cond: (ByteBufferSerializer) ⇒ Boolean, msg: ⇒ Any): ByteBufferSerializer

def ensuring(cond: (ByteBufferSerializer) ⇒ Boolean): ByteBufferSerializer

def ensuring(cond: Boolean, msg: ⇒ Any): ByteBufferSerializer

def ensuring(cond: Boolean): ByteBufferSerializer

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (ByteBufferSerializer, B)

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