final case class Config(capacity: Option[BufferCapacity] = None, consumerType: Option[ConsumerSide] = None, padding: Option[PaddingStrategy] = None) extends Product with Serializable
Custom configuration consumers, used in ChannelF.consumeWithConfig.
- capacity
configures the capacity of the underlying buffer
- consumerType
(UNSAFE) is for fine-tuning the consumer type; if there's only one worker that consumes from the ConsumerF value, then a SingleConsumer configuration is possible, for optimization purposes, otherwise or if in doubt, prefer MultiConsumer
- padding
is the padding strategy used for the atomics meant for back-pressuring on the internal buffer (either waiting on new events on the consumer side, or waiting until the buffer has room for pushing events on the producer side); this is for fine-tuning the configuration, but note that padding adds some bytes to the the memory being consumed, so a "no padding" strategy may be what you want
- Source
- ConsumerF.scala
- Alphabetic
- By Inheritance
- Config
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Config(capacity: Option[BufferCapacity] = None, consumerType: Option[ConsumerSide] = None, padding: Option[PaddingStrategy] = None)
- capacity
configures the capacity of the underlying buffer
- consumerType
(UNSAFE) is for fine-tuning the consumer type; if there's only one worker that consumes from the ConsumerF value, then a SingleConsumer configuration is possible, for optimization purposes, otherwise or if in doubt, prefer MultiConsumer
- padding
is the padding strategy used for the atomics meant for back-pressuring on the internal buffer (either waiting on new events on the consumer side, or waiting until the buffer has room for pushing events on the producer side); this is for fine-tuning the configuration, but note that padding adds some bytes to the the memory being consumed, so a "no padding" strategy may be what you want
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 asInstanceOf[T0]: T0
- Definition Classes
- Any
- val capacity: Option[BufferCapacity]
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val consumerType: Option[ConsumerSide]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val padding: Option[PaddingStrategy]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
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.