From b446aff7e0b4f8021bf5e2ca71a6318900e1c961 Mon Sep 17 00:00:00 2001 From: Simon Ninon Date: Mon, 13 Nov 2017 23:40:13 -0800 Subject: [PATCH] update doxygen documentation --- .../classtacopie_1_1tcp__socket-members.html | 27 +++++++++--------- docs/html/classtacopie_1_1tcp__socket.html | 21 ++++++++++++++ docs/html/functions.html | 3 ++ docs/html/functions_func.html | 3 ++ docs/html/search/all_6.js | 1 + docs/html/search/functions_6.js | 1 + docs/html/tcp__socket_8hpp_source.html | 3 +- docs/latex/classtacopie_1_1logger.pdf | Bin 4883 -> 4883 bytes docs/latex/classtacopie_1_1logger__iface.pdf | Bin 4889 -> 4889 bytes docs/latex/classtacopie_1_1tacopie__error.pdf | Bin 4898 -> 4898 bytes docs/latex/classtacopie_1_1tcp__socket.tex | 11 +++++++ 11 files changed, 56 insertions(+), 14 deletions(-) diff --git a/docs/html/classtacopie_1_1tcp__socket-members.html b/docs/html/classtacopie_1_1tcp__socket-members.html index 82e4afe..3628328 100644 --- a/docs/html/classtacopie_1_1tcp__socket-members.html +++ b/docs/html/classtacopie_1_1tcp__socket-members.html @@ -80,19 +80,20 @@ get_host(void) consttacopie::tcp_socket get_port(void) consttacopie::tcp_socket get_type(void) consttacopie::tcp_socket - listen(std::size_t max_connection_queue)tacopie::tcp_socket - operator!=(const tcp_socket &rhs) consttacopie::tcp_socket - operator=(const tcp_socket &)=deletetacopie::tcp_socket - operator==(const tcp_socket &rhs) consttacopie::tcp_socket - recv(std::size_t size_to_read)tacopie::tcp_socket - send(const std::vector< char > &data, std::size_t size_to_write)tacopie::tcp_socket - set_type(type t)tacopie::tcp_socket - tcp_socket(void)tacopie::tcp_socket - tcp_socket(fd_t fd, const std::string &host, std::uint32_t port, type t)tacopie::tcp_socket - tcp_socket(tcp_socket &&)tacopie::tcp_socket - tcp_socket(const tcp_socket &)=deletetacopie::tcp_socket - type enum nametacopie::tcp_socket - ~tcp_socket(void)=defaulttacopie::tcp_socket + is_ipv6(void) consttacopie::tcp_socket + listen(std::size_t max_connection_queue)tacopie::tcp_socket + operator!=(const tcp_socket &rhs) consttacopie::tcp_socket + operator=(const tcp_socket &)=deletetacopie::tcp_socket + operator==(const tcp_socket &rhs) consttacopie::tcp_socket + recv(std::size_t size_to_read)tacopie::tcp_socket + send(const std::vector< char > &data, std::size_t size_to_write)tacopie::tcp_socket + set_type(type t)tacopie::tcp_socket + tcp_socket(void)tacopie::tcp_socket + tcp_socket(fd_t fd, const std::string &host, std::uint32_t port, type t)tacopie::tcp_socket + tcp_socket(tcp_socket &&)tacopie::tcp_socket + tcp_socket(const tcp_socket &)=deletetacopie::tcp_socket + type enum nametacopie::tcp_socket + ~tcp_socket(void)=defaulttacopie::tcp_socket
diff --git a/docs/html/classtacopie_1_1tcp__socket.html b/docs/html/classtacopie_1_1tcp__socket.html index 9940acd..91a48de 100644 --- a/docs/html/classtacopie_1_1tcp__socket.html +++ b/docs/html/classtacopie_1_1tcp__socket.html @@ -136,6 +136,8 @@   fd_t get_fd (void) const   +bool is_ipv6 (void) const + 

Detailed Description

tacopie::tcp_socket is the class providing low-level TCP socket features. The tcp_socket 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.

@@ -409,6 +411,25 @@

Returns
the type associated with the underlying socket.
+

+ + +

◆ is_ipv6()

+ +
+
+ + + + + + + + +
bool tacopie::tcp_socket::is_ipv6 (void ) const
+
+
Returns
whether the host is IPV6
+
diff --git a/docs/html/functions.html b/docs/html/functions.html index e484cfe..a0c8e7c 100644 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -193,6 +193,9 @@

