ByteToObjectStage

Abstract Value Members

abstract def bufferToMessage(in: ByteBuffer): Option[O]

Method that decodes ByteBuffers to objects.
Method that decodes ByteBuffers to objects. None reflects not enough data to decode a message Any unused data in the ByteBuffer will be recycled and available for the next read.
WARNING: don't count on the underlying array of the ByteBuffer. This uses the slice method, which could preserve access to the buffer, but mess with the various positions.
in
ByteBuffer of immediately available data
returns
optional message if enough data was available
abstract val maxBufferSize: Int
abstract def messageToBuffer(in: O): Seq[ByteBuffer]

Encode objects to buffers
Encode objects to buffers
in
object to decode
returns
sequence of ByteBuffers to pass to the head
abstract def name: String

Definition Classes
Stage

Concrete Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

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

Definition Classes
Any
def channelRead(size: Int = 1, timeout: Duration = Duration.Inf): Future[ByteBuffer]

Definition Classes
Tail
final def channelWrite(data: Seq[ByteBuffer], timeout: Duration): Future[Unit]

Definition Classes
Tail
def channelWrite(data: Seq[ByteBuffer]): Future[Unit]

Definition Classes
Tail
final def channelWrite(data: ByteBuffer, timeout: Duration): Future[Unit]

Definition Classes
Tail
def channelWrite(data: ByteBuffer): Future[Unit]

Definition Classes
Tail
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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] )
final def findInboundStage[C <: Stage](clazz: Class[C]): Option[C]

Definition Classes
Head
final def findInboundStage(name: String): Option[Stage]

Definition Classes
Head
final def findOutboundStage[C <: Stage](clazz: Class[C]): Option[C]

Definition Classes
Tail
final def findOutboundStage(name: String): Option[Stage]

Definition Classes
Tail
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def inboundCommand(cmd: InboundCommand): Unit

Receives inbound commands Override to capture commands.
Receives inbound commands Override to capture commands.
cmd
a command originating from the channel

Definition Classes
Head → Stage
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final val logger: Logger

Attributes
protected
Definition Classes
Stage
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def outboundCommand(cmd: OutboundCommand): Unit

Receives outbound commands Override to capture commands.
Receives outbound commands Override to capture commands.

Definition Classes
MidStage → Head
def readRequest(size: Int): Future[O]

Definition Classes
ByteToObjectStage → Head
final def removeStage(implicit ev: =:=[MidStage[ByteBuffer, O], MidStage[ByteBuffer, ByteBuffer]]): Unit

Definition Classes
MidStage
final def replaceInline(stage: MidStage[ByteBuffer, O]): ByteToObjectStage.this.type

Definition Classes
MidStage
final def replaceInline(leafBuilder: LeafBuilder[ByteBuffer], startup: Boolean = true): ByteToObjectStage.this.type

Definition Classes
Tail
final def replaceNext(stage: LeafBuilder[O]): Tail[O]

Definition Classes
MidStage
final def sendInboundCommand(cmd: InboundCommand): Unit

Definition Classes
Head
final def sendOutboundCommand(cmd: OutboundCommand): Unit

Definition Classes
Tail
final def spliceAfter(stage: MidStage[O, O]): Unit

Definition Classes
Head
final def spliceBefore(stage: MidStage[ByteBuffer, ByteBuffer]): Unit

Definition Classes
Tail
def stageShutdown(): Unit

Shuts down the stage, deallocating resources, etc.
Shuts down the stage, deallocating resources, etc.
This method will be called when the stages receives a Disconnected command unless the inboundCommand method is overridden. It is not impossible that this will not be called due to failure for other stages to propagate shutdown commands. Conversely, it is also possible for this to be called more than once due to the reception of multiple disconnect commands. It is therefore recommended that the method be idempotent.

Attributes
protected
Definition Classes
Stage
def stageStartup(): Unit

Start the stage, allocating resources etc.
Start the stage, allocating resources etc.
This method should not effect other stages by sending commands etc unless it creates them. It is not impossible that the stage will receive other commands besides Connected before this method is called. It is not impossible for this method to be called multiple times by misbehaving stages. It is therefore recommended that the method be idempotent.

Attributes
protected
Definition Classes
Stage
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 writeRequest(data: O): Future[Unit]

Definition Classes
ByteToObjectStage → Head
def writeRequest(data: Seq[O]): Future[Unit]

A simple default that serializes the write requests into the single element form.
A simple default that serializes the write requests into the single element form. It almost certainly should be overwritten
data
sequence of elements which are to be written
returns
Future which will resolve when pipeline is ready for more data or fails

Definition Classes
ByteToObjectStage → Head

Related Doc: package stages

trait ByteToObjectStage[O] extends MidStage[ByteBuffer, O]

Abstract Value Members

abstract def bufferToMessage(in: ByteBuffer): Option[O]

abstract val maxBufferSize: Int

abstract def messageToBuffer(in: O): Seq[ByteBuffer]

abstract def name: String

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def channelRead(size: Int = 1, timeout: Duration = Duration.Inf): Future[ByteBuffer]

final def channelWrite(data: Seq[ByteBuffer], timeout: Duration): Future[Unit]

def channelWrite(data: Seq[ByteBuffer]): Future[Unit]

final def channelWrite(data: ByteBuffer, timeout: Duration): Future[Unit]

def channelWrite(data: ByteBuffer): Future[Unit]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def findInboundStage[C <: Stage](clazz: Class[C]): Option[C]

final def findInboundStage(name: String): Option[Stage]

final def findOutboundStage[C <: Stage](clazz: Class[C]): Option[C]

final def findOutboundStage(name: String): Option[Stage]

final def getClass(): Class[_]

def hashCode(): Int

def inboundCommand(cmd: InboundCommand): Unit

final def isInstanceOf[T0]: Boolean

final val logger: Logger

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def outboundCommand(cmd: OutboundCommand): Unit

def readRequest(size: Int): Future[O]

final def removeStage(implicit ev: =:=[MidStage[ByteBuffer, O], MidStage[ByteBuffer, ByteBuffer]]): Unit

final def replaceInline(stage: MidStage[ByteBuffer, O]): ByteToObjectStage.this.type

final def replaceInline(leafBuilder: LeafBuilder[ByteBuffer], startup: Boolean = true): ByteToObjectStage.this.type

final def replaceNext(stage: LeafBuilder[O]): Tail[O]

final def sendInboundCommand(cmd: InboundCommand): Unit

final def sendOutboundCommand(cmd: OutboundCommand): Unit

final def spliceAfter(stage: MidStage[O, O]): Unit

final def spliceBefore(stage: MidStage[ByteBuffer, ByteBuffer]): Unit

def stageShutdown(): Unit

def stageStartup(): 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 writeRequest(data: O): Future[Unit]

def writeRequest(data: Seq[O]): Future[Unit]

Inherited from MidStage[ByteBuffer, O]

Inherited from Head[O]

Inherited from Tail[ByteBuffer]

Inherited from Stage

Inherited from AnyRef

Inherited from Any

Ungrouped