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.
- Alphabetic
- By Inheritance
- THub
- TEnqueue
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new THub()
Abstract Value Members
-
abstract
def
capacity: Int
The maximum capacity of the queue.
The maximum capacity of the queue.
- Definition Classes
- TEnqueue
-
abstract
def
isShutdown: USTM[Boolean]
Checks whether the queue is shut down.
Checks whether the queue is shut down.
- Definition Classes
- TEnqueue
-
abstract
def
publish(a: A): USTM[Boolean]
Publishes a message to the hub, returning whether the message was published to the hub.
-
abstract
def
publishAll(as: Iterable[A]): USTM[Boolean]
Publishes all of the specified messages to the hub, returning whether they were published to the hub.
-
abstract
def
shutdown: USTM[Unit]
Shuts down the queue.
Shuts down the queue.
- Definition Classes
- TEnqueue
-
abstract
def
size: USTM[Int]
The current number of values in the queue.
The current number of values in the queue.
- Definition Classes
- TEnqueue
-
abstract
def
subscribe: USTM[TDequeue[A]]
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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
final
def
awaitShutdown: USTM[Unit]
Waits for the hub to be shut down.
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isEmpty: USTM[Boolean]
Checks if the queue is empty.
-
final
def
isFull: USTM[Boolean]
Checks if the queue is at capacity.
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
offer(a: A): USTM[Boolean]
Offers a value to the queue, returning whether the value was offered to the queue.
-
final
def
offerAll(as: Iterable[A]): USTM[Boolean]
Offers all of the specified values to the queue, returning whether they were offered to the queue.
-
final
def
subscribeScoped(implicit trace: Trace): ZIO[Scope, Nothing, TDequeue[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 to take a message from the hub each time.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()