Trait

org.http4s.blaze.pipeline

Head

Related Doc: package pipeline

Permalink

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
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def closePipeline(cause: Option[Throwable]): Unit

    Permalink
    Definition Classes
    Stage
  2. abstract def name: String

    Permalink
    Definition Classes
    Stage
  3. abstract def readRequest(size: Int): Future[O]

    Permalink

    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.

  4. abstract def writeRequest(data: O): Future[Unit]

    Permalink

    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: Any): Boolean

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

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

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

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

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

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

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

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

    Permalink

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

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

    Permalink

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

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

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

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

    Permalink

    Receives inbound commands Override to capture commands.

    Receives inbound commands Override to capture commands.

    cmd

    a command originating from the channel

    Definition Classes
    HeadStage
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. final val logger: Logger

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

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def replaceNext(stage: LeafBuilder[O], startup: Boolean): Tail[O]

    Permalink

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

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

    Permalink

    Send a command to the next inbound Stage of the pipeline

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

    Permalink

    Insert the MidStage after this

  22. def stageShutdown(): Unit

    Permalink

    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
  23. def stageStartup(): Unit

    Permalink

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

    Permalink
    Definition Classes
    AnyRef
  25. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def writeRequest(data: Seq[O]): Future[Unit]

    Permalink

    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