<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Rolls back a transaction in progress</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.stomp.html">Stomp</a></div>
<div class="next" style="text-align: right; float: right;"><a href="stomp.ack.html">Stomp::ack</a></div>
<div class="up"><a href="class.stomp.html">Stomp</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="stomp.abort" class="refentry">
<div class="refnamediv">
<h1 class="refname">Stomp::abort</h1>
<h1 class="refname">stomp_abort</h1>
<p class="verinfo">(PECL stomp >= 0.1.0)</p><p class="refpurpose"><span class="refname">Stomp::abort</span> -- <span class="refname">stomp_abort</span> — <span class="dc-title">Rolls back a transaction in progress</span></p>
</div>
<div class="refsect1 description" id="refsect1-stomp.abort-description">
<h3 class="title">Description</h3>
<p class="para">Object oriented style (method):</p>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>Stomp::abort</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$transaction_id</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$headers</code></span>
] )</div>
<p class="para rdfs-comment">Procedural style:</p>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>stomp_abort</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$link</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$transaction_id</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$headers</code></span>
] )</div>
<p class="para rdfs-comment">
Rolls back a transaction in progress.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-stomp.abort-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">link</code></em></span><dd>
<p class="para">Procedural style only: The stomp link identifier returned by <span class="function"><a href="stomp.construct.html" class="function">stomp_connect()</a></span>.</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">transaction_id</code></em></span>
<dd>
<p class="para">
The transaction to abort.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">headers</code></em></span><dd>
<p class="para">Associative array containing the additional headers (example: receipt).</p></dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-stomp.abort-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 notes" id="refsect1-stomp.abort-notes">
<h3 class="title">Notes</h3>
<div class="tip"><strong class="tip">Tip</strong><p class="simpara">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.</p></div>
</div>
<div class="refsect1 examples" id="refsect1-stomp.abort-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4636">
<p><strong>Example #1 Object oriented style</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">/* connection */<br /></span><span style="color: #007700">try {<br /> </span><span style="color: #0000BB">$stomp </span><span style="color: #007700">= new </span><span style="color: #0000BB">Stomp</span><span style="color: #007700">(</span><span style="color: #DD0000">'tcp://localhost:61613'</span><span style="color: #007700">);<br />} catch(</span><span style="color: #0000BB">StompException $e</span><span style="color: #007700">) {<br /> die(</span><span style="color: #DD0000">'Connection failed: ' </span><span style="color: #007700">. </span><span style="color: #0000BB">$e</span><span style="color: #007700">-></span><span style="color: #0000BB">getMessage</span><span style="color: #007700">());<br />}<br /><br /></span><span style="color: #FF8000">/* begin a transaction */<br /></span><span style="color: #0000BB">$stomp</span><span style="color: #007700">-></span><span style="color: #0000BB">begin</span><span style="color: #007700">(</span><span style="color: #DD0000">'t1'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* send a message to the queue */<br /></span><span style="color: #0000BB">$stomp</span><span style="color: #007700">-></span><span style="color: #0000BB">send</span><span style="color: #007700">(</span><span style="color: #DD0000">'/queue/foo'</span><span style="color: #007700">, </span><span style="color: #DD0000">'bar'</span><span style="color: #007700">, array(</span><span style="color: #DD0000">'transaction' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'t1'</span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">/* rollback */<br /></span><span style="color: #0000BB">$stomp</span><span style="color: #007700">-></span><span style="color: #0000BB">abort</span><span style="color: #007700">(</span><span style="color: #DD0000">'t1'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* close connection */<br /></span><span style="color: #007700">unset(</span><span style="color: #0000BB">$stomp</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-4637">
<p><strong>Example #2 Procedural style</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">/* connection */<br /></span><span style="color: #0000BB">$link </span><span style="color: #007700">= </span><span style="color: #0000BB">stomp_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'tcp://localhost:61613'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* check connection */<br /></span><span style="color: #007700">if (!</span><span style="color: #0000BB">$link</span><span style="color: #007700">) {<br /> die(</span><span style="color: #DD0000">'Connection failed: ' </span><span style="color: #007700">. </span><span style="color: #0000BB">stomp_connect_error</span><span style="color: #007700">());<br />}<br /><br /></span><span style="color: #FF8000">/* begin a transaction */<br /></span><span style="color: #0000BB">stomp_begin</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">, </span><span style="color: #DD0000">'t1'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* send a message to the queue 'foo' */<br /></span><span style="color: #0000BB">stomp_send</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">, </span><span style="color: #DD0000">'/queue/foo'</span><span style="color: #007700">, </span><span style="color: #DD0000">'bar'</span><span style="color: #007700">, array(</span><span style="color: #DD0000">'transaction' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'t1'</span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">/* rollback */<br /></span><span style="color: #0000BB">stomp_abort</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">, </span><span style="color: #DD0000">'t1'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* close connection */<br /></span><span style="color: #0000BB">stomp_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.stomp.html">Stomp</a></div>
<div class="next" style="text-align: right; float: right;"><a href="stomp.ack.html">Stomp::ack</a></div>
<div class="up"><a href="class.stomp.html">Stomp</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
