Packages

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

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Config
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val capacity: Option[BufferCapacity]
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. val consumerType: Option[ConsumerSide]
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. val padding: Option[PaddingStrategy]
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped