update doxygen documentation

Cylix · Nov 14, 2017 · b446aff · b446aff
1 parent e2aa5bb
commit b446aff
Show file tree

Hide file tree

Showing 11 changed files with 56 additions and 14 deletions.
diff --git a/docs/html/classtacopie_1_1tcp__socket-members.html b/docs/html/classtacopie_1_1tcp__socket-members.html
@@ -80,19 +80,20 @@
   <tr><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#ad294565f9a0fa52639ecfbf133eecd59">get_host</a>(void) const</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a5276fdc687ac3c5089a05e3e2d9de4fb">get_port</a>(void) const</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a4f663be51b845520505bc20a88b411ee">get_type</a>(void) const</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#af0957ded2a84fb06d940cba98df477fb">listen</a>(std::size_t max_connection_queue)</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a76f69612969374b5aa542378d37ee398">operator!=</a>(const tcp_socket &amp;rhs) const</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#aae3234c92bd36d5a614e44472d42bbf4">operator=</a>(const tcp_socket &amp;)=delete</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a69fde61058ab72d88ce48f557d8216cf">operator==</a>(const tcp_socket &amp;rhs) const</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a0d6d30258a902d12b3c2c62644756685">recv</a>(std::size_t size_to_read)</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a36521a8f502adc665ad0fb1c53583d04">send</a>(const std::vector&lt; char &gt; &amp;data, std::size_t size_to_write)</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a89be86ab254eec3fc16eedfba8b16fb2">set_type</a>(type t)</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a88ed1cadb0263591c4d31805e0a1a001">tcp_socket</a>(void)</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a191ffa48e0753ad4ec87d4d3a4a97822">tcp_socket</a>(fd_t fd, const std::string &amp;host, std::uint32_t port, type t)</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a64f69cd1c185b523b543d4ea53cee1a2">tcp_socket</a>(tcp_socket &amp;&amp;)</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a5ae1a5b0f9713ef256164afdbeb1c193">tcp_socket</a>(const tcp_socket &amp;)=delete</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#ad8376e85df96ab9523f5d079ed7172ab">type</a> enum name</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a4bd737a76a2a326be03d704f79a35282">~tcp_socket</a>(void)=default</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a6d9933c767572b03fbb4b5ced4bd1fc4">is_ipv6</a>(void) const</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#af0957ded2a84fb06d940cba98df477fb">listen</a>(std::size_t max_connection_queue)</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a76f69612969374b5aa542378d37ee398">operator!=</a>(const tcp_socket &amp;rhs) const</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#aae3234c92bd36d5a614e44472d42bbf4">operator=</a>(const tcp_socket &amp;)=delete</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a69fde61058ab72d88ce48f557d8216cf">operator==</a>(const tcp_socket &amp;rhs) const</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a0d6d30258a902d12b3c2c62644756685">recv</a>(std::size_t size_to_read)</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a36521a8f502adc665ad0fb1c53583d04">send</a>(const std::vector&lt; char &gt; &amp;data, std::size_t size_to_write)</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a89be86ab254eec3fc16eedfba8b16fb2">set_type</a>(type t)</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a88ed1cadb0263591c4d31805e0a1a001">tcp_socket</a>(void)</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a191ffa48e0753ad4ec87d4d3a4a97822">tcp_socket</a>(fd_t fd, const std::string &amp;host, std::uint32_t port, type t)</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a64f69cd1c185b523b543d4ea53cee1a2">tcp_socket</a>(tcp_socket &amp;&amp;)</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a5ae1a5b0f9713ef256164afdbeb1c193">tcp_socket</a>(const tcp_socket &amp;)=delete</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#ad8376e85df96ab9523f5d079ed7172ab">type</a> enum name</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html#a4bd737a76a2a326be03d704f79a35282">~tcp_socket</a>(void)=default</td><td class="entry"><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a></td><td class="entry"></td></tr>
 </table></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>

diff --git a/docs/html/classtacopie_1_1tcp__socket.html b/docs/html/classtacopie_1_1tcp__socket.html
@@ -136,6 +136,8 @@
 <tr class="separator:a89be86ab254eec3fc16eedfba8b16fb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a4fd367a1802ed6ae7fa0e33fc07ed255"><td class="memItemLeft" align="right" valign="top">fd_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtacopie_1_1tcp__socket.html#a4fd367a1802ed6ae7fa0e33fc07ed255">get_fd</a> (void) const</td></tr>
 <tr class="separator:a4fd367a1802ed6ae7fa0e33fc07ed255"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a6d9933c767572b03fbb4b5ced4bd1fc4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtacopie_1_1tcp__socket.html#a6d9933c767572b03fbb4b5ced4bd1fc4">is_ipv6</a> (void) const</td></tr>
+<tr class="separator:a6d9933c767572b03fbb4b5ced4bd1fc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p><a class="el" href="classtacopie_1_1tcp__socket.html">tacopie::tcp_socket</a> is the class providing low-level TCP socket features. The <a class="el" href="classtacopie_1_1tcp__socket.html">tcp_socket</a> provides a simple but convenient abstraction to unix and windows sockets. It also provides a socket type checker to ensure that server-only operations are only processable on server sockets, and client-only operations are only processable on client sockets. </p>
@@ -409,6 +411,25 @@ <h2 class="memtitle"><span class="permalink"><a href="#a4f663be51b845520505bc20a
 </div><div class="memdoc">
 <dl class="section return"><dt>Returns</dt><dd>the type associated with the underlying socket. </dd></dl>
 
