org.http4s.blaze.pipeline

Head

Related Doc: package pipeline

sealed trait Head[O] extends Stage

Linear Supertypes
Stage, AnyRef, Any
Known Subclasses
BufferingStage, ByteBufferHead, ByteToObjectStage, ChannelHead, CommandTimeoutStage, HeadStage, MidStage, PassThrough, QuietTimeoutStage, SSLStage, SerializingStage, TimeoutStageBase
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]

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

Concrete Value Members

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

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  5. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

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

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

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

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

    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any

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

  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  15. final val logger: Logger

    Attributes
    protected
    Definition Classes
    Stage

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

    Definition Classes
    AnyRef

  17. final def notify(): Unit

    Definition Classes
    AnyRef

  18. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  19. def outboundCommand(cmd: OutboundCommand): Unit

    Receives outbound commands Override to capture commands.

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

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

  22. 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 therefor recommended that the method be idempotent.

    Attributes
    protected
    Definition Classes
    Stage

  23. 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 therefor recommended that the method be idempotent.

    Attributes
    protected
    Definition Classes
    Stage

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

    Definition Classes
    AnyRef

  25. def toString(): String

    Definition Classes
    AnyRef → Any

  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

Inherited from Stage

Inherited from AnyRef

Inherited from Any

Ungrouped