Class

monix.reactive.OverflowStrategy

DropNewAndSignal

Related Doc: package OverflowStrategy

Permalink

final case class DropNewAndSignal[A](bufferSize: Int, onOverflow: (Long) ⇒ Option[A]) extends Evicted[A] with Product with Serializable

A OverflowStrategy specifying that on reaching the maximum size, the pipeline should begin dropping incoming events until the buffer has room in it again and is free to process more elements.

The given onOverflow function get be used for logging the event and for sending a message to the downstream consumers to inform them of dropped messages. The function can return None in which case no message is sent and thus you can use it just to log a warning.

bufferSize

specifies how many events our buffer can hold before overflowing.

onOverflow

is a function that can get called on overflow with a number of messages that were dropped, a function that builds a new message that will be sent to downstream. If it returns None, then no message gets sent to downstream.

Source
OverflowStrategy.scala
Linear Supertypes
Product, Equals, Evicted[A], Synchronous[A], OverflowStrategy[A], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DropNewAndSignal
  2. Product
  3. Equals
  4. Evicted
  5. Synchronous
  6. OverflowStrategy
  7. Serializable
  8. Serializable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DropNewAndSignal(bufferSize: Int, onOverflow: (Long) ⇒ Option[A])

    Permalink

    bufferSize

    specifies how many events our buffer can hold before overflowing.

    onOverflow

    is a function that can get called on overflow with a number of messages that were dropped, a function that builds a new message that will be sent to downstream. If it returns None, then no message gets sent to downstream.

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. val bufferSize: Int

    Permalink

    specifies how many events our buffer can hold before overflowing.

  6. def clone(): AnyRef

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. val isEvicted: Boolean

    Permalink
    Definition Classes
    EvictedOverflowStrategy
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. val isSynchronous: Boolean

    Permalink
    Definition Classes
    SynchronousOverflowStrategy
  13. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  16. val onOverflow: (Long) ⇒ Option[A]

    Permalink

    is a function that can get called on overflow with a number of messages that were dropped, a function that builds a new message that will be sent to downstream.

    is a function that can get called on overflow with a number of messages that were dropped, a function that builds a new message that will be sent to downstream. If it returns None, then no message gets sent to downstream.

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Product

Inherited from Equals

Inherited from Evicted[A]

Inherited from Synchronous[A]

Inherited from OverflowStrategy[A]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped