Class/Object

zio.stm

THub

Related Docs: object THub | package stm

Permalink

abstract class THub[A] extends TEnqueue[A]

A THub is a transactional message hub. Publishers can publish messages to the hub and subscribers can subscribe to take messages from the hub.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. THub
  2. TEnqueue
  3. Serializable
  4. Serializable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new THub()

    Permalink

Abstract Value Members

  1. abstract def capacity: Int

    Permalink

    The maximum capacity of the queue.

    The maximum capacity of the queue.

    Definition Classes
    TEnqueue
  2. abstract def isShutdown: USTM[Boolean]

    Permalink

    Checks whether the queue is shut down.

    Checks whether the queue is shut down.

    Definition Classes
    TEnqueue
  3. abstract def publish(a: A): USTM[Boolean]

    Permalink

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

  4. abstract def publishAll(as: Iterable[A]): USTM[Boolean]

    Permalink

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

  5. abstract def shutdown: USTM[Unit]

    Permalink

    Shuts down the queue.

    Shuts down the queue.

    Definition Classes
    TEnqueue
  6. abstract def size: USTM[Int]

    Permalink

    The current number of values in the queue.

    The current number of values in the queue.

    Definition Classes
    TEnqueue
  7. abstract def subscribe: USTM[TDequeue[A]]

    Permalink

    Subscribes to receive messages from the hub.

    Subscribes to receive messages from the hub. The resulting subscription can be evaluated multiple times to take a message from the hub each time. The caller is responsible for unsubscribing from the hub by shutting down the queue.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. final def awaitShutdown: USTM[Unit]

    Permalink

    Waits for the hub to be shut down.

    Waits for the hub to be shut down.

    Definition Classes
    THubTEnqueue
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isEmpty: USTM[Boolean]

    Permalink

    Checks if the queue is empty.

    Checks if the queue is empty.

    Definition Classes
    THubTEnqueue
  13. final def isFull: USTM[Boolean]

    Permalink

    Checks if the queue is at capacity.

    Checks if the queue is at capacity.

    Definition Classes
    THubTEnqueue
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def offer(a: A): USTM[Boolean]

    Permalink

    Offers a value to the queue, returning whether the value was offered to the queue.

    Offers a value to the queue, returning whether the value was offered to the queue.

    Definition Classes
    THubTEnqueue
  19. final def offerAll(as: Iterable[A]): USTM[Boolean]

    Permalink

    Offers all of the specified values to the queue, returning whether they were offered to the queue.

    Offers all of the specified values to the queue, returning whether they were offered to the queue.

    Definition Classes
    THubTEnqueue
  20. final def subscribeScoped(implicit trace: Trace): ZIO[Scope, Nothing, TDequeue[A]]

    Permalink

    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 to take a message from the hub each time.

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

    Permalink
    Definition Classes
    AnyRef
  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from TEnqueue[A]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped