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]

Write a collection of outbound messages to the pipeline with a timeout
Write a collection of outbound messages to the pipeline with a timeout

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

Write a collection of outbound messages to the pipeline
Write a collection of outbound messages to the pipeline

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

Write a single outbound message to the pipeline with a timeout
Write a single outbound message to the pipeline with a timeout

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

Write a single outbound message to the pipeline
Write a single outbound message to the pipeline

Definition Classes
Tail
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def closePipeline(cause: Option[Throwable]): Unit

Definition Classes
Tail → Stage
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]

Find the next inbound Stage of type C, if it exists.
Find the next inbound Stage of type C, if it exists.

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

Find the next outbound Stage with the given name, if it exists.
Find the next outbound Stage with the given name, if it exists.

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

Find the next outbound Stage of type C, if it exists.
Find the next outbound Stage of type C, if it exists.

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

Find the next outbound Stage with the given name, if it exists.
Find the next outbound Stage with the given name, if it exists.

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 readRequest(size: Int): Future[O]

Called by the next inbound Stage to signal interest in reading data.
Called by the next inbound Stage to signal interest in reading data.
size
Hint as to the size of the message intended to be read. May not be meaningful or honored.
returns
Future that will resolve with the requested inbound data, or an error.

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

Remove this MidStage from the pipeline
Remove this MidStage from the pipeline

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

Replace this MidStage with the provided MidStage of the same type
Replace this MidStage with the provided MidStage of the same type

Definition Classes
MidStage
final def replaceNext(stage: LeafBuilder[O], startup: Boolean): Tail[O]

Replace all remaining inbound Stages of the pipeline, not including this Stage.
Replace all remaining inbound Stages of the pipeline, not including this Stage.

Definition Classes
Head
final def replaceTail(leafBuilder: LeafBuilder[ByteBuffer], startup: Boolean): ByteToObjectStage.this.type

Replace all downstream Stages, including this Stage.
Replace all downstream Stages, including this Stage.
If this was a MidStage, its inbound element is notified via a Disconnected Command.

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

Send a command to the next inbound Stage of the pipeline
Send a command to the next inbound Stage of the pipeline

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

Insert the MidStage after this
Insert the MidStage after this

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

Insert the MidStage before this Stage
Insert the MidStage before this Stage

Definition Classes
Tail
def stageShutdown(): Unit

Shuts down the stage, deallocating resources, etc.
Shuts down the stage, deallocating resources, etc.
It will be called when the stage receives a Disconnected command unless inboundCommand is overridden. This method should not send or Disconnected commands.
It is possible that this will not be called due to failure of 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 shutdown 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]

Data that the next inbound Stage wants to send outbound.
Data that the next inbound Stage wants to send outbound.
returns
a Future that resolves when the data has been handled.

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

Collection of data that the next inbound Stage wants to sent outbound.
Collection of data that the next inbound Stage wants to sent outbound.
It is generally assumed that the order of elements has meaning.
returns
a Future that resolves when the data has been handled.

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 closePipeline(cause: Option[Throwable]): Unit

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 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 replaceNext(stage: LeafBuilder[O], startup: Boolean): Tail[O]

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

final def sendInboundCommand(cmd: InboundCommand): 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