org.http4s.blaze.pipeline.stages

SerializingStage

final class SerializingStage[I] extends PassThrough[I] with Serializer[I]

Linear Supertypes
Serializer[I], ReadSerializer[I], WriteSerializer[I], TailStage[I], PassThrough[I], MidStage[I, I], Head[I], Tail[I], Stage, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SerializingStage
  2. Serializer
  3. ReadSerializer
  4. WriteSerializer
  5. TailStage
  6. PassThrough
  7. MidStage
  8. Head
  9. Tail
  10. Stage
  11. AnyRef
  12. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SerializingStage(name: String = "SerializingStage", maxReadQueue: Int = 0, maxWriteQueue: Int = 0)

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

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

    Definition Classes
    ReadSerializer → Tail

  8. def channelWrite(data: Seq[I]): Future[Unit]

    Write a collection of outbound messages to the pipeline

    Write a collection of outbound messages to the pipeline

    Definition Classes
    WriteSerializer → Tail

  9. def channelWrite(data: I): Future[Unit]

    Write a single outbound message to the pipeline

    Write a single outbound message to the pipeline

    Definition Classes
    WriteSerializer → Tail

  10. final def channelWrite(data: Seq[I], 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

  11. final def channelWrite(data: I, 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

  12. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. 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

  17. 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

  18. 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

  19. 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

  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  21. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  22. 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

  23. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  24. final val logger: Logger

    Attributes
    protected
    Definition Classes
    Stage

  25. val maxReadQueue: Int

    Definition Classes
    SerializingStage → ReadSerializer

  26. val maxWriteQueue: Int

    Definition Classes
    SerializingStage → WriteSerializer

  27. val name: String

    Definition Classes
    SerializingStage → Stage

  28. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  29. final def notify(): Unit

    Definition Classes
    AnyRef

  30. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  31. def outboundCommand(cmd: OutboundCommand): Unit

    Receives outbound commands Override to capture commands.

    Receives outbound commands Override to capture commands.

    Definition Classes
    MidStage → Head

  32. def readRequest(size: Int): Future[I]

    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
    PassThrough → Head

  33. final def removeStage(implicit ev: =:=[MidStage[I, I], MidStage[I, I]]): Unit

    Remove this MidStage from the pipeline

    Remove this MidStage from the pipeline

    Definition Classes
    MidStage

  34. final def replaceInline(stage: MidStage[I, I]): SerializingStage.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

  35. final def replaceNext(stage: LeafBuilder[I], startup: Boolean): Tail[I]

    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

  36. final def replaceTail(leafBuilder: LeafBuilder[I], startup: Boolean): SerializingStage.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

  37. 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

  38. final def sendOutboundCommand(cmd: OutboundCommand): Unit

    Send a command to the next outbound Stage of the pipeline

    Send a command to the next outbound Stage of the pipeline

    Definition Classes
    Tail

  39. final def spliceAfter(stage: MidStage[I, I]): Unit

    Insert the MidStage after this

    Insert the MidStage after this

    Definition Classes
    Head

  40. final def spliceBefore(stage: MidStage[I, I]): Unit

    Insert the MidStage before this Stage

    Insert the MidStage before this Stage

    Definition Classes
    Tail

  41. 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

  42. 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

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

    Definition Classes
    AnyRef

  44. def toString(): String

    Definition Classes
    AnyRef → Any

  45. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  47. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  48. def writeRequest(data: Seq[I]): 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
    PassThrough → Head

  49. def writeRequest(data: I): 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
    PassThrough → Head

Inherited from Serializer[I]

Inherited from ReadSerializer[I]

Inherited from WriteSerializer[I]

Inherited from TailStage[I]

Inherited from PassThrough[I]

Inherited from MidStage[I, I]

Inherited from Head[I]

Inherited from Tail[I]

Inherited from Stage

Inherited from AnyRef

Inherited from Any

Ungrouped