Class

org.http4s.blaze.pipeline.stages

QuietTimeoutStage

Related Doc: package stages

Permalink

class QuietTimeoutStage[T] extends TimeoutStageBase[T]

Shut down the pipeline after a period of inactivity

Linear Supertypes
TimeoutStageBase[T], MidStage[T, T], Head[T], Tail[T], Stage, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. QuietTimeoutStage
  2. TimeoutStageBase
  3. MidStage
  4. Head
  5. Tail
  6. Stage
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new QuietTimeoutStage(timeout: Duration, exec: TickWheelExecutor = scheduler)

    Permalink

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. final def cancelTimeout(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    TimeoutStageBase
  6. def channelRead(size: Int = 1, timeout: Duration = Duration.Inf): Future[T]

    Permalink
    Definition Classes
    Tail
  7. final def channelWrite(data: Seq[T], timeout: Duration): Future[Unit]

    Permalink

    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
  8. def channelWrite(data: Seq[T]): Future[Unit]

    Permalink

    Write a collection of outbound messages to the pipeline

    Write a collection of outbound messages to the pipeline

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

    Permalink

    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
  10. def channelWrite(data: T): Future[Unit]

    Permalink

    Write a single outbound message to the pipeline

    Write a single outbound message to the pipeline

    Definition Classes
    Tail
  11. def clone(): AnyRef

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

    Permalink
    Definition Classes
    TailStage
  13. final def eq(arg0: AnyRef): Boolean

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

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

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

    Permalink

    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]

    Permalink

    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]

    Permalink

    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]

    Permalink

    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[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  22. 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
  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  24. final val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Stage
  25. def name: String

    Permalink
    Definition Classes
    TimeoutStageBaseStage
  26. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  29. def readRequest(size: Int): Future[T]

    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.

    Definition Classes
    QuietTimeoutStageTimeoutStageBaseHead
  30. final def removeStage()(implicit ev: =:=[MidStage[T, T], MidStage[T, T]]): Unit

    Permalink

    Remove this MidStage from the pipeline

    Remove this MidStage from the pipeline

    Definition Classes
    MidStage
  31. final def replaceInline(stage: MidStage[T, T]): QuietTimeoutStage.this.type

    Permalink

    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
  32. final def replaceNext(stage: LeafBuilder[T], startup: Boolean): Tail[T]

    Permalink

    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
  33. final def replaceTail(leafBuilder: LeafBuilder[T], startup: Boolean): QuietTimeoutStage.this.type

    Permalink

    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
  34. final def resetTimeout(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    TimeoutStageBase
  35. final def sendInboundCommand(cmd: InboundCommand): Unit

    Permalink

    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
  36. final def setAndCancel(next: Cancelable): Unit

    Permalink
    Definition Classes
    TimeoutStageBase
    Annotations
    @tailrec()
  37. final def spliceAfter(stage: MidStage[T, T]): Unit

    Permalink

    Insert the MidStage after this

    Insert the MidStage after this

    Definition Classes
    Head
  38. final def spliceBefore(stage: MidStage[T, T]): Unit

    Permalink

    Insert the MidStage before this Stage

    Insert the MidStage before this Stage

    Definition Classes
    Tail
  39. 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
    TimeoutStageBaseStage
  40. 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
    QuietTimeoutStageStage
  41. final def startTimeout(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    TimeoutStageBase
  42. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. def writeRequest(data: T): 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.

    Definition Classes
    QuietTimeoutStageTimeoutStageBaseHead
  48. def writeRequest(data: Seq[T]): 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.

    Definition Classes
    QuietTimeoutStageTimeoutStageBaseHead

Inherited from TimeoutStageBase[T]

Inherited from MidStage[T, T]

Inherited from Head[T]

Inherited from Tail[T]

Inherited from Stage

Inherited from AnyRef

Inherited from Any

Ungrouped