Our source is open
The syntax highlighted source is automatically generated by PHP from
the plaintext script.
If you're interested in what's behind the several functions we
used, you can always take a look at the source of the following files:
Of course, if you want to see the source
of this page, we have it available.
You can also browse the SVN repository for this website on
svn.php.net.
Source of: /manual/en/function.samconnection-disconnect.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.sam.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.samconnection-disconnect.php',
1 => 'SAMConnection->disconnect',
),
'up' =>
array (
0 => 'ref.sam.php',
1 => 'SAM Functions',
),
'prev' =>
array (
0 => 'function.samconnection-constructor.php',
1 => 'SAMConnection->__construct',
),
'next' =>
array (
0 => 'function.samconnection-errno.php',
1 => 'SAMConnection->errno',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.samconnection-disconnect" class="refentry">
<div class="refnamediv">
<h1 class="refname">SAMConnection->disconnect</h1>
<p class="verinfo">(PECL sam >= 0.1.0)</p><p class="refpurpose"><span class="refname">SAMConnection->disconnect</span> — <span class="dc-title">
Disconnects from a Messaging Server
</span></p>
</div>
<a name="function.samconnection-disconnect.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="classsynopsis">
<div class="ooclass"><b class="classname">SAMConnection</b></div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>disconnect</b></span> ( <span class="methodparam">void</span>
)</div>
</div>
<p class="para">
Calling the "disconnect" method on a SAMConnection object disconnects the
PHP script from a messaging server. No messages can be sent or received
after a connection has been disconnected.
</p>
</div>
<a name="function.samconnection-disconnect.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.samconnection-disconnect.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 Disconnecting from a Messaging Server</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$conn</span><span style="color: #007700">-></span><span style="color: #0000BB">disconnect</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.samconnection-disconnect.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.samconnection-isconnected.php" class="xref">SAMConnection->isConnected</a></li>
<li class="member"><a href="function.samconnection-connect.php" class="xref">SAMConnection->connect</a></li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
