Core queue operations required to publish and consume task deliveries.
Producer-only and event-driven integrations should implement TaskPublisher. Long-lived workers use this broader delivery contract. Broker remains the compatibility facade while optional operational capabilities are migrated to the interfaces below.
- Implemented types
- Implementers
- Available extensions
Properties
- capabilities → BrokerCapabilities
-
Available on QueueBroker, provided by the QueueBrokerCapabilitiesExtension extension
Returns the adapter's optional-operation capabilities.no setter - hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
ack(
Delivery delivery) → Future< void> -
Acknowledges the
delivery, confirming successful processing. -
close(
) → Future< void> -
Releases resources held by the transport.
override
-
consume(
RoutingSubscription subscription, {int prefetch = 1, String? consumerGroup, String? consumerName}) → Stream< Delivery> -
Returns a stream of deliveries based on the supplied
subscription. -
deadLetter(
Delivery delivery, {String? reason, Map< String, Object?> ? meta}) → Future<void> -
Available on QueueBroker, provided by the QueueBrokerOptionalOperations extension
Sends a delivery to the dead-letter store when supported. -
extendLease(
Delivery delivery, Duration by) → Future< void> -
Available on QueueBroker, provided by the QueueBrokerOptionalOperations extension
Extends a delivery lease when the adapter supports leases. -
getDeadLetter(
String queue, String id) → Future< DeadLetterEntry?> -
Available on QueueBroker, provided by the QueueBrokerOptionalOperations extension
Retrieves one dead-letter entry when supported. -
inflightCount(
String queue) → Future< int?> -
Available on QueueBroker, provided by the QueueBrokerOptionalOperations extension
Returns an in-flight queue count when supported. -
listDeadLetters(
String queue, {int limit = 50, int offset = 0}) → Future< DeadLetterPage> -
Available on QueueBroker, provided by the QueueBrokerOptionalOperations extension
Lists dead-letter entries when the adapter supports inspection. -
nack(
Delivery delivery, {bool requeue = true}) → Future< void> -
Negatively acknowledges the
delivery. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pendingCount(
String queue) → Future< int?> -
Available on QueueBroker, provided by the QueueBrokerOptionalOperations extension
Returns a pending queue count when supported. -
publish(
Envelope envelope, {RoutingInfo? routing}) → Future< void> -
Publishes the given
envelopeusingroutingmetadata when provided.inherited -
purge(
String queue) → Future< void> -
Available on QueueBroker, provided by the QueueBrokerOptionalOperations extension
Removes all messages from a queue when supported. -
purgeDeadLetters(
String queue, {DateTime? since, int? limit}) → Future< int> -
Available on QueueBroker, provided by the QueueBrokerOptionalOperations extension
Purges dead-letter entries when supported. -
replayDeadLetters(
String queue, {int limit = 50, DateTime? since, Duration? delay, bool dryRun = false}) → Future< DeadLetterReplayResult> -
Available on QueueBroker, provided by the QueueBrokerOptionalOperations extension
Replays dead-letter entries when supported. -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited