peekBatch method

@override Future<List<MessageEnvelope?>> peekBatch(String? correlationId, int messageCount)

Peeks multiple incoming messages from the queue without removing them. If there are no messages available in the queue it returns an empty list.

• correlationId (optional) transaction id to trace execution through call chain.
• messageCount a maximum number of messages to peek. Return Future that receives a list with messages Throws error.

Implementation

@override
Future<List<MessageEnvelope?>> peekBatch(
    String? correlationId, int messageCount) async {
  var messages = _messages.sublist(0, messageCount);
  logger.trace(correlationId, 'Peeked %d messages on %s',
      [messages.length, toString()]);
  return Future.value(messages);
}