object OverflowStrategy extends Serializable
- Source
- OverflowStrategy.scala
- Alphabetic
- By Inheritance
- OverflowStrategy
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
final
case class
BackPressure
(bufferSize: Int) extends OverflowStrategy[Nothing] with Product with Serializable
A OverflowStrategy specifying that on reaching the maximum size, the pipeline should try to apply back-pressure (i.e.
A OverflowStrategy specifying that on reaching the maximum size, the pipeline should try to apply back-pressure (i.e. it should try delaying the data source in producing more elements, until the the consumer has drained the buffer and space is available).
- bufferSize
specifies how many events our buffer can hold before overflowing
-
final
case class
ClearBuffer
(bufferSize: Int) extends Evicted[Nothing] with Product with Serializable
A OverflowStrategy specifying that on reaching the maximum size, the current buffer should be dropped completely to make room for new events.
A OverflowStrategy specifying that on reaching the maximum size, the current buffer should be dropped completely to make room for new events.
- bufferSize
specifies how many events our buffer can hold before overflowing
-
final
case class
ClearBufferAndSignal
[A](bufferSize: Int, onOverflow: (Long) ⇒ Option[A]) extends Evicted[A] with Product with Serializable
A OverflowStrategy specifying that on reaching the maximum size, the current buffer should be dropped completely to make room for new events.
A OverflowStrategy specifying that on reaching the maximum size, the current buffer should be dropped completely to make room for new events.
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 returnNone
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.
-
final
case class
DropNew
(bufferSize: Int) extends Evicted[Nothing] 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.
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.
- bufferSize
specifies how many events our buffer can hold before overflowing
-
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.
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 returnNone
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.
-
final
case class
DropOld
(bufferSize: Int) extends Evicted[Nothing] with Product with Serializable
A OverflowStrategy specifying that on reaching the maximum size, the currently buffered events should start being dropped in a FIFO order, so the oldest events from the buffer will be dropped first.
A OverflowStrategy specifying that on reaching the maximum size, the currently buffered events should start being dropped in a FIFO order, so the oldest events from the buffer will be dropped first.
- bufferSize
specifies how many events our buffer can hold before overflowing
-
final
case class
DropOldAndSignal
[A](bufferSize: Int, onOverflow: (Long) ⇒ Option[A]) extends Evicted[A] with Product with Serializable
A OverflowStrategy specifying that on reaching the maximum size, the currently buffered events should start being dropped in a FIFO order, so the oldest events from the buffer will be dropped first.
A OverflowStrategy specifying that on reaching the maximum size, the currently buffered events should start being dropped in a FIFO order, so the oldest events from the buffer will be dropped first.
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 returnNone
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.
-
sealed abstract
class
Evicted
[A] extends Synchronous[A]
A sub-category of overflow strategies that are synchronous and that represent eviction policies, meaning that on buffer overflows events start being dropped.
-
final
case class
Fail
(bufferSize: Int) extends Synchronous[Nothing] with Product with Serializable
A OverflowStrategy specifying that on reaching the maximum size, the pipeline should cancel the subscription and send an
onError
to the observer(s) downstream.A OverflowStrategy specifying that on reaching the maximum size, the pipeline should cancel the subscription and send an
onError
to the observer(s) downstream.- bufferSize
specifies how many events our buffer can hold before overflowing
-
sealed abstract
class
Synchronous
[+A] extends OverflowStrategy[A]
A category of OverflowStrategy for buffers that can be used synchronously, without worrying about back-pressure concerns.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
Default[A]: OverflowStrategy[A]
The default library-wide overflowStrategy used whenever a default argument value is needed.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
object
Unbounded
extends Synchronous[Nothing] with Product with Serializable
A OverflowStrategy specifying that the buffer is completely unbounded.
A OverflowStrategy specifying that the buffer is completely unbounded. Using this overflowStrategy implies that with a fast data source, the system's memory can be exhausted and the process might blow up on lack of memory.
This is the API documentation for the Monix library.
Package Overview
monix.execution exposes lower level primitives for dealing with asynchronous execution:
Atomic
types, as alternative tojava.util.concurrent.atomic
monix.eval is for dealing with evaluation of results, thus exposing Task and Coeval.
monix.reactive exposes the
Observable
pattern:Observable
implementationsmonix.types implements type-class shims, to be translated to type-classes provided by libraries such as Cats or Scalaz.
monix.cats is the optional integration with the Cats library, providing translations for the types described in
monix.types
.monix.scalaz is the optional integration with the Scalaz library, providing translations for the types described in
monix.types
.