+</div>
+</div>
+<a id="a6d9933c767572b03fbb4b5ced4bd1fc4"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a6d9933c767572b03fbb4b5ced4bd1fc4">&#9670;&nbsp;</a></span>is_ipv6()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool tacopie::tcp_socket::is_ipv6 </td>
+          <td>(</td>
+          <td class="paramtype">void&#160;</td>
+          <td class="paramname"></td><td>)</td>
+          <td> const</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<dl class="section return"><dt>Returns</dt><dd>whether the host is IPV6 </dd></dl>
+
 </div>
 </div>
 <a id="af0957ded2a84fb06d940cba98df477fb"></a>

diff --git a/docs/html/functions.html b/docs/html/functions.html
@@ -193,6 +193,9 @@ <h3><a id="index_i"></a>- i -</h3><ul>
 <li>is_connected()
 : <a class="el" href="classtacopie_1_1tcp__client.html#a9bf568812c8350260843842e7952c8c3">tacopie::tcp_client</a>
 </li>
+<li>is_ipv6()
+: <a class="el" href="classtacopie_1_1tcp__socket.html#a6d9933c767572b03fbb4b5ced4bd1fc4">tacopie::tcp_socket</a>
+</li>
 <li>is_running()
 : <a class="el" href="classtacopie_1_1tcp__server.html#a76162141e6443953f3ad8e11c4e4d3d7">tacopie::tcp_server</a>
 , <a class="el" href="classtacopie_1_1utils_1_1thread__pool.html#a77a647a75be188a5c5f83b922c061107">tacopie::utils::thread_pool</a>

diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html
@@ -171,6 +171,9 @@ <h3><a id="index_i"></a>- i -</h3><ul>
 <li>is_connected()
 : <a class="el" href="classtacopie_1_1tcp__client.html#a9bf568812c8350260843842e7952c8c3">tacopie::tcp_client</a>
 </li>
+<li>is_ipv6()
+: <a class="el" href="classtacopie_1_1tcp__socket.html#a6d9933c767572b03fbb4b5ced4bd1fc4">tacopie::tcp_socket</a>
+</li>
 <li>is_running()
 : <a class="el" href="classtacopie_1_1tcp__server.html#a76162141e6443953f3ad8e11c4e4d3d7">tacopie::tcp_server</a>
 , <a class="el" href="classtacopie_1_1utils_1_1thread__pool.html#a77a647a75be188a5c5f83b922c061107">tacopie::utils::thread_pool</a>

diff --git a/docs/html/search/all_6.js b/docs/html/search/all_6.js
diff --git a/docs/html/search/functions_6.js b/docs/html/search/functions_6.js
diff --git a/docs/html/tcp__socket_8hpp_source.html b/docs/html/tcp__socket_8hpp_source.html
diff --git a/docs/latex/classtacopie_1_1logger.pdf b/docs/latex/classtacopie_1_1logger.pdf
diff --git a/docs/latex/classtacopie_1_1logger__iface.pdf b/docs/latex/classtacopie_1_1logger__iface.pdf
diff --git a/docs/latex/classtacopie_1_1tacopie__error.pdf b/docs/latex/classtacopie_1_1tacopie__error.pdf
diff --git a/docs/latex/classtacopie_1_1tcp__socket.tex b/docs/latex/classtacopie_1_1tcp__socket.tex
@@ -59,6 +59,8 @@ \subsection*{Public Member Functions}
 void \hyperlink{classtacopie_1_1tcp__socket_a89be86ab254eec3fc16eedfba8b16fb2}{set\+\_\+type} (\hyperlink{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172ab}{type} t)
 \item 
 fd\+\_\+t \hyperlink{classtacopie_1_1tcp__socket_a4fd367a1802ed6ae7fa0e33fc07ed255}{get\+\_\+fd} (void) const
+\item 
+bool \hyperlink{classtacopie_1_1tcp__socket_a6d9933c767572b03fbb4b5ced4bd1fc4}{is\+\_\+ipv6} (void) const
 \end{DoxyCompactItemize}
 
 
@@ -186,6 +188,15 @@ \subsubsection{\texorpdfstring{get\+\_\+type()}{get\_type()}}
 \begin{DoxyReturn}{Returns}
 the type associated with the underlying socket. 
 \end{DoxyReturn}
+\mbox{\Hypertarget{classtacopie_1_1tcp__socket_a6d9933c767572b03fbb4b5ced4bd1fc4}\label{classtacopie_1_1tcp__socket_a6d9933c767572b03fbb4b5ced4bd1fc4}} 
+\index{tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}!is\+\_\+ipv6@{is\+\_\+ipv6}}
+\index{is\+\_\+ipv6@{is\+\_\+ipv6}!tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}}
+\subsubsection{\texorpdfstring{is\+\_\+ipv6()}{is\_ipv6()}}
+{\footnotesize\ttfamily bool tacopie\+::tcp\+\_\+socket\+::is\+\_\+ipv6 (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}
+
+\begin{DoxyReturn}{Returns}
+whether the host is I\+P\+V6 
+\end{DoxyReturn}
 \mbox{\Hypertarget{classtacopie_1_1tcp__socket_af0957ded2a84fb06d940cba98df477fb}\label{classtacopie_1_1tcp__socket_af0957ded2a84fb06d940cba98df477fb}} 
 \index{tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}!listen@{listen}}
 \index{listen@{listen}!tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}}