<!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>Queries whether a connection is established to a Messaging Server</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="samconnection.error.html">SAMConnection::error</a></div>
<div class="next" style="text-align: right; float: right;"><a href="samconnection.peek.html">SAMConnection::peek</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.isconnected" class="refentry">
<div class="refnamediv">
<h1 class="refname">SAMConnection::isConnected</h1>
<p class="verinfo">(PECL sam >= 0.1.0)</p><p class="refpurpose"><span class="refname">SAMConnection::isConnected</span> — <span class="dc-title">
Queries whether a connection is established to a Messaging Server
</span></p>
</div>
<div class="refsect1 description" id="refsect1-samconnection.isconnected-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>SAMConnection::isConnected</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Calling the "isConnected" method on a Connection object will check whether
the PHP script is connected to a messaging server. No messages can be sent
or received unless a connection has been established with a Messaging
server.
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-samconnection.isconnected-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
This method returns <strong><code>TRUE</code></strong> if the SAMConnection object is successfully
connected to a Messaging server or <strong><code>FALSE</code></strong> otherwise.
</p>
</div>
<div class="refsect1 examples" id="refsect1-samconnection.isconnected-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4523">
<p><strong>Example #1 Checking whether there us a connection to a Messaging Server</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: #007700">if (</span><span style="color: #0000BB">$conn</span><span style="color: #007700">-></span><span style="color: #0000BB">isConnected</span><span style="color: #007700">()) {<br /> echo </span><span style="color: #DD0000">'Connection is active.'</span><span style="color: #007700">;<br />} else {<br /> echo </span><span style="color: #DD0000">'No active connection!'</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-samconnection.isconnected-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><a href="samconnection.disconnect.html" class="xref">SAMConnection::disconnect</a></li>
<li class="member"><a href="samconnection.connect.html" class="xref">SAMConnection::connect</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.error.html">SAMConnection::error</a></div>
<div class="next" style="text-align: right; float: right;"><a href="samconnection.peek.html">SAMConnection::peek</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>
