sealed abstract class CHub[F[+_], -A, +B] extends Serializable

A CHub[F, A, B] is an asynchronous message hub. Publishers can publish messages of type A to the hub and subscribers can subscribe to take messages of type B from the hub within the context of the effect F.

Linear Supertypes
Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CHub
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def awaitShutdown: F[Unit]

    Waits for the hub to be shut down.

  2. abstract def capacity: Int

    The maximum capacity of the hub.

  3. abstract def contramap[C](f: (C) => A): CHub[F, C, B]

    Transforms messages published to the hub using the specified function.

  4. abstract def contramapM[C](f: (C) => F[A]): CHub[F, C, B]

    Transforms messages published to the hub using the specified effectual function.

  5. abstract def dimap[C, D](f: (C) => A, g: (B) => D): CHub[F, C, D]

    Transforms messages published to and taken from the hub using the specified functions.

  6. abstract def dimapM[C, D](f: (C) => F[A], g: (B) => F[D]): CHub[F, C, D]

    Transforms messages published to and taken from the hub using the specified effectual functions.

  7. abstract def filterInput[A1 <: A](f: (A1) => Boolean): CHub[F, A1, B]

    Filters messages published to the hub using the specified function.

  8. abstract def filterInputM[A1 <: A](f: (A1) => F[Boolean]): CHub[F, A1, B]

    Filters messages published to the hub using the specified effectual function.

  9. abstract def filterOutput(f: (B) => Boolean): CHub[F, A, B]

    Filters messages taken from the hub using the specified function.

  10. abstract def filterOutputM(f: (B) => F[Boolean]): CHub[F, A, B]

    Filters messages taken from the hub using the specified effectual function.

  11. abstract def isShutdown: F[Boolean]

    Checks whether the hub is shut down.

  12. abstract def map[C](f: (B) => C): CHub[F, A, C]

    Transforms messages taken from the hub using the specified function.

  13. abstract def mapM[C](f: (B) => F[C]): CHub[F, A, C]

    Transforms messages taken from the hub using the specified effectual function.

  14. abstract def publish(a: A): F[Boolean]

    Publishes a message to the hub, returning whether the message was published to the hub.

  15. abstract def publishAll(as: Iterable[A]): F[Boolean]

    Publishes all of the specified messages to the hub, returning whether they were published to the hub.

  16. abstract def shutdown: F[Unit]

    Shuts down the hub.

  17. abstract def size: F[Int]

    The current number of messages in the hub.

  18. abstract def subscribe: Resource[F, Dequeue[F, B]]

    Subscribes to receive messages from the hub.

    Subscribes to receive messages from the hub. The resulting subscription can be evaluated multiple times within the scope of the resource to take a message from the hub each time.

  19. abstract def toQueue: Enqueue[F, A]

    Views the hub as a queue that can only be written to.

Concrete 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. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    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. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped