TxPubSub18

Constructors

boundedconstCreates a bounded TxPubSub with the specified capacity.droppingconstCreates a dropping TxPubSub with the specified capacity.slidingconstCreates a sliding TxPubSub with the specified capacity.unboundedconstCreates an unbounded TxPubSub with unlimited capacity.

Models

TxPubSubinterfaceA TxPubSub represents a transactional publish/subscribe hub that broadcasts messages to all current subscribers using Software Transactional Memory (STM) semantics.

Guards

isTxPubSubconstChecks whether the given value is a TxPubSub.

Getters

capacityconstReturns the capacity of the TxPubSub.isEmptyconstChecks whether the TxPubSub has no pending messages (all subscriber queues are empty).isFullconstChecks whether any subscriber queue is at capacity.isShutdownconstChecks whether the TxPubSub has been shut down.sizeconstReturns the current number of messages across all subscriber queues (the max).

Mutations

acquireSubscriberconstCreates a subscriber queue and registers it with the pub/sub.awaitShutdownconstWaits for the TxPubSub to be shut down.publishconstPublishes a message to all current subscribers.publishAllconstPublishes all messages from an iterable to all current subscribers.releaseSubscriberconstRemoves a subscriber queue from the pub/sub and shuts it down.shutdownconstShuts down the TxPubSub and all subscriber queues registered at the time of shutdown.subscribeconstSubscribes to the TxPubSub, returning a scoped TxQueue for messages published after subscription.