ConcurrentChannel

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. def apply[F[_]](implicit F: Concurrent[F]): ApplyBuilders[F]

   

   Builds an ConcurrentQueue value for F data types that implement the Concurrent type class.

   Builds an ConcurrentQueue value for F data types that implement the Concurrent type class.

   This builder uses the Partially-Applied Type technique.

5. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

6. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

7. final def eq(arg0: AnyRef): Boolean

   

   Definition Classes

   AnyRef

8. def equals(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

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

11. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

12. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

13. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

14. final def notify(): Unit

    

    Definition Classes

    AnyRef

15. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

16. def of[F[_], E, A](implicit F: Concurrent[F], cs: ContextShift[F]): F[ConcurrentChannel[F, E, A]]

    

    Builds a multi-producer channel.

    Builds a multi-producer channel.

    This is the safe constructor.

    F

    is a cats.effect.Concurrent type class restriction; this queue is built to work with Concurrent data types

    cs

    is a ContextShift, needed for triggering async boundaries for fairness reasons, in case there's a need to back-pressure on the internal buffer

    See also

    withConfig for fine tuning for the created channel.

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

    

    Definition Classes

    AnyRef

18. def toString(): String

    

    Definition Classes

    AnyRef → Any

19. def unsafe[F[_], E, A](defaultConsumerConfig: Config = ConsumerF.Config.default, producerType: ProducerSide = MultiProducer)(implicit F: Concurrent[F], cs: ContextShift[F]): ConcurrentChannel[F, E, A]

    

    The unsafe version of the ConcurrentChannel.withConfig builder.

    The unsafe version of the ConcurrentChannel.withConfig builder.

    UNSAFE PROTOCOL: This is unsafe due to problems that can happen via selecting the wrong ChannelType, so use with care.

    UNSAFE BECAUSE IMPURE: this builder violates referential transparency, as the queue keeps internal, shared state. Only use when you know what you're doing, otherwise prefer ConcurrentChannel.withConfig.

    defaultConsumerConfig

    is the default consumer configuration, for when using ConcurrentChannel.consume, see the documentation of ConsumerF.Config for details

    producerType

    (UNSAFE) specifies the concurrency scenario for the producer's side, for fine tuning that can lead to performance gains; the safe choice is MultiProducer and if in doubt, use it

    F

    is a cats.effect.Concurrent type class restriction; this queue is built to work with Concurrent data types

    cs

    is a ContextShift, needed for triggering async boundaries for fairness reasons, in case there's a need to back-pressure on the internal buffer

    Annotations

    @UnsafeProtocol() @UnsafeBecauseImpure()

20. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

21. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

22. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

23. def withConfig[F[_], E, A](defaultConsumerConfig: Config = ConsumerF.Config.default, producerType: ProducerSide = MultiProducer)(implicit F: Concurrent[F], cs: ContextShift[F]): F[ConcurrentChannel[F, E, A]]

    

    Builds an ConcurrentChannel with fined tuned config parameters.

    Builds an ConcurrentChannel with fined tuned config parameters.

    UNSAFE PROTOCOL: This is unsafe due to problems that can happen via selecting the wrong ChannelType.ProducerSide, so use with care.

    defaultConsumerConfig

    is the default consumer configuration, for when using ConcurrentChannel.consume, see the documentation of ConsumerF.Config for details

    producerType

    (UNSAFE) specifies the concurrency scenario for the producer's side, for fine tuning that can lead to performance gains; the safe choice is MultiProducer and if in doubt, use it

    F

    is a cats.effect.Concurrent type class restriction; this queue is built to work with Concurrent data types

    cs

    is a ContextShift, needed for triggering async boundaries for fairness reasons, in case there's a need to back-pressure on the internal buffer

    Annotations

    @UnsafeProtocol()