final case class DropNewAndSignal[A](bufferSize: Int, onOverflow: (Long) => Coeval[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
- Alphabetic
- By Inheritance
- DropNewAndSignal
- Product
- Equals
- Evicted
- Synchronous
- OverflowStrategy
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new DropNewAndSignal(bufferSize: Int, onOverflow: (Long) => Coeval[Option[A]])
- 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
- val bufferSize: Int
- Definition Classes
- DropNewAndSignal → Evicted
- val isEvicted: Boolean
- Definition Classes
- Evicted → OverflowStrategy
- val isSynchronous: Boolean
- Definition Classes
- Synchronous → OverflowStrategy
- val onOverflow: (Long) => Coeval[Option[A]]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
This is the API documentation for the Monix library.
Package Overview
monix.execution exposes lower level primitives for dealing with asynchronous execution:
Atomictypes, as alternative tojava.util.concurrent.atomicmonix.catnap exposes pure abstractions built on top of the Cats-Effect type classes:
monix.eval is for dealing with evaluation of results, thus exposing Task and Coeval.
monix.reactive exposes the
Observablepattern:Observableimplementationsmonix.tail exposes Iterant for purely functional pull based streaming:
BatchandBatchCursor, the alternatives to Scala'sIterableandIteratorrespectively that we are using within Iterant's encodingYou can control evaluation with type you choose - be it Task, Coeval, cats.effect.IO or your own as long as you provide correct cats-effect or cats typeclass instance.