Skip to content

GitLab

Commit 7b7209b7 authored by Davis King's avatar Davis King
Browse files

updated docs

parent 943874c5
Hide whitespace changes
Inline Side-by-side
Showing with 35 additions and 95 deletions
docs/docs/index.xml
View file @ 7b7209b7
...@@ -85,7 +85,7 @@ ...@@ -85,7 +85,7 @@
<li>An object to help you make TCP based <a href="network.html#server">servers</a></li> <li>An object to help you make TCP based <a href="network.html#server">servers</a></li>
<li>A <a href="network.html#sockstreambuf">streambuf</a> object that enables TCP sockets <li>A <a href="network.html#sockstreambuf">streambuf</a> object that enables TCP sockets
to interoperate with the C++ iostreams library </li> to interoperate with the C++ iostreams library </li>
<li>A simple <a href="network.html#http">HTTP server</a> object you can use to embed a <li>A simple <a href="network.html#server_http">HTTP server</a> object you can use to embed a
web server into your applications</li> web server into your applications</li>
<li>A message passing <a href="other.html#pipe">pipe</a> for inter-thread and <a href="network.html#bridge">inter-process</a> communication</li> <li>A message passing <a href="other.html#pipe">pipe</a> for inter-thread and <a href="network.html#bridge">inter-process</a> communication</li>
<li>A tool used to implement algorithms using the <li>A tool used to implement algorithms using the
......
docs/docs/network.xml
View file @ 7b7209b7
...@@ -24,6 +24,8 @@ ...@@ -24,6 +24,8 @@
<name>Objects</name> <name>Objects</name>
<item>linker</item> <item>linker</item>
<item>server</item> <item>server</item>
<item>server_iostream</item>
<item>server_http</item>
<item>bridge</item> <item>bridge</item>
<item>sockstreambuf</item> <item>sockstreambuf</item>
</section> </section>
...@@ -161,7 +163,7 @@ ...@@ -161,7 +163,7 @@
<!-- ************************************************************************* --> <!-- ************************************************************************* -->
<component checked="true"> <component>
<name>server</name> <name>server</name>
<file>dlib/server.h</file> <file>dlib/server.h</file>
<spec_file>dlib/server/server_kernel_abstract.h</spec_file> <spec_file>dlib/server/server_kernel_abstract.h</spec_file>
...@@ -174,101 +176,37 @@ ...@@ -174,101 +176,37 @@
<examples> <examples>
<example>sockets_ex.cpp.html</example> <example>sockets_ex.cpp.html</example>
<example>sockstreambuf_ex.cpp.html</example> <example>sockstreambuf_ex.cpp.html</example>
<example>server_http_ex.cpp.html</example>
</examples> </examples>
<implementations> </component>
<implementation>
<name>server_kernel_1</name> <!-- ************************************************************************* -->
<file>dlib/server/server_kernel_1.h</file>
<description> <component>
This implementation is done using the objects defined in the <name>server_iostream</name>
<a href="api.html#sockets">sockets</a> and <a href="api.html#threads">threads</a> packages. <file>dlib/server.h</file>
It also uses a <a href="containers.html#set">set</a> to keep track of the connections. <spec_file>dlib/server/server_iostream_abstract.h</spec_file>
</description> <description>
This is an extension of the <a href="#server">server</a> object that redefines
<typedefs> the on_connect() function so that instead of giving you a connection object you
<typedef> get an istream and ostream object.
<name>kernel_1a</name> </description>
<description>is a typedef for server_kernel_1 that uses set_kernel_1a</description> </component>
</typedef>
</typedefs> <!-- ************************************************************************* -->
</implementation> <component>
<name>server_http</name>
</implementations> <file>dlib/server.h</file>
<spec_file link="true">dlib/server/server_http_abstract.h</spec_file>
<description>
<extensions> This is an extension of the <a href="#server">server</a> object which
<extension> turns it into a simple HTTP server.
<name>iostream</name> </description>
<spec_file>dlib/server/server_iostream_abstract.h</spec_file>
<description>
This extension redefines the on_connect() function so that
instead of giving you a connection object you get an istream
and ostream object.
</description>
<implementations>
<implementation>
<name>server_iostream_1</name>
<file>dlib/server/server_iostream_1.h</file>
<description>
This is implemented in the obvious way using the <a href="#sockstreambuf">sockstreambuf</a> object.
</description>
<typedefs>
<typedef>
<name>iostream_1a</name>
<description>is a typedef for server_kernel_1a extended by server_iostream_1 that uses
sockstreambuf_kernel_2a</description>
</typedef>
</typedefs>
</implementation>
</implementations>
</extension>
<extension>
<name>http</name>
<spec_file>dlib/server/server_http_abstract.h</spec_file>
<description>
This extension turns the server object into a simple HTTP server.
</description>
<examples>
<example>server_http_ex.cpp.html</example>
</examples>
<implementations>
<implementation>
<name>server_http_1</name>
<file>dlib/server/server_http_1.h</file>
<description>
This is implemented in the obvious way.
</description>
<typedefs>
<typedef>
<name>http_1a</name>
<description>is a typedef for server_iostream_1a extended by server_http_1 </description>
</typedef>
</typedefs>
</implementation>
</implementations>
</extension>
</extensions>
<examples>
<example>server_http_ex.cpp.html</example>
</examples>
</component> </component>
<!-- ************************************************************************* --> <!-- ************************************************************************* -->
......
docs/docs/term_index.xml
View file @ 7b7209b7
...@@ -1225,7 +1225,9 @@ ...@@ -1225,7 +1225,9 @@
<term file="network.html" name="linker"/> <term file="network.html" name="linker"/>
<term file="network.html" name="server"/> <term file="network.html" name="server"/>
<term link="network.html#http" name="HTTP server"/> <term file="network.html" name="server_iostream"/>
<term file="network.html" name="server_http"/>
<term link="network.html#server_http" name="HTTP server"/>
<term file="network.html" name="sockstreambuf"/> <term file="network.html" name="sockstreambuf"/>
<term file="network.html" name="bridge"/> <term file="network.html" name="bridge"/>
<term file="dlib/bridge/bridge_abstract.h.html" name="connect_to_ip_and_port"/> <term file="dlib/bridge/bridge_abstract.h.html" name="connect_to_ip_and_port"/>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment