<!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>Create a subscription to a specified topic.</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="samconnection.setdebug.html">SAMConnection::setDebug</a></div>
<div class="next" style="text-align: right; float: right;"><a href="samconnection.unsubscribe.html">SAMConnection::unsubscribe</a></div>
<div class="up"><a href="ref.sam.html">SAM Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="samconnection.subscribe" class="refentry">
<div class="refnamediv">
<h1 class="refname">SAMConnection::subscribe</h1>
<p class="verinfo">(PECL sam >= 0.1.0)</p><p class="refpurpose"><span class="refname">SAMConnection::subscribe</span> — <span class="dc-title">
Create a subscription to a specified topic.
</span></p>
</div>
<div class="refsect1 description" id="refsect1-samconnection.subscribe-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>SAMConnection::subscribe</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$targetTopic</code></span>
)</div>
<p class="para rdfs-comment">
The "subscribe" method is used to create a new subscription to a specified topic.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-samconnection.subscribe-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">targetTopic</code></em></span>
<dd>
<p class="para">
The identity of the topic (topic://topicname) to subscribe to.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-samconnection.subscribe-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
A subscription identifier that can be used in a subsequent receive call as
a selector to obtain any topic data or <strong><code>FALSE</code></strong> if an error occurred. The
subscription identifier should be used in the receive call in place of the
simple topic name.
</p>
</div>
<div class="refsect1 examples" id="refsect1-samconnection.subscribe-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4538">
<p><strong>Example #1 Subscribe to a topic</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$subid </span><span style="color: #007700">= </span><span style="color: #0000BB">$conn</span><span style="color: #007700">-></span><span style="color: #0000BB">subscribe</span><span style="color: #007700">(</span><span style="color: #DD0000">'topic://A'</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">$subid</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// The subscribe failed!<br /> </span><span style="color: #007700">echo </span><span style="color: #DD0000">"Subscribe failed (</span><span style="color: #0000BB">$conn</span><span style="color: #007700">-></span><span style="color: #0000BB">errno</span><span style="color: #DD0000">) </span><span style="color: #0000BB">$conn</span><span style="color: #007700">-></span><span style="color: #0000BB">error</span><span style="color: #DD0000">"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-samconnection.subscribe-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><a href="samconnection.unsubscribe.html" class="xref">SAMConnection::unsubscribe</a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="samconnection.setdebug.html">SAMConnection::setDebug</a></div>
<div class="next" style="text-align: right; float: right;"><a href="samconnection.unsubscribe.html">SAMConnection::unsubscribe</a></div>
<div class="up"><a href="ref.sam.html">SAM Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
