Stomp::ack

stomp_ack

(PECL stomp >= 0.1.0)

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

说明

面向对象风格 (method):

public bool Stomp::ack ( mixed $msg [, array $headers ] )

过程化风格:

bool stomp_ack ( resource $link , mixed $msg [, array $headers ] )

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

参数

link: 仅对过程化样式：由 stomp_connect() 返回的 stomp 连接标识符。
msg: The message/messageId to be acknowledged.
headers: 关联数组包含附加的头信息（例如： receipt）。

返回值

成功时返回 TRUE ，或者在失败时返回 FALSE 。

注释

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.

范例

Example #1 面向对象风格

  <?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 过程化风格

  <?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 );

 ?>