updated docs

This commit is contained in:
Davis King 2012-10-16 21:26:17 -04:00
parent b9680fb01c
commit f6b0c1aacc
2 changed files with 26 additions and 0 deletions

View File

@ -32,6 +32,7 @@
<name>BSP</name>
<item>bsp_connect</item>
<item>bsp_listen</item>
<item>bsp_listen_dynamic_port</item>
<item>bsp_context</item>
</section>
@ -102,6 +103,8 @@
<file>dlib/bsp.h</file>
<spec_file link="true">dlib/bsp/bsp_abstract.h</spec_file>
<description>
This function spawns a BSP job consisting of a number of network hosts
as well as the local host.
</description>
</component>
@ -112,6 +115,25 @@
<file>dlib/bsp.h</file>
<spec_file link="true">dlib/bsp/bsp_abstract.h</spec_file>
<description>
This function listens for a TCP connection from the <a href="#bsp_connect">bsp_connect</a> routine.
Once this connection is established, a user supplied function will be executed and it will
then be able to participate in a BSP computation as one of the processing
nodes.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>bsp_listen_dynamic_port</name>
<file>dlib/bsp.h</file>
<spec_file link="true">dlib/bsp/bsp_abstract.h</spec_file>
<description>
This function listens for a TCP connection from the <a href="#bsp_connect">bsp_connect</a> routine.
Once this connection is established, a user supplied function will be executed and it will
then be able to participate in a BSP computation as one of the processing
nodes. This function has the additional ability to select the listening TCP port
automatically from the set of available ports.
</description>
</component>
@ -122,6 +144,9 @@
<file>dlib/bsp.h</file>
<spec_file link="true">dlib/bsp/bsp_abstract.h</spec_file>
<description>
This is a tool used to implement algorithms using the Bulk Synchronous
Parallel (BSP) computing model. In particular, this object defines
the API used by a BSP job to communicate between processing nodes.
</description>
</component>

View File

@ -1224,6 +1224,7 @@
<term file="dlib/bridge/bridge_abstract.h.html" name="bridge_status"/>
<term file="network.html" name="bsp_context"/>
<term file="network.html" name="bsp_listen"/>
<term file="network.html" name="bsp_listen_dynamic_port"/>
<term file="network.html" name="bsp_connect"/>