Skip to content

Commit

Permalink
added doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Tieske committed Mar 5, 2015
1 parent b49f837 commit e38972d
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion doc/us/reference.html
Expand Up @@ -84,12 +84,22 @@ <h2>Reference</h2>
registered handlers as long as it uses the Copas socket functions.
</dd>

<dt><strong><code>copas.finished()</code></strong></dt>
<dd>Checks whether anything remains to be done.<br />
Returns <code>false</code> when the sockets lists for reading and writing
are empty and there is no other (sleeping) task to execute. Calling
<code>copas.step(timeout)</code> when <code>copas.finished() == true</code>
will lock the system for the timeout period, or never return at all if no
timeout is provided.
</dd>

<dt><strong><code>copas.loop(timeout)</code></strong></dt>
<dd>Starts the Copas infinite loop accepting client connections for the
<dd>Starts the Copas loop accepting client connections for the
registered servers and handling those connections with the corresponding
handlers. Every time a server accepts a connection, Copas calls the
associated handler passing the client socket returned by
<code>socket.accept()</code>. The <code>timeout</code> parameter is optional.
The loop returns when <code>copas.finished() == true</code>.
</dd>

<dt><strong><code>copas.removeserver(skt)</code></strong></dt>
Expand Down

0 comments on commit e38972d

Please sign in to comment.