- i -

  • is_connected() : tacopie::tcp_client
    • +
  • is_ipv6() +: tacopie::tcp_socket +
  • is_running() : tacopie::tcp_server , tacopie::utils::thread_pool diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html index 5ed1dee..006574d 100644 --- a/docs/html/functions_func.html +++ b/docs/html/functions_func.html @@ -171,6 +171,9 @@

    - i -

    • is_connected() : tacopie::tcp_client
      • +
    • is_ipv6() +: tacopie::tcp_socket +
    • is_running() : tacopie::tcp_server , tacopie::utils::thread_pool diff --git a/docs/html/search/all_6.js b/docs/html/search/all_6.js index aafc307..cd73c54 100644 --- a/docs/html/search/all_6.js +++ b/docs/html/search/all_6.js @@ -3,5 +3,6 @@ var searchData= ['info',['info',['../classtacopie_1_1logger__iface.html#af176525bca036944f75bad6469860929',1,'tacopie::logger_iface::info()'],['../classtacopie_1_1logger.html#a5089c5a6127586d4f2ea3a69a0bf6570',1,'tacopie::logger::info()']]], ['io_5fservice',['io_service',['../classtacopie_1_1io__service.html',1,'tacopie::io_service'],['../classtacopie_1_1io__service.html#a62edde9b62571610413d99d075df8102',1,'tacopie::io_service::io_service(std::size_t nb_threads=__TACOPIE_IO_SERVICE_NB_WORKERS)'],['../classtacopie_1_1io__service.html#ad5da7503d8fec083c6d28455ec9e21c7',1,'tacopie::io_service::io_service(const io_service &)=delete']]], ['is_5fconnected',['is_connected',['../classtacopie_1_1tcp__client.html#a9bf568812c8350260843842e7952c8c3',1,'tacopie::tcp_client']]], + ['is_5fipv6',['is_ipv6',['../classtacopie_1_1tcp__socket.html#a6d9933c767572b03fbb4b5ced4bd1fc4',1,'tacopie::tcp_socket']]], ['is_5frunning',['is_running',['../classtacopie_1_1tcp__server.html#a76162141e6443953f3ad8e11c4e4d3d7',1,'tacopie::tcp_server::is_running()'],['../classtacopie_1_1utils_1_1thread__pool.html#a77a647a75be188a5c5f83b922c061107',1,'tacopie::utils::thread_pool::is_running()']]] ]; diff --git a/docs/html/search/functions_6.js b/docs/html/search/functions_6.js index 342e37a..2e755bc 100644 --- a/docs/html/search/functions_6.js +++ b/docs/html/search/functions_6.js @@ -3,5 +3,6 @@ var searchData= ['info',['info',['../classtacopie_1_1logger__iface.html#af176525bca036944f75bad6469860929',1,'tacopie::logger_iface::info()'],['../classtacopie_1_1logger.html#a5089c5a6127586d4f2ea3a69a0bf6570',1,'tacopie::logger::info()']]], ['io_5fservice',['io_service',['../classtacopie_1_1io__service.html#a62edde9b62571610413d99d075df8102',1,'tacopie::io_service::io_service(std::size_t nb_threads=__TACOPIE_IO_SERVICE_NB_WORKERS)'],['../classtacopie_1_1io__service.html#ad5da7503d8fec083c6d28455ec9e21c7',1,'tacopie::io_service::io_service(const io_service &)=delete']]], ['is_5fconnected',['is_connected',['../classtacopie_1_1tcp__client.html#a9bf568812c8350260843842e7952c8c3',1,'tacopie::tcp_client']]], + ['is_5fipv6',['is_ipv6',['../classtacopie_1_1tcp__socket.html#a6d9933c767572b03fbb4b5ced4bd1fc4',1,'tacopie::tcp_socket']]], ['is_5frunning',['is_running',['../classtacopie_1_1tcp__server.html#a76162141e6443953f3ad8e11c4e4d3d7',1,'tacopie::tcp_server::is_running()'],['../classtacopie_1_1utils_1_1thread__pool.html#a77a647a75be188a5c5f83b922c061107',1,'tacopie::utils::thread_pool::is_running()']]] ]; diff --git a/docs/html/tcp__socket_8hpp_source.html b/docs/html/tcp__socket_8hpp_source.html index 10e60d8..1ac3b2e 100644 --- a/docs/html/tcp__socket_8hpp_source.html +++ b/docs/html/tcp__socket_8hpp_source.html @@ -69,7 +69,8 @@
      tcp_socket.hpp
      -
      1 // MIT License
      2 //
      3 // Copyright (c) 2016-2017 Simon Ninon <simon.ninon@gmail.com>
      4 //
      5 // Permission is hereby granted, free of charge, to any person obtaining a copy
      6 // of this software and associated documentation files (the "Software"), to deal
      7 // in the Software without restriction, including without limitation the rights
      8 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
      9 // copies of the Software, and to permit persons to whom the Software is
      10 // furnished to do so, subject to the following conditions:
      11 //
      12 // The above copyright notice and this permission notice shall be included in all
      13 // copies or substantial portions of the Software.
      14 //
      15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
      16 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
      17 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
      18 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
      19 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
      20 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
      21 // SOFTWARE.
      22 
      23 #pragma once
      24 
      25 #include <cstdint>
      26 #include <string>
      27 #include <vector>
      28 
      29 #include <tacopie/utils/typedefs.hpp>
      30 
      31 namespace tacopie {
      32 
      38 class tcp_socket {
      39 public:
      46  enum class type {
      47  CLIENT,
      48  SERVER,
      49  UNKNOWN
      50  };
      51 
      52 public:
      54  tcp_socket(void);
      56  ~tcp_socket(void) = default;
      57 
      66  tcp_socket(fd_t fd, const std::string& host, std::uint32_t port, type t);
      67 
      69  tcp_socket(tcp_socket&&);
      70 
      72  tcp_socket(const tcp_socket&) = delete;
      74  tcp_socket& operator=(const tcp_socket&) = delete;
      75 
      76 public:
      82  bool operator==(const tcp_socket& rhs) const;
      83 
      89  bool operator!=(const tcp_socket& rhs) const;
      90 
      91 public:
      99  std::vector<char> recv(std::size_t size_to_read);
      100 
      109  std::size_t send(const std::vector<char>& data, std::size_t size_to_write);
      110 
      119  void connect(const std::string& host, std::uint32_t port, std::uint32_t timeout_msecs = 0);
      120 
      128  void bind(const std::string& host, std::uint32_t port);
      129 
      136  void listen(std::size_t max_connection_queue);
      137 
      144  tcp_socket accept(void);
      145 
      149  void close(void);
      150 
      151 public:
      155  const std::string& get_host(void) const;
      156 
      160  std::uint32_t get_port(void) const;
      161 
      165  type get_type(void) const;
      166 
      173  void set_type(type t);
      174 
      180  fd_t get_fd(void) const;
      181 
      182 private:
      186  void create_socket_if_necessary(void);
      187 
      194  void check_or_set_type(type t);
      195 
      196 private:
      200  fd_t m_fd;
      201 
      205  std::string m_host;
      209  std::uint32_t m_port;
      210 
      214  type m_type;
      215 };
      216 
      217 } // namespace tacopie
      tacopie::tcp_socket::get_type
      type get_type(void) const
      +
      1 // MIT License
      2 //
      3 // Copyright (c) 2016-2017 Simon Ninon <simon.ninon@gmail.com>
      4 //
      5 // Permission is hereby granted, free of charge, to any person obtaining a copy
      6 // of this software and associated documentation files (the "Software"), to deal
      7 // in the Software without restriction, including without limitation the rights
      8 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
      9 // copies of the Software, and to permit persons to whom the Software is
      10 // furnished to do so, subject to the following conditions:
      11 //
      12 // The above copyright notice and this permission notice shall be included in all
      13 // copies or substantial portions of the Software.
      14 //
      15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
      16 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
      17 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
      18 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
      19 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
      20 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
      21 // SOFTWARE.
      22 
      23 #pragma once
      24 
      25 #include <cstdint>
      26 #include <string>
      27 #include <vector>
      28 
      29 #include <tacopie/utils/typedefs.hpp>
      30 
      31 namespace tacopie {
      32 
      38 class tcp_socket {
      39 public:
      46  enum class type {
      47  CLIENT,
      48  SERVER,
      49  UNKNOWN
      50  };
      51 
      52 public:
      54  tcp_socket(void);
      56  ~tcp_socket(void) = default;
      57 
      66  tcp_socket(fd_t fd, const std::string& host, std::uint32_t port, type t);
      67 
      69  tcp_socket(tcp_socket&&);
      70 
      72  tcp_socket(const tcp_socket&) = delete;
      74  tcp_socket& operator=(const tcp_socket&) = delete;
      75 
      76 public:
      82  bool operator==(const tcp_socket& rhs) const;
      83 
      89  bool operator!=(const tcp_socket& rhs) const;
      90 
      91 public:
      99  std::vector<char> recv(std::size_t size_to_read);
      100 
      109  std::size_t send(const std::vector<char>& data, std::size_t size_to_write);
      110 
      119  void connect(const std::string& host, std::uint32_t port, std::uint32_t timeout_msecs = 0);
      120 
      128  void bind(const std::string& host, std::uint32_t port);
      129 
      136  void listen(std::size_t max_connection_queue);
      137 
      144  tcp_socket accept(void);
      145 
      149  void close(void);
      150 
      151 public:
      155  const std::string& get_host(void) const;
      156 
      160  std::uint32_t get_port(void) const;
      161 
      165  type get_type(void) const;
      166 
      173  void set_type(type t);
      174 
      180  fd_t get_fd(void) const;
      181 
      182 public:
      186  bool is_ipv6(void) const;
      187 
      188 private:
      192  void create_socket_if_necessary(void);
      193 
      200  void check_or_set_type(type t);
      201 
      202 private:
      206  fd_t m_fd;
      207 
      211  std::string m_host;
      215  std::uint32_t m_port;
      216 
      220  type m_type;
      221 };
      222 
      223 } // namespace tacopie
      tacopie::tcp_socket::get_type
      type get_type(void) const
      +
      tacopie::tcp_socket::is_ipv6
      bool is_ipv6(void) const
      tacopie::tcp_socket::connect
      void connect(const std::string &host, std::uint32_t port, std::uint32_t timeout_msecs=0)
      tacopie::tcp_socket::set_type
      void set_type(type t)
      tacopie::tcp_socket::accept
      tcp_socket accept(void)
      diff --git a/docs/latex/classtacopie_1_1logger.pdf b/docs/latex/classtacopie_1_1logger.pdf index e0707f61d84e88e5d152ba28c81000509926fc0e..8951a4376602eb2e72b3bda76dc152fb0cec0509 100644 GIT binary patch delta 326 zcmaiuy9&ZU6huk8m}o4uPNG8a-o2a01_{Jhr-Im8C?<%FU{d%Q!dm+YBKU9Cik+}v zJLfPn%2n=TUu(v@ybxTH56HJZVnM25w$!zD(4(b|=p(H-B_xwT_z}k@wS?Vj= zYHp=Ebh9E|{Q2`V>Mx^@h{TEHchv*%x~xAt?#7!c?~D@;82uPe*S;8Q1Szr@WyZr0 ohY(OU$29Hp3l7)qtfsv_hN@B8!uAyO?(PRN$smW7#vam}92^v`H8kvO{8d;fG zSQ(pY8yHP4=GDR?x{kLPyAjfp{rK##NzLOk$0iJP&t^vcZ;bi|mPTfVMkW?uTh$E= z)HS*Eee+XX5=&AwT&#=?49!tgY*rJTz!>Xh;bv%QWNP4SXklUG=;CZ=Lr_I5mz^C~aYn7XV0SP#6FJ diff --git a/docs/latex/classtacopie_1_1logger__iface.pdf b/docs/latex/classtacopie_1_1logger__iface.pdf index 0292e493cebcb4afddd555d8673126f9acd27e2f..d0265b63953886a49a9b4dc47f597a4bb0f46f2d 100644 GIT binary patch delta 303 zcmbQKHdAdw9*>Yks)c!qrJ=E|fuT{7uAyO?@#F@c7VN@OlMQ$+1Pu*!4UI#LjIE3< ztxQdI4J;;C@@iob-NIXp%a~w3du&om_{^~hH}FVpX6OILsBdU!Xl!I`Yzeki-M~Oy zlS|(>KgA`nBvr%3%E-Xb97V-u9l;5VPDZX~E`}D)7LFzsF6K_ICT51FE|$i|j;=07 SmZs(gj&?SLR80OSBny4U8sN@@iob-NIXp%a~w3du&om_{^~hH}FVpX6OILsBd6tWM*h&Vga^Q-M~Oy zlS|(>KgA`nBvr%3%E-Xb97V-u9l;5VPHrx)j!uqFh9+(%ZjPoFriR95PUdC?CKk>{ Sjuxh7&UQA0R80OSBn<$W^-Qn; diff --git a/docs/latex/classtacopie_1_1tacopie__error.pdf b/docs/latex/classtacopie_1_1tacopie__error.pdf index 288cbf5f6b7f47810bacb24db58435a2c1b0bee4..50f790be87b45268c4d1e902f6f4795c36308ff8 100644 GIT binary patch delta 326 zcmZ3awn%M5IggMYyAjfpWBKf`Nv-8G$0iJP&t?JsZ;bkehK9yQ#>SRlTh$E= z)HS*Eee+XX5=&AwT&#=?49!tgY&I2~z!+<3WMSzH)aUGGV&Ldz>}KHN=IZ9^=wjk# o>gw!bVqj-OP(>`4ogG(kNn%k+MNw)Rmx+m)DVM6MtG^o;0G^Rh6#xJL delta 326 zcmZ3awn%M5Ige0sl7)qtfsv_hN@B8!uAyO?(PVjEsmY6Zvam}92^v`H8kvO{8d;fG zSQ(pY8yHP);?=?;x|g>YyAjfpWBKf`Nv-8G$0iJP&t?JsZ;bi|mPTfVMkW?uTh$E= z)HS*Eee+XX5=&AwT&#=?49!tgY&I2~z!>XfY-(iW;_T*RYGUYWWNBvMVqxKC>}+D@ pW^Cl*Vq#!tLr_I5mz^C~aYn7XTh0QA7X$ diff --git a/docs/latex/classtacopie_1_1tcp__socket.tex b/docs/latex/classtacopie_1_1tcp__socket.tex index 69cb6ae..325a7c4 100644 --- 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}}