131 lines
3.6 KiB
JavaScript
131 lines
3.6 KiB
JavaScript
import * as internal from "./internal/stm/tPubSub.js";
|
|
/**
|
|
* @since 2.0.0
|
|
* @category symbols
|
|
*/
|
|
export const TPubSubTypeId = internal.TPubSubTypeId;
|
|
/**
|
|
* Waits until the `TPubSub` is shutdown. The `STM` returned by this method will
|
|
* not resume until the queue has been shutdown. If the `TPubSub` is already
|
|
* shutdown, the `STM` will resume right away.
|
|
*
|
|
* @since 2.0.0
|
|
* @category mutations
|
|
*/
|
|
export const awaitShutdown = internal.awaitShutdown;
|
|
/**
|
|
* Creates a bounded `TPubSub` with the back pressure strategy. The `TPubSub` will retain
|
|
* messages until they have been taken by all subscribers, applying back
|
|
* pressure to publishers if the `TPubSub` is at capacity.
|
|
*
|
|
* @since 2.0.0
|
|
* @category constructors
|
|
*/
|
|
export const bounded = internal.bounded;
|
|
/**
|
|
* Returns the number of elements the `TPubSub` can hold.
|
|
*
|
|
* @since 2.0.0
|
|
* @category getters
|
|
*/
|
|
export const capacity = internal.capacity;
|
|
/**
|
|
* Creates a bounded `TPubSub` with the dropping strategy. The `TPubSub` will drop new
|
|
* messages if the `TPubSub` is at capacity.
|
|
*
|
|
* @since 2.0.0
|
|
* @category constructors
|
|
*/
|
|
export const dropping = internal.dropping;
|
|
/**
|
|
* Returns `true` if the `TPubSub` contains zero elements, `false` otherwise.
|
|
*
|
|
* @since 2.0.0
|
|
* @category getters
|
|
*/
|
|
export const isEmpty = internal.isEmpty;
|
|
/**
|
|
* Returns `true` if the `TPubSub` contains at least one element, `false`
|
|
* otherwise.
|
|
*
|
|
* @since 2.0.0
|
|
* @category getters
|
|
*/
|
|
export const isFull = internal.isFull;
|
|
/**
|
|
* Interrupts any fibers that are suspended on `offer` or `take`. Future calls
|
|
* to `offer*` and `take*` will be interrupted immediately.
|
|
*
|
|
* @since 2.0.0
|
|
* @category utils
|
|
*/
|
|
export const shutdown = internal.shutdown;
|
|
/**
|
|
* Returns `true` if `shutdown` has been called, otherwise returns `false`.
|
|
*
|
|
* @since 2.0.0
|
|
* @category getters
|
|
*/
|
|
export const isShutdown = internal.isShutdown;
|
|
/**
|
|
* Publishes a message to the `TPubSub`, returning whether the message was published
|
|
* to the `TPubSub`.
|
|
*
|
|
* @since 2.0.0
|
|
* @category mutations
|
|
*/
|
|
export const publish = internal.publish;
|
|
/**
|
|
* Publishes all of the specified messages to the `TPubSub`, returning whether they
|
|
* were published to the `TPubSub`.
|
|
*
|
|
* @since 2.0.0
|
|
* @category mutations
|
|
*/
|
|
export const publishAll = internal.publishAll;
|
|
/**
|
|
* Retrieves the size of the `TPubSub`, which is equal to the number of elements
|
|
* in the `TPubSub`. This may be negative if fibers are suspended waiting for
|
|
* elements to be added to the `TPubSub`.
|
|
*
|
|
* @since 2.0.0
|
|
* @category getters
|
|
*/
|
|
export const size = internal.size;
|
|
/**
|
|
* Creates a bounded `TPubSub` with the sliding strategy. The `TPubSub` will add new
|
|
* messages and drop old messages if the `TPubSub` is at capacity.
|
|
*
|
|
* For best performance use capacities that are powers of two.
|
|
*
|
|
* @since 2.0.0
|
|
* @category constructors
|
|
*/
|
|
export const sliding = internal.sliding;
|
|
/**
|
|
* Subscribes to receive messages from the `TPubSub`. The resulting subscription can
|
|
* be evaluated multiple times to take a message from the `TPubSub` each time. The
|
|
* caller is responsible for unsubscribing from the `TPubSub` by shutting down the
|
|
* queue.
|
|
*
|
|
* @since 2.0.0
|
|
* @category mutations
|
|
*/
|
|
export const subscribe = internal.subscribe;
|
|
/**
|
|
* Subscribes to receive messages from the `TPubSub`. The resulting subscription can
|
|
* be evaluated multiple times within the scope to take a message from the `TPubSub`
|
|
* each time.
|
|
*
|
|
* @since 2.0.0
|
|
* @category mutations
|
|
*/
|
|
export const subscribeScoped = internal.subscribeScoped;
|
|
/**
|
|
* Creates an unbounded `TPubSub`.
|
|
*
|
|
* @since 2.0.0
|
|
* @category constructors
|
|
*/
|
|
export const unbounded = internal.unbounded;
|
|
//# sourceMappingURL=TPubSub.js.map
|