Lionel Cons > Net-STOMP-Client-2.2 > Net::STOMP::Client::Receipt

Download:
Net-STOMP-Client-2.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 2.2   Source  

NAME ^

Net::STOMP::Client::Receipt - Receipt support for Net::STOMP::Client

SYNOPSIS ^

  use Net::STOMP::Client;
  $stomp = Net::STOMP::Client->new(host => "127.0.0.1", port => 61613);
  ...
  # send two messages with receipts
  $stomp->send(
      destination => "/queue/test1",
      body        => "message 1",
      receipt     => $stomp->uuid(),
  );
  $stomp->send(
      destination => "/queue/test2",
      body        => "message 2",
      receipt     => $stomp->uuid(),
  );
  # wait for both acknowledgments to come back within ten seconds
  $stomp->wait_for_receipts(timeout => 10);
  die("Not all receipts received!\n") if $stomp->receipts();

DESCRIPTION ^

This module eases receipts handling. It is used internally by Net::STOMP::Client and should not be directly used elsewhere.

Each time a client frame is sent, its receipt header (if supplied) is remembered.

Each time a RECEIPT frame is received from the server, the corresponding receipt is ticked off.

The receipts() method can be used to get the list of outstanding receipts.

The wait_for_receipts() method can be used to wait for all missing receipts.

METHODS ^

This module provides the following methods to Net::STOMP::Client:

receipts()

get the list of not-yet-received receipts

wait_for_receipts([OPTIONS])

wait for all receipts to be received, using wait_for_frames() underneath; take the same options as wait_for_frames(), except callback which is overridden

SEE ALSO ^

Net::STOMP::Client.

AUTHOR ^

Lionel Cons http://cern.ch/lionel.cons

Copyright (C) CERN 2010-2013

syntax highlighting: