PublishResultModule

PackageAxial
Combines PublishResult values, for totalling several publishes.

Summary

NameSignatureSynopsis
Representation
DeliveredDeliveredSubscriptions that accepted the value, including sliding subscriptions that evicted to make room.
DroppedDroppedDropping subscriptions that discarded the value because their buffer was full.
EvictedEvictedSliding subscriptions that evicted their oldest value to accept this one.
Operations
emptyPublishResult.empty The result of a publish that reached no subscription.
addPublishResult.add left rightAdds two results, for summing the publishes of a batch.

Representation

kind:member

Delivered

Delivered
Member
Subscriptions that accepted the value, including sliding subscriptions that evicted to make room.

Returns

int
kind:member

Dropped

Dropped
Member
Dropping subscriptions that discarded the value because their buffer was full.

Returns

int
kind:member

Evicted

Evicted
Member
Sliding subscriptions that evicted their oldest value to accept this one.

Returns

int

Operations

kind:member

empty

PublishResult.empty
Member
The result of a publish that reached no subscription.

Returns

PublishResult
kind:member

add

PublishResult.add left right
Member
Adds two results, for summing the publishes of a batch.

Parameters

NameTypeDescription
leftPublishResult
rightPublishResult

Returns

PublishResult