abstract class Hub[F[+_], A] extends Enqueue[F, A] with Serializable

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

Linear Supertypes
Enqueue[F, A], Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Hub
  2. Enqueue
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Hub()

Abstract Value Members

  1. abstract def awaitShutdown(implicit trace: Trace): F[Unit]

    Definition Classes
    Enqueue
    See also

    Enqueue.awaitShutdown

  2. abstract def capacity: Int

    Definition Classes
    Enqueue
    See also

    Enqueue.capacity

  3. abstract def isEmpty(implicit trace: Trace): F[Boolean]

    Definition Classes
    Enqueue
    See also

    Enqueue.isEmpty

  4. abstract def isFull(implicit trace: Trace): F[Boolean]

    Definition Classes
    Enqueue
    See also

    Enqueue.isFull

  5. abstract def isShutdown(implicit trace: Trace): F[Boolean]

    Checks whether the hub is shut down.

    Checks whether the hub is shut down.

    Definition Classes
    Hub → Enqueue
  6. abstract def offer(a: A)(implicit trace: Trace): F[Boolean]

    Definition Classes
    Enqueue
    See also

    Enqueue.offer

  7. abstract def offerAll(as: Iterable[A])(implicit trace: Trace): F[Boolean]

    Definition Classes
    Enqueue
    See also

    Enqueue.offerAll

  8. abstract def publish(a: A)(implicit trace: Trace): F[Boolean]

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

  9. abstract def publishAll(as: Iterable[A])(implicit trace: Trace): F[Boolean]

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

  10. abstract def shutdown(implicit trace: Trace): F[Unit]

    Definition Classes
    Enqueue
    See also

    Enqueue.shutdown

  11. abstract def size(implicit trace: Trace): F[Int]

    Definition Classes
    Enqueue
    See also

    Enqueue.size

  12. abstract def subscribe(implicit trace: Trace): Resource[F, Dequeue[F, A]]

    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.

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 Enqueue[F, A]

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped