<!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>Opens a connection</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="stomp.commit.html">Stomp::commit</a></div>
<div class="next" style="text-align: right; float: right;"><a href="stomp.destruct.html">Stomp::__destruct</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.construct" class="refentry">
<div class="refnamediv">
<h1 class="refname">Stomp::__construct</h1>
<h1 class="refname">stomp_connect</h1>
<p class="verinfo">(PECL stomp >= 0.1.0)</p><p class="refpurpose"><span class="refname">Stomp::__construct</span> -- <span class="refname">stomp_connect</span> — <span class="dc-title">Opens a connection</span></p>
</div>
<div class="refsect1 description" id="refsect1-stomp.construct-description">
<h3 class="title">Description</h3>
<p class="para">Object oriented style (constructor):</p>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><strong>Stomp::__construct</strong></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$broker</code><span class="initializer"> = ini_get("stomp.default_broker_uri")</span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$username</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$password</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">resource</span> <span class="methodname"><strong>stomp_connect</strong></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$broker</code><span class="initializer"> = ini_get("stomp.default_broker_uri")</span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$username</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$password</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$headers</code></span>
]]]] )</div>
<p class="para rdfs-comment">
Opens a connection to a stomp compliant Message Broker.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-stomp.construct-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">broker</code></em></span>
<dd>
<p class="para">
The broker URI
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">username</code></em></span>
<dd>
<p class="para">
The username.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">password</code></em></span>
<dd>
<p class="para">
The password.
</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.construct-returnvalues">
<h3 class="title">Return Values</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>
<div class="refsect1 changelog" id="refsect1-stomp.construct-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>1.0.1</td>
<td>
The <em><code class="parameter">headers</code></em> parameter was added
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-stomp.construct-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4642">
<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">/* close connection */<br /></span><span style="color: #007700">unset(</span><span style="color: #0000BB">$stomp</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-4643">
<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">'ssl://localhost:61612'</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">/* 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="stomp.commit.html">Stomp::commit</a></div>
<div class="next" style="text-align: right; float: right;"><a href="stomp.destruct.html">Stomp::__destruct</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>
