org.http4s.blaze.pipeline

Head

sealed trait Head[O] extends Stage

Linear Supertypes
Stage, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Head
  2. Stage
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def name: String

    Definition Classes
    Stage
  2. abstract 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.

  3. abstract 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.

Concrete 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 clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def findInboundStage[C <: Stage](clazz: Class[C]): Option[C]

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

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

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

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

    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  15. 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
    HeadStage
  16. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  17. final val logger: Logger

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

    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

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

    Receives outbound commands Override to capture commands.

  22. final def replaceNext(stage: LeafBuilder[O], startup: Boolean): Tail[O]

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

  23. final def sendInboundCommand(cmd: InboundCommand): Unit

    Send a command to the next inbound Stage of the pipeline

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

    Insert the MidStage after this

  25. 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
  26. 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
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  28. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. 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.

Inherited from Stage

Inherited from AnyRef

Inherited from Any

Ungrouped