<!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>Sends a message</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="stomp.readframe.html">Stomp::readFrame</a></div>
<div class="next" style="text-align: right; float: right;"><a href="stomp.setreadtimeout.html">Stomp::setReadTimeout</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.send" class="refentry">
<div class="refnamediv">
<h1 class="refname">Stomp::send</h1>
<h1 class="refname">stomp_send</h1>
<p class="verinfo">(PECL stomp >= 0.1.0)</p><p class="refpurpose"><span class="refname">Stomp::send</span> -- <span class="refname">stomp_send</span> — <span class="dc-title">Sends a message</span></p>
</div>
<div class="refsect1 description" id="refsect1-stomp.send-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::send</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$destination</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$msg</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_send</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">$destination</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$msg</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$headers</code></span>
] )</div>
<p class="para rdfs-comment">
Sends a message to the Message Broker.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-stomp.send-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">destination</code></em></span>
<dd>
<p class="para">
Where to send the message
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">msg</code></em></span>
<dd>
<p class="para">
Message to send.
</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.send-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.send-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>: <p class="para">A transaction header may be specified, indicating that the message acknowledgment should be part of the named transaction.</p></p></blockquote>
<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.send-examples">
<h3 class="title">Examples</h3>
<p class="para">
See <span class="function"><a href="stomp.ack.html" class="function">stomp_ack()</a></span>.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="stomp.readframe.html">Stomp::readFrame</a></div>
<div class="next" style="text-align: right; float: right;"><a href="stomp.setreadtimeout.html">Stomp::setReadTimeout</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>
