Document connected()

This commit is contained in:
Ian Gulliver
2014-06-19 23:28:21 -07:00
parent fec7ee2556
commit f1bfb42258

View File

@@ -55,6 +55,7 @@
<ul>
<li><a href="#constructor">Constructor</a></li>
<li><a href="#shutdown">shutdown()</a></li>
<li><a href="#connected">connected()</a></li>
<li><a href="#getProfile">getProfile()</a></li>
<li><a href="#currentProfile">currentProfile()</a></li>
<li><a href="#subscribe">subscribe()</a></li>
@@ -395,6 +396,16 @@ some actions may be queued.</p>
outstanding and some cleanup may be deferred.</p>
<h4><a name="shutdown">connected()</a></h4>
<p>Arguments: <i>none</i></p>
<p>Returns: A <code>boolean</code> indicating whether we currently believe that we are
connected to the server.</p>
<p>Note that this information may lag by the detection delay built into the channel API.</p>
<h4><a name="getProfile">getProfile()</a></h4>
<p>Arguments: <i>none</i></p>