Stomp::ack

    stomp_ack

    (PECL stomp >= 0.1.0)

    Stomp::ack -- stomp_ack — Acknowledges consumption of a message

    Description

    Object-oriented style (method):

    publicStomp::ack(mixed$msg, array$headers = ?): bool

    Procedural style:

    stomp_ack(resource$link, mixed$msg, array$headers = ?): bool

    Acknowledges consumption of a message from a subscription using client acknowledgment.

    Parameters

    link

    Procedural style only: The stomp link identifier returned by stomp_connect().

    msg

    The message/messageId to be acknowledged.

    headers

    Associative array containing the additional headers (example: receipt).

    Return Values

    Returns true on success or false on failure.

    Examples

    Example #1 Object-oriented style

    <?php

    $queue     = '/queue/foo';
    $msg = 'bar';


    try {
    $stomp = new Stomp('tcp://localhost:61613');
    } catch(    StompException $e) {
    die(    'Connection failed: ' . $e->getMessage());
    }


    $stomp->send($queue, $msg);


    $stomp->subscribe($queue);


    $frame = $stomp->readFrame();

    if (    $frame->body === $msg) {

    $stomp->ack($frame);
    }


    $stomp->unsubscribe($queue);


    unset($stomp);

    ?>

    Example #2 Procedural style

    <?php

    $queue     = '/queue/foo';
    $msg = 'bar';


    $link = stomp_connect('ssl://localhost:61612');


    if (!$link) {
    die(    'Connection failed: ' . stomp_connect_error());
    }


    stomp_begin($link, 't1');


    stomp_send($link, $queue, $msg, array('transaction' => 't1'));


    stomp_commit($link, 't1');


    stomp_subscribe($link, $queue);


    $frame = stomp_read_frame($link);

    if (    $frame['body'] === $msg) {

    stomp_ack($link, $frame['headers']['message-id']);
    }


    stomp_unsubscribe($link, $queue);


    stomp_close($link);

    ?>

    Notes

    Note:

    A transaction header may be specified, indicating that the message acknowledgment should be part of the named transaction.

    Tip

    Stomp is inherently asynchronous. Synchronous communication can be implemented adding a receipt header. This will cause methods to not return anything until the server has acknowledged receipt of the message or until read timeout was reached.

    To Top