From 1fa58db0836b289782b20b95866d412a7f3bbc7e Mon Sep 17 00:00:00 2001 From: Simon Ninon Date: Mon, 25 Sep 2017 19:58:23 +0200 Subject: [PATCH] remove private/protected/static members from documentation --- .doxygen | 6 +- docs/html/annotated.html | 29 +- docs/html/classes.html | 21 +- .../classtacopie_1_1io__service-members.html | 37 +- docs/html/classtacopie_1_1io__service.html | 671 +----------------- docs/html/classtacopie_1_1logger-members.html | 4 +- docs/html/classtacopie_1_1logger.html | 216 +----- ...classtacopie_1_1logger__iface-members.html | 2 +- docs/html/classtacopie_1_1logger__iface.html | 137 +--- .../classtacopie_1_1self__pipe-members.html | 13 +- docs/html/classtacopie_1_1self__pipe.html | 159 +---- ...lasstacopie_1_1tacopie__error-members.html | 4 +- docs/html/classtacopie_1_1tacopie__error.html | 200 +----- .../classtacopie_1_1tcp__client-members.html | 51 +- docs/html/classtacopie_1_1tcp__client.html | 555 +-------------- .../classtacopie_1_1tcp__server-members.html | 12 +- docs/html/classtacopie_1_1tcp__server.html | 348 +-------- .../classtacopie_1_1tcp__socket-members.html | 12 +- docs/html/classtacopie_1_1tcp__socket.html | 345 +-------- ...opie_1_1utils_1_1thread__pool-members.html | 27 +- ...classtacopie_1_1utils_1_1thread__pool.html | 343 +-------- .../dir_09e761304027c904456130627fd4dcf5.html | 6 - .../dir_1619eefbac1db14eaf18adaf83ce3ccc.html | 14 - .../dir_38b559f7600c1df65fbc4b39f02eb3f8.html | 12 - .../dir_9a013686e2522dd95763481288c1f90f.html | 4 - docs/html/error_8hpp_source.html | 5 +- docs/html/files.html | 20 +- docs/html/functions.html | 236 +----- docs/html/functions_func.html | 88 +-- docs/html/hierarchy.html | 5 +- docs/html/io__service_8hpp_source.html | 34 +- docs/html/logger_8hpp_source.html | 6 +- docs/html/menudata.js | 27 +- docs/html/search/all_0.js | 11 +- docs/html/search/all_1.js | 10 +- docs/html/search/all_2.js | 5 +- docs/html/search/all_3.js | 12 +- docs/html/search/all_4.js | 5 +- docs/html/search/all_5.js | 14 +- docs/html/search/all_6.js | 6 +- docs/html/search/all_7.js | 16 +- docs/html/search/all_8.js | 9 +- docs/html/search/all_9.js | 10 +- docs/html/search/all_a.js | 40 +- docs/html/search/all_b.js | 9 +- docs/html/search/all_c.js | 16 +- docs/html/search/all_d.js | 10 +- docs/html/search/all_e.js | 13 +- docs/html/search/classes_4.js | 3 +- docs/html/search/functions_2.js | 7 +- docs/html/search/functions_3.js | 2 +- docs/html/search/functions_4.js | 2 +- docs/html/search/functions_5.js | 12 +- docs/html/search/functions_6.js | 16 +- docs/html/search/functions_7.js | 8 +- docs/html/search/functions_8.js | 4 +- docs/html/search/functions_9.js | 5 +- docs/html/search/functions_a.js | 8 +- docs/html/search/functions_b.js | 14 +- docs/html/search/functions_c.js | 8 +- docs/html/search/functions_d.js | 14 +- docs/html/search/functions_e.js | 15 +- docs/html/search/searchdata.js | 35 +- docs/html/search/typedefs_3.js | 2 +- docs/html/search/typedefs_4.js | 2 +- docs/html/self__pipe_8hpp_source.html | 5 +- ...1tcp__client_1_1read__request-members.html | 6 +- ...copie_1_1tcp__client_1_1read__request.html | 39 +- ..._1tcp__client_1_1read__result-members.html | 6 +- ...acopie_1_1tcp__client_1_1read__result.html | 39 +- ...tcp__client_1_1write__request-members.html | 6 +- ...opie_1_1tcp__client_1_1write__request.html | 39 +- ...1tcp__client_1_1write__result-members.html | 6 +- ...copie_1_1tcp__client_1_1write__result.html | 39 +- docs/html/tcp__client_8hpp_source.html | 30 +- docs/html/tcp__server_8hpp_source.html | 15 +- docs/html/tcp__socket_8hpp_source.html | 13 +- docs/html/thread__pool_8hpp_source.html | 11 +- docs/html/typedefs_8hpp_source.html | 3 +- docs/latex/annotated.tex | 1 - docs/latex/classtacopie_1_1io__service.tex | 240 +------ docs/latex/classtacopie_1_1logger.pdf | Bin 4883 -> 4883 bytes docs/latex/classtacopie_1_1logger.tex | 101 +-- docs/latex/classtacopie_1_1logger__iface.pdf | Bin 4889 -> 4889 bytes docs/latex/classtacopie_1_1logger__iface.tex | 49 +- docs/latex/classtacopie_1_1self__pipe.tex | 77 +- docs/latex/classtacopie_1_1tacopie__error.pdf | Bin 4898 -> 4898 bytes docs/latex/classtacopie_1_1tacopie__error.tex | 71 +- docs/latex/classtacopie_1_1tcp__client.tex | 214 +----- docs/latex/classtacopie_1_1tcp__server.tex | 136 +--- docs/latex/classtacopie_1_1tcp__socket.tex | 155 +--- .../classtacopie_1_1utils_1_1thread__pool.tex | 129 +--- .../dir_09e761304027c904456130627fd4dcf5.tex | 5 - .../dir_1619eefbac1db14eaf18adaf83ce3ccc.tex | 13 - .../dir_38b559f7600c1df65fbc4b39f02eb3f8.tex | 11 - .../dir_9a013686e2522dd95763481288c1f90f.tex | 4 - docs/latex/hierarchy.tex | 1 - docs/latex/refman.tex | 18 - ...acopie_1_1tcp__client_1_1read__request.tex | 23 +- ...tacopie_1_1tcp__client_1_1read__result.tex | 23 +- ...copie_1_1tcp__client_1_1write__request.tex | 23 +- ...acopie_1_1tcp__client_1_1write__result.tex | 23 +- 102 files changed, 536 insertions(+), 5030 deletions(-) diff --git a/.doxygen b/.doxygen index 5cb493e..fa1128a 100644 --- a/.doxygen +++ b/.doxygen @@ -435,13 +435,13 @@ LOOKUP_CACHE_SIZE = 0 # normally produced when WARNINGS is set to YES. # The default value is: NO. -EXTRACT_ALL = YES +EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. -EXTRACT_PRIVATE = YES +EXTRACT_PRIVATE = NO # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. @@ -453,7 +453,7 @@ EXTRACT_PACKAGE = NO # included in the documentation. # The default value is: NO. -EXTRACT_STATIC = YES +EXTRACT_STATIC = NO # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, diff --git a/docs/html/annotated.html b/docs/html/annotated.html index 9047a62..35d7812 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -67,22 +67,21 @@
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123]
- - + + - - - - - - - - - - - - - + + + + + + + + + + + +
 ▼Ntacopie
 ▼Nutils
 ▼Ntacopie
 ▼Nutils
 Cthread_pool
 ▼Cio_service
 Ctracked_socket
 Clogger
 Clogger_iface
 Cself_pipe
 Ctacopie_error
 ▼Ctcp_client
 Cread_request
 Cread_result
 Cwrite_request
 Cwrite_result
 Ctcp_server
 Ctcp_socket
 Cio_service
 Clogger
 Clogger_iface
 Cself_pipe
 Ctacopie_error
 ▼Ctcp_client
 Cread_request
 Cread_result
 Cwrite_request
 Cwrite_result
 Ctcp_server
 Ctcp_socket
diff --git a/docs/html/classes.html b/docs/html/classes.html index f87a39e..b24cb19 100644 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -68,19 +68,18 @@
i | l | r | s | t | w
+ - + + - - - - + + + +
  i  
-		logger_iface (tacopie)   
  t  
-		thread_pool (tacopie::utils)   
logger_iface (tacopie)   
  s  
+		tcp_client (tacopie)   tcp_client::write_result (tacopie)   
  r  
-		io_service::tracked_socket (tacopie)   
io_service (tacopie)   tacopie_error (tacopie)   
  w  
-
tcp_server (tacopie)   
io_service (tacopie)   self_pipe (tacopie)   tcp_socket (tacopie)   
  l  
-		tcp_client::read_request (tacopie)   tcp_client (tacopie)   
tcp_client::read_result (tacopie)   tcp_server (tacopie)   tcp_client::write_request (tacopie)   
logger (tacopie)   
  s  
-		tcp_socket (tacopie)   tcp_client::write_result (tacopie)   
self_pipe (tacopie)   
tcp_client::read_request (tacopie)   
  t  
+		thread_pool (tacopie::utils)   
tcp_client::read_result (tacopie)   
  w  
+
logger (tacopie)   tacopie_error (tacopie)   
tcp_client::write_request (tacopie)   
i | l | r | s | t | w
diff --git a/docs/html/classtacopie_1_1io__service-members.html b/docs/html/classtacopie_1_1io__service-members.html index 8756d9e..a6dcaaf 100644 --- a/docs/html/classtacopie_1_1io__service-members.html +++ b/docs/html/classtacopie_1_1io__service-members.html @@ -61,7 +61,7 @@
@@ -73,31 +73,16 @@

This is the complete list of members for tacopie::io_service, including all inherited members.

- - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + +
event_callback_t typedeftacopie::io_service
init_poll_fds_info(void)tacopie::io_serviceprivate
io_service(std::size_t nb_threads=__TACOPIE_IO_SERVICE_NB_WORKERS)tacopie::io_service
io_service(const io_service &)=deletetacopie::io_service
m_callback_workerstacopie::io_serviceprivate
m_notifiertacopie::io_serviceprivate
m_poll_workertacopie::io_serviceprivate
m_polled_fdstacopie::io_serviceprivate
m_rd_settacopie::io_serviceprivate
m_should_stoptacopie::io_serviceprivate
m_tracked_socketstacopie::io_serviceprivate
m_tracked_sockets_mtxtacopie::io_serviceprivate
m_wait_for_removal_condvartacopie::io_serviceprivate
m_wr_settacopie::io_serviceprivate
operator=(const io_service &)=deletetacopie::io_service
poll(void)tacopie::io_serviceprivate
process_events(void)tacopie::io_serviceprivate
process_rd_event(const fd_t &fd, tracked_socket &socket)tacopie::io_serviceprivate
process_wr_event(const fd_t &fd, tracked_socket &socket)tacopie::io_serviceprivate
set_nb_workers(std::size_t nb_threads)tacopie::io_service
set_rd_callback(const tcp_socket &socket, const event_callback_t &event_callback)tacopie::io_service
set_wr_callback(const tcp_socket &socket, const event_callback_t &event_callback)tacopie::io_service
track(const tcp_socket &socket, const event_callback_t &rd_callback=nullptr, const event_callback_t &wr_callback=nullptr)tacopie::io_service
untrack(const tcp_socket &socket)tacopie::io_service
wait_for_removal(const tcp_socket &socket)tacopie::io_service
~io_service(void)tacopie::io_service
io_service(std::size_t nb_threads=__TACOPIE_IO_SERVICE_NB_WORKERS)tacopie::io_service
io_service(const io_service &)=deletetacopie::io_service
operator=(const io_service &)=deletetacopie::io_service
set_nb_workers(std::size_t nb_threads)tacopie::io_service
set_rd_callback(const tcp_socket &socket, const event_callback_t &event_callback) (defined in tacopie::io_service)tacopie::io_service
set_wr_callback(const tcp_socket &socket, const event_callback_t &event_callback) (defined in tacopie::io_service)tacopie::io_service
track(const tcp_socket &socket, const event_callback_t &rd_callback=nullptr, const event_callback_t &wr_callback=nullptr)tacopie::io_service
untrack(const tcp_socket &socket) (defined in tacopie::io_service)tacopie::io_service
wait_for_removal(const tcp_socket &socket)tacopie::io_service
~io_service(void)tacopie::io_service
diff --git a/docs/html/classtacopie_1_1io__service.html b/docs/html/classtacopie_1_1io__service.html index 8f85aaf..0b160a8 100644 --- a/docs/html/classtacopie_1_1io__service.html +++ b/docs/html/classtacopie_1_1io__service.html @@ -61,7 +61,7 @@
@@ -69,8 +69,6 @@ Classes | Public Types | Public Member Functions | -Private Member Functions | -Private Attributes | List of all members
tacopie::io_service Class Reference
@@ -79,78 +77,44 @@

#include <io_service.hpp>

- - - -

-Classes

struct  tracked_socket
 
- +

Public Types

typedef std::function< void(fd_t)> event_callback_t
typedef std::function< void(fd_t)> event_callback_t
 
- + - - + + - - + + - - + + - - + + - + - + - + -

Public Member Functions

 io_service (std::size_t nb_threads=__TACOPIE_IO_SERVICE_NB_WORKERS)
 io_service (std::size_t nb_threads=__TACOPIE_IO_SERVICE_NB_WORKERS)
 
 ~io_service (void)
 dtor More...
+ ~io_service (void)
 dtor
 
 io_service (const io_service &)=delete
 copy ctor More...
+ io_service (const io_service &)=delete
 copy ctor
 
io_service & operator= (const io_service &)=delete
 assignment operator More...
+io_service & operator= (const io_service &)=delete
 assignment operator
 
void set_nb_workers (std::size_t nb_threads)
 
void track (const tcp_socket &socket, const event_callback_t &rd_callback=nullptr, const event_callback_t &wr_callback=nullptr)
 track & untrack socket More...
+void track (const tcp_socket &socket, const event_callback_t &rd_callback=nullptr, const event_callback_t &wr_callback=nullptr)
 track & untrack socket
 
void set_rd_callback (const tcp_socket &socket, const event_callback_t &event_callback)
+void set_rd_callback (const tcp_socket &socket, const event_callback_t &event_callback)
 
void set_wr_callback (const tcp_socket &socket, const event_callback_t &event_callback)
+void set_wr_callback (const tcp_socket &socket, const event_callback_t &event_callback)
 
void untrack (const tcp_socket &socket)
+void untrack (const tcp_socket &socket)
 
void wait_for_removal (const tcp_socket &socket)
 
- - - - - - - - - - - -

-Private Member Functions

void poll (void)
 
int init_poll_fds_info (void)
 
void process_events (void)
 
void process_rd_event (const fd_t &fd, tracked_socket &socket)
 
void process_wr_event (const fd_t &fd, tracked_socket &socket)
 
- - - - - - - - - - - - - - - - - - - - -

-Private Attributes

std::unordered_map< fd_t, tracked_socket > m_tracked_sockets
 
std::atomic< bool > m_should_stop
 
std::thread m_poll_worker
 
utils::thread_pool m_callback_workers
 
std::mutex m_tracked_sockets_mtx
 
std::vector< fd_t > m_polled_fds
 
fd_set m_rd_set
 
fd_set m_wr_set
 
std::condition_variable m_wait_for_removal_condvar
 
tacopie::self_pipe m_notifier
 

Detailed Description

service that operates IO Handling. It polls sockets for input and output, processes read and write operations and calls the appropriate callbacks.

@@ -162,7 +126,7 @@

- +
typedef std::function<void(fd_t)> tacopie::io_service::event_callback_ttypedef std::function<void(fd_t)> tacopie::io_service::event_callback_t

@@ -172,7 +136,7 @@

Constructor & Destructor Documentation

-

◆ io_service() [1/2]

+

◆ io_service()

@@ -181,7 +145,7 @@

tacopie::io_service::io_service ( std::size_t  - nb_threads = __TACOPIE_IO_SERVICE_NB_WORKERS) + nb_threads = __TACOPIE_IO_SERVICE_NB_WORKERS) @@ -194,255 +158,9 @@

-

◆ ~io_service()

- -
-
- - - - - - - - -
tacopie::io_service::~io_service (void )
-
- -

dtor

- -
-
- -

◆ io_service() [2/2]

- -
-
- - - - - -
- - - - - - - - -
tacopie::io_service::io_service (const io_service & )
- 		-delete
-
- -

copy ctor

-

Member Function Documentation

- -

◆ init_poll_fds_info()

- -
-
- - - - - -
- - - - - - - - -
int tacopie::io_service::init_poll_fds_info (void )
- 		-private
-
-

init m_poll_fds_info simply initialize m_polled_fds variable based on m_tracked_sockets information

-
Returns
maximum fd value polled
- -
-
- -

◆ operator=()

- -
-
- - - - - -
- - - - - - - - -
io_service& tacopie::io_service::operator= (const io_service & )
- 		-delete
-
- -

assignment operator

- -
-
- -

◆ poll()

- -
-
- - - - - -
- - - - - - - - -
void tacopie::io_service::poll (void )
- 		-private
-
-

poll worker function main loop of the background thread in charge of the io_service in charge of polling fds

- -
-
- -

◆ process_events()

- -
-
- - - - - -
- - - - - - - - -
void tacopie::io_service::process_events (void )
- 		-private
-
-

process poll detected events called whenever select/poll completed to check read and write availablity

- -
-
- -

◆ process_rd_event()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
void tacopie::io_service::process_rd_event (const fd_t & fd,
tracked_socket & socket 
)
- 		-private
-
-

process read event reported by select/poll for a given socket

-
Parameters
- - - -
fdfd for which a read event has been reported
sockettracked_socket associated to the given fd
-
-
- -
-
- -

◆ process_wr_event()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
void tacopie::io_service::process_wr_event (const fd_t & fd,
tracked_socket & socket 
)
- 		-private
-
-

process write event reported by select/poll for a given socket

-
Parameters
- - - -
fdfd for which a write event has been reported
sockettracked_socket associated to the given fd
-
-
- -
-

◆ set_nb_workers()

@@ -466,116 +184,6 @@

-

◆ set_rd_callback()

- -
-
- - - - - - - - - - - - - - - - - - -
void tacopie::io_service::set_rd_callback (const tcp_socket & socket,
const event_callback_t & event_callback 
)
-
- -
-
- -

◆ set_wr_callback()

- -
-
- - - - - - - - - - - - - - - - - - -
void tacopie::io_service::set_wr_callback (const tcp_socket & socket,
const event_callback_t & event_callback 
)
-
- -
-
- -

◆ track()

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - -
void tacopie::io_service::track (const tcp_socket & socket,
const event_callback_t & rd_callback = nullptr,
const event_callback_t & wr_callback = nullptr 
)
-
- -

track & untrack socket

- -
-
- -

◆ untrack()

- -
-
- - - - - - - - -
void tacopie::io_service::untrack (const tcp_socket & socket)
-
-
@@ -595,237 +203,6 @@

wait until the socket has been effectively removed basically wait until all pending callbacks are executed

-

-
-

Member Data Documentation

- -

◆ m_callback_workers

- -
-
- - - - - -
- - - - -
utils::thread_pool tacopie::io_service::m_callback_workers
- 		-private
-
-

callback workers

- -
-
- -

◆ m_notifier

- -
-
- - - - - -
- - - - -
tacopie::self_pipe tacopie::io_service::m_notifier
- 		-private
-
-

fd associated to the pipe used to wake up the poll call

- -
-
- -

◆ m_poll_worker

- -
-
- - - - - -
- - - - -
std::thread tacopie::io_service::m_poll_worker
- 		-private
-
-

poll thread

- -
-
- -

◆ m_polled_fds

- -
-
- - - - - -
- - - - -
std::vector<fd_t> tacopie::io_service::m_polled_fds
- 		-private
-
-

data structure given to select (list of fds to poll)

- -
-
- -

◆ m_rd_set

- -
-
- - - - - -
- - - - -
fd_set tacopie::io_service::m_rd_set
- 		-private
-
-

data structure given to select (list of fds to poll for read)

- -
-
- -

◆ m_should_stop

- -
-
- - - - - -
- - - - -
std::atomic<bool> tacopie::io_service::m_should_stop
- 		-private
-
-

whether the worker should stop or not

- -
-
- -

◆ m_tracked_sockets

- -
-
- - - - - -
- - - - -
std::unordered_map<fd_t, tracked_socket> tacopie::io_service::m_tracked_sockets
- 		-private
-
-

tracked sockets

- -
-
- -

◆ m_tracked_sockets_mtx

- -
-
- - - - - -
- - - - -
std::mutex tacopie::io_service::m_tracked_sockets_mtx
- 		-private
-
-

thread safety

- -
-
- -

◆ m_wait_for_removal_condvar

- -
-
- - - - - -
- - - - -
std::condition_variable tacopie::io_service::m_wait_for_removal_condvar
- 		-private
-
-

condition variable to wait on removal

- -
-
- -

◆ m_wr_set

- -
-
- - - - - -
- - - - -
fd_set tacopie::io_service::m_wr_set
- 		-private
-
-

data structure given to select (list of fds to poll for write)

-
The documentation for this class was generated from the following file:
    diff --git a/docs/html/classtacopie_1_1logger-members.html b/docs/html/classtacopie_1_1logger-members.html index b3b57f7..d3744e0 100644 --- a/docs/html/classtacopie_1_1logger-members.html +++ b/docs/html/classtacopie_1_1logger-members.html @@ -61,7 +61,7 @@
@@ -80,8 +80,6 @@ logger(const logger &)=defaulttacopie::logger logger_iface(void)=defaulttacopie::logger_iface logger_iface(const logger_iface &)=defaulttacopie::logger_iface - m_leveltacopie::loggerprivate - m_mutextacopie::loggerprivate operator=(const logger &)=defaulttacopie::logger tacopie::logger_iface::operator=(const logger_iface &)=defaulttacopie::logger_iface warn(const std::string &msg, const std::string &file, std::size_t line)tacopie::loggervirtual diff --git a/docs/html/classtacopie_1_1logger.html b/docs/html/classtacopie_1_1logger.html index 14da227..53ff099 100644 --- a/docs/html/classtacopie_1_1logger.html +++ b/docs/html/classtacopie_1_1logger.html @@ -61,14 +61,13 @@
Public Types | Public Member Functions | -Private Attributes | List of all members
tacopie::logger Class Reference
@@ -88,26 +87,30 @@ -

Public Types

enum  log_level { log_level::error = 0, -log_level::warn = 1, -log_level::info = 2, -log_level::debug = 3 +
enum  log_level { error = 0, +warn = 1, +info = 2, +debug = 3 }
 
- - + + - - + + - - + + - - + + @@ -118,25 +121,22 @@ - - + + - - + + - - + + - - + + -

Public Member Functions

 logger (log_level level=log_level::info)
 ctor More...
+ logger (log_level level=log_level::info)
 ctor
 
 ~logger (void)=default
 dtor More...
+ ~logger (void)=default
 dtor
 
 logger (const logger &)=default
 copy ctor More...
+ logger (const logger &)=default
 copy ctor
 
logger & operator= (const logger &)=default
 assignment operator More...
+logger & operator= (const logger &)=default
 assignment operator
 
void debug (const std::string &msg, const std::string &file, std::size_t line)
 
void error (const std::string &msg, const std::string &file, std::size_t line)
 
- Public Member Functions inherited from tacopie::logger_iface
 logger_iface (void)=default
 ctor More...
+ logger_iface (void)=default
 ctor
 
virtual ~logger_iface (void)=default
 dtor More...
+virtual ~logger_iface (void)=default
 dtor
 
 logger_iface (const logger_iface &)=default
 copy ctor More...
+ logger_iface (const logger_iface &)=default
 copy ctor
 
logger_iface & operator= (const logger_iface &)=default
 assignment operator More...
+logger_iface & operator= (const logger_iface &)=default
 assignment operator
 
- - - - -

-Private Attributes

log_level m_level
 
std::mutex m_mutex
 

Detailed Description

default logger class provided by the library

@@ -161,89 +161,6 @@

log level

- - - - - -
Enumerator
error 
warn 
info 
debug 
- -

-
-

Constructor & Destructor Documentation

- -

◆ logger() [1/2]

- -
-
- - - - - - - - -
tacopie::logger::logger (log_level level = log_level::info)
-
- -

ctor

- -
-
- -

◆ ~logger()

- -
-
- - - - - -
- - - - - - - - -
tacopie::logger::~logger (void )
- 		-default
-
- -

dtor

- -
-
- -

◆ logger() [2/2]

- -
-
- - - - - -
- - - - - - - - -
tacopie::logger::logger (const logger & )
- 		-default
-
- -

copy ctor

@@ -405,34 +322,6 @@

tacopie::logger_iface.

- - - -

◆ operator=()

- -
-
- - - - - -
- - - - - - - - -
logger& tacopie::logger::operator= (const logger & )
- 		-default
-
- -

assignment operator

-
@@ -486,53 +375,6 @@

tacopie::logger_iface.

- - -

Member Data Documentation

- -

◆ m_level

- -
-
- - - - - -
- - - - -
log_level tacopie::logger::m_level
- 		-private
-
-

current log level in use

- -
-
- -

◆ m_mutex

- -
-
- - - - - -
- - - - -
std::mutex tacopie::logger::m_mutex
- 		-private
-
-

mutex used to serialize logs in multithreaded environment

-
The documentation for this class was generated from the following file:
    diff --git a/docs/html/classtacopie_1_1logger__iface-members.html b/docs/html/classtacopie_1_1logger__iface-members.html index ec1e2ba..40c1164 100644 --- a/docs/html/classtacopie_1_1logger__iface-members.html +++ b/docs/html/classtacopie_1_1logger__iface-members.html @@ -61,7 +61,7 @@
diff --git a/docs/html/classtacopie_1_1logger__iface.html b/docs/html/classtacopie_1_1logger__iface.html index a323b7b..40553b0 100644 --- a/docs/html/classtacopie_1_1logger__iface.html +++ b/docs/html/classtacopie_1_1logger__iface.html @@ -61,7 +61,7 @@
@@ -86,17 +86,21 @@ - - + + - - + + - - + + - - + + @@ -109,92 +113,7 @@

Public Member Functions

 logger_iface (void)=default
 ctor More...
+ logger_iface (void)=default
 ctor
 
virtual ~logger_iface (void)=default
 dtor More...
+virtual ~logger_iface (void)=default
 dtor
 
 logger_iface (const logger_iface &)=default
 copy ctor More...
+ logger_iface (const logger_iface &)=default
 copy ctor
 
logger_iface & operator= (const logger_iface &)=default
 assignment operator More...
+logger_iface & operator= (const logger_iface &)=default
 assignment operator
 
virtual void debug (const std::string &msg, const std::string &file, std::size_t line)=0
 

Detailed Description

logger_iface should be inherited by any class intended to be used for logging

-

Constructor & Destructor Documentation

- -

◆ logger_iface() [1/2]

- -
-
- - - - - -
- - - - - - - - -
tacopie::logger_iface::logger_iface (void )
- 		-default
-
- -

ctor

- -
-
- -

◆ ~logger_iface()

- -
-
- - - - - -
- - - - - - - - -
virtual tacopie::logger_iface::~logger_iface (void )
- 		-virtualdefault
-
- -

dtor

- -
-
- -

◆ logger_iface() [2/2]

- -
-
- - - - - -
- - - - - - - - -
tacopie::logger_iface::logger_iface (const logger_iface & )
- 		-default
-
- -

copy ctor

- -
-
-

Member Function Documentation

+

Member Function Documentation

◆ debug()

@@ -352,34 +271,6 @@

tacopie::logger.

- - - -

◆ operator=()

- -
-
- - - - - -
- - - - - - - - -
logger_iface& tacopie::logger_iface::operator= (const logger_iface & )
- 		-default
-
- -

assignment operator

-
diff --git a/docs/html/classtacopie_1_1self__pipe-members.html b/docs/html/classtacopie_1_1self__pipe-members.html index b7af9be..04800e8 100644 --- a/docs/html/classtacopie_1_1self__pipe-members.html +++ b/docs/html/classtacopie_1_1self__pipe-members.html @@ -61,7 +61,7 @@
@@ -75,12 +75,11 @@ clr_buffer(void)tacopie::self_pipe get_read_fd(void) consttacopie::self_pipe get_write_fd(void) consttacopie::self_pipe - m_fdstacopie::self_pipeprivate - notify(void)tacopie::self_pipe - operator=(const self_pipe &)=deletetacopie::self_pipe - self_pipe(void)tacopie::self_pipe - self_pipe(const self_pipe &)=deletetacopie::self_pipe - ~self_pipe(void)tacopie::self_pipe + notify(void)tacopie::self_pipe + operator=(const self_pipe &)=deletetacopie::self_pipe + self_pipe(void)tacopie::self_pipe + self_pipe(const self_pipe &)=deletetacopie::self_pipe + ~self_pipe(void)tacopie::self_pipe
diff --git a/docs/html/classtacopie_1_1self__pipe.html b/docs/html/classtacopie_1_1self__pipe.html index b9f5fb3..4658c7c 100644 --- a/docs/html/classtacopie_1_1self__pipe.html +++ b/docs/html/classtacopie_1_1self__pipe.html @@ -61,118 +61,45 @@
Public Member Functions | -Private Attributes | List of all members
tacopie::self_pipe Class Reference
- -

#include <self_pipe.hpp>

- - + + - - + + - - + + - - + + - + - + -

Public Member Functions

 self_pipe (void)
 ctor More...
+ self_pipe (void)
 ctor
 
 ~self_pipe (void)
 dtor More...
+ ~self_pipe (void)
 dtor
 
 self_pipe (const self_pipe &)=delete
 copy ctor More...
+ self_pipe (const self_pipe &)=delete
 copy ctor
 
self_pipe & operator= (const self_pipe &)=delete
 assignment operator More...
+self_pipe & operator= (const self_pipe &)=delete
 assignment operator
 
fd_t get_read_fd (void) const
fd_t get_read_fd (void) const
 
fd_t get_write_fd (void) const
fd_t get_write_fd (void) const
 
void notify (void)
 
void clr_buffer (void)
 
- - - -

-Private Attributes

fd_t m_fds [2]
 
-

Constructor & Destructor Documentation

- -

◆ self_pipe() [1/2]

- -
-
- - - - - - - - -
tacopie::self_pipe::self_pipe (void )
-
- -

ctor

- -
-
- -

◆ ~self_pipe()

- -
-
- - - - - - - - -
tacopie::self_pipe::~self_pipe (void )
-
- -

dtor

- -
-
- -

◆ self_pipe() [2/2]

- -
-
- - - - -
- - - - - - - - -
tacopie::self_pipe::self_pipe (const self_pipe & )
- 		-delete
-
- -

copy ctor

- -
-

Member Function Documentation

◆ clr_buffer()

@@ -200,7 +127,7 @@

- + @@ -219,7 +146,7 @@

fd_t tacopie::self_pipe::get_read_fd fd_t tacopie::self_pipe::get_read_fd ( void  )
 - + @@ -248,58 +175,6 @@

notify the self pipe (basically write to the pipe)

- - - -

◆ operator=()

- -
-
-
fd_t tacopie::self_pipe::get_write_fd fd_t tacopie::self_pipe::get_write_fd ( void  )
- - - - -
- - - - - - - - -
self_pipe& tacopie::self_pipe::operator= (const self_pipe & )
- 		-delete
-

- -

assignment operator

- -
- -

Member Data Documentation

- -

◆ m_fds

- -
-
- - - - - -
- - - - -
fd_t tacopie::self_pipe::m_fds[2]
- 		-private
-
-

pipe file descriptors

-
The documentation for this class was generated from the following file:
    diff --git a/docs/html/classtacopie_1_1tacopie__error-members.html b/docs/html/classtacopie_1_1tacopie__error-members.html index 56d6706..320495c 100644 --- a/docs/html/classtacopie_1_1tacopie__error-members.html +++ b/docs/html/classtacopie_1_1tacopie__error-members.html @@ -61,7 +61,7 @@
@@ -74,8 +74,6 @@ - - diff --git a/docs/html/classtacopie_1_1tacopie__error.html b/docs/html/classtacopie_1_1tacopie__error.html index 2cb895e..3a88cb5 100644 --- a/docs/html/classtacopie_1_1tacopie__error.html +++ b/docs/html/classtacopie_1_1tacopie__error.html @@ -61,13 +61,12 @@
Public Member Functions | -Private Attributes | List of all members
tacopie::tacopie_error Class Reference
@@ -86,126 +85,30 @@
get_file(void) consttacopie::tacopie_error
get_line(void) consttacopie::tacopie_error
m_filetacopie::tacopie_errorprivate
m_linetacopie::tacopie_errorprivate
operator=(const tacopie_error &)=defaulttacopie::tacopie_error
tacopie_error(const std::string &what, const std::string &file, std::size_t line)tacopie::tacopie_error
tacopie_error(const tacopie_error &)=defaulttacopie::tacopie_error
- - + + - - + + - - + + - - + + -

Public Member Functions

 tacopie_error (const std::string &what, const std::string &file, std::size_t line)
 ctor More...
+ tacopie_error (const std::string &what, const std::string &file, std::size_t line)
 ctor
 
 ~tacopie_error (void)=default
 assignment operator More...
+ ~tacopie_error (void)=default
 assignment operator
 
 tacopie_error (const tacopie_error &)=default
 copy ctor More...
+ tacopie_error (const tacopie_error &)=default
 copy ctor
 
tacopie_error & operator= (const tacopie_error &)=default
 assignment operator More...
+tacopie_error & operator= (const tacopie_error &)=default
 assignment operator
 
const std::string & get_file (void) const
 
std::size_t get_line (void) const
 
- - - - -

-Private Attributes

std::string m_file
 
std::size_t m_line
 

Detailed Description

specialized runtime_error used for tacopie error

-

Constructor & Destructor Documentation

- -

◆ tacopie_error() [1/2]

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - -
tacopie::tacopie_error::tacopie_error (const std::string & what,
const std::string & file,
std::size_t line 
)
-
- -

ctor

- -
-
- -

◆ ~tacopie_error()

- -
-
- - - - - -
- - - - - - - - -
tacopie::tacopie_error::~tacopie_error (void )
- 		-default
-
- -

assignment operator

- -
-
- -

◆ tacopie_error() [2/2]

- -
-
- - - - - -
- - - - - - - - -
tacopie::tacopie_error::tacopie_error (const tacopie_error & )
- 		-default
-
- -

copy ctor

- -
-
-

Member Function Documentation

+

Member Function Documentation

◆ get_file()

@@ -242,81 +145,6 @@

Returns
line at which the error occured
- - - -

◆ operator=()

- -
-
- - - - - -
- - - - - - - - -
tacopie_error& tacopie::tacopie_error::operator= (const tacopie_error & )
- 		-default
-
- -

assignment operator

- -
-
-

Member Data Documentation

- -

◆ m_file

- -
-
- - - - - -
- - - - -
std::string tacopie::tacopie_error::m_file
- 		-private
-
-

file location of the error

- -
-
- -

◆ m_line

- -
-
- - - - - -
- - - - -
std::size_t tacopie::tacopie_error::m_line
- 		-private
-
-

line location of the error

-
The documentation for this class was generated from the following file:
    diff --git a/docs/html/classtacopie_1_1tcp__client-members.html b/docs/html/classtacopie_1_1tcp__client-members.html index b2095dd..06377c2 100644 --- a/docs/html/classtacopie_1_1tcp__client-members.html +++ b/docs/html/classtacopie_1_1tcp__client-members.html @@ -61,7 +61,7 @@
@@ -76,38 +76,23 @@ async_read_callback_t typedeftacopie::tcp_client async_write(const write_request &request)tacopie::tcp_client async_write_callback_t typedeftacopie::tcp_client - call_disconnection_handler(void)tacopie::tcp_clientprivate - clear_read_requests(void)tacopie::tcp_clientprivate - clear_write_requests(void)tacopie::tcp_clientprivate - connect(const std::string &host, std::uint32_t port, std::uint32_t timeout_msecs=0)tacopie::tcp_client - disconnect(bool wait_for_removal=false)tacopie::tcp_client - disconnection_handler_t typedeftacopie::tcp_client - get_host(void) consttacopie::tcp_client - get_io_service(void) consttacopie::tcp_client - get_port(void) consttacopie::tcp_client - get_socket(void)tacopie::tcp_client - get_socket(void) consttacopie::tcp_client - is_connected(void) consttacopie::tcp_client - m_disconnection_handlertacopie::tcp_clientprivate - m_io_servicetacopie::tcp_clientprivate - m_is_connectedtacopie::tcp_clientprivate - m_read_requeststacopie::tcp_clientprivate - m_read_requests_mtxtacopie::tcp_clientprivate - m_sockettacopie::tcp_clientprivate - m_write_requeststacopie::tcp_clientprivate - m_write_requests_mtxtacopie::tcp_clientprivate - on_read_available(fd_t fd)tacopie::tcp_clientprivate - on_write_available(fd_t fd)tacopie::tcp_clientprivate - operator!=(const tcp_client &rhs) consttacopie::tcp_client - operator=(const tcp_client &)=deletetacopie::tcp_client - operator==(const tcp_client &rhs) consttacopie::tcp_client - process_read(read_result &result)tacopie::tcp_clientprivate - process_write(write_result &result)tacopie::tcp_clientprivate - set_on_disconnection_handler(const disconnection_handler_t &disconnection_handler)tacopie::tcp_client - tcp_client(std::uint32_t num_io_workers=1)tacopie::tcp_client - tcp_client(tcp_socket &&socket)tacopie::tcp_clientexplicit - tcp_client(const tcp_client &)=deletetacopie::tcp_client - ~tcp_client(void)tacopie::tcp_client + connect(const std::string &host, std::uint32_t port, std::uint32_t timeout_msecs=0)tacopie::tcp_client + disconnect(bool wait_for_removal=false)tacopie::tcp_client + disconnection_handler_t typedeftacopie::tcp_client + get_host(void) consttacopie::tcp_client + get_io_service(void) consttacopie::tcp_client + get_port(void) consttacopie::tcp_client + get_socket(void)tacopie::tcp_client + get_socket(void) consttacopie::tcp_client + is_connected(void) consttacopie::tcp_client + operator!=(const tcp_client &rhs) consttacopie::tcp_client + operator=(const tcp_client &)=deletetacopie::tcp_client + operator==(const tcp_client &rhs) consttacopie::tcp_client + set_on_disconnection_handler(const disconnection_handler_t &disconnection_handler)tacopie::tcp_client + tcp_client(std::uint32_t num_io_workers=1)tacopie::tcp_client + tcp_client(tcp_socket &&socket)tacopie::tcp_clientexplicit + tcp_client(const tcp_client &)=deletetacopie::tcp_client + ~tcp_client(void) (defined in tacopie::tcp_client)tacopie::tcp_client
diff --git a/docs/html/classtacopie_1_1tcp__client.html b/docs/html/classtacopie_1_1tcp__client.html index 8508515..ca8250b 100644 --- a/docs/html/classtacopie_1_1tcp__client.html +++ b/docs/html/classtacopie_1_1tcp__client.html @@ -61,7 +61,7 @@
@@ -69,15 +69,11 @@ Classes | Public Types | Public Member Functions | -Private Member Functions | -Private Attributes | List of all members
tacopie::tcp_client Class Reference
- -

#include <tcp_client.hpp>

@@ -101,18 +97,19 @@

Classes

- - + + - - - - + + - - + + @@ -140,42 +137,6 @@ -

Public Member Functions

 tcp_client (std::uint32_t num_io_workers=1)
 ctor & dtor More...
+ tcp_client (std::uint32_t num_io_workers=1)
 ctor & dtor
 
 ~tcp_client (void)
 
 tcp_client (tcp_socket &&socket)
 
 tcp_client (const tcp_client &)=delete
 copy ctor More...
+ tcp_client (const tcp_client &)=delete
 copy ctor
 
tcp_client & operator= (const tcp_client &)=delete
 assignment operator More...
+tcp_client & operator= (const tcp_client &)=delete
 assignment operator
 
bool operator== (const tcp_client &rhs) const
 
 
void set_on_disconnection_handler (const disconnection_handler_t &disconnection_handler)
 
- - - - - - - - - - - - - - - -

-Private Member Functions

void call_disconnection_handler (void)
 
void on_read_available (fd_t fd)
 
void on_write_available (fd_t fd)
 
void clear_read_requests (void)
 
void clear_write_requests (void)
 
async_read_callback_t process_read (read_result &result)
 
async_write_callback_t process_write (write_result &result)
 
- - - - - - - - - - - - - - - - -

-Private Attributes

std::shared_ptr< io_service > m_io_service
 
tacopie::tcp_socket m_socket
 
std::atomic< bool > m_is_connected = ATOMIC_VAR_INIT(false)
 
std::queue< read_request > m_read_requests
 
std::queue< write_request > m_write_requests
 
std::mutex m_read_requests_mtx
 
std::mutex m_write_requests_mtx
 
disconnection_handler_t m_disconnection_handler
 

Member Typedef Documentation

@@ -224,46 +185,8 @@

Constructor & Destructor Documentation

- -

◆ tcp_client() [1/3]

- -
-
- - - - - - - - -
tacopie::tcp_client::tcp_client (std::uint32_t num_io_workers = 1)
-
- -

ctor & dtor

- -
-
- -

◆ ~tcp_client()

- -
-
- - - - - - - - -
tacopie::tcp_client::~tcp_client (void )
-
- -
-
-

◆ tcp_client() [2/3]

+

◆ tcp_client()

@@ -293,34 +216,6 @@

-

◆ tcp_client() [3/3]

- -
-
- - - - - -
- - - - - - - - -
tacopie::tcp_client::tcp_client (const tcp_client & )
- 		-delete
-
- -

copy ctor

-

Member Function Documentation

@@ -372,87 +267,6 @@

-

◆ call_disconnection_handler()

- -
-
- - - - - -
- - - - - - - - -
void tacopie::tcp_client::call_disconnection_handler (void )
- 		-private
-
-

Call the user-defined disconnection handler

- -
-
- -

◆ clear_read_requests()

- -
-
- - - - - -
- - - - - - - - -
void tacopie::tcp_client::clear_read_requests (void )
- 		-private
-
-

Clear pending read requests (basically empty the queue of read requests)

- -
-
- -

◆ clear_write_requests()

- -
-
- - - - - -
- - - - - - - - -
void tacopie::tcp_client::clear_write_requests (void )
- 		-private
-
-

Clear pending write requests (basically empty the queue of write requests)

-
@@ -635,72 +449,6 @@

Returns
whether the client is currently connected or not
-

-
- -

◆ on_read_available()

- -
-
- - - - - -
- - - - - - - - -
void tacopie::tcp_client::on_read_available (fd_t fd)
- 		-private
-
-

io service read callback called by the io service whenever the socket is readable

-
Parameters
- - -
fdfile description of the socket for which the read is available
-
-
- -
-
- -

◆ on_write_available()

- -
-
- - - - - -
- - - - - - - - -
void tacopie::tcp_client::on_write_available (fd_t fd)
- 		-private
-
-

io service write callback called by the io service whenever the socket is writable

-
Parameters
- - -
fdfile description of the socket for which the write is available
-
-
-
@@ -721,34 +469,6 @@

Returns
true when the underlying sockets are different (different file descriptor or socket type).
-

- - -

◆ operator=()

- -
-
- - - - - -
- - - - - - - - -
tcp_client& tacopie::tcp_client::operator= (const tcp_client & )
- 		-delete
-
- -

assignment operator

-
@@ -769,74 +489,6 @@

Returns
true when the underlying sockets are the same (same file descriptor and socket type).
- - - -

◆ process_read()

- -
-
- - - - - -
- - - - - - - - -
async_read_callback_t tacopie::tcp_client::process_read (read_result & result)
- 		-private
-
-

process read operations when available basically called whenever on_read_available is called and try to read from the socket handle possible case of failure and fill in the result

-
Parameters
- - -
resultresult of the read operation
-
-
-
Returns
the callback to be executed (set in the read request) on read completion (may be null)
- -
-
- -

◆ process_write()

- -
-
- - - - - -
- - - - - - - - -
async_write_callback_t tacopie::tcp_client::process_write (write_result & result)
- 		-private
-
-

process write operations when available basically called whenever on_write_available is called and try to write to the socket handle possible case of failure and fill in the result

-
Parameters
- - -
resultresult of the write operation
-
-
-
Returns
the callback to be executed (set in the write request) on read completion (may be null)
-
@@ -862,191 +514,6 @@

Member Data Documentation

- -

◆ m_disconnection_handler

- -
-
- - - - - -
- - - - -
disconnection_handler_t tacopie::tcp_client::m_disconnection_handler
- 		-private
-
-

disconnection handler

- -
-
- -

◆ m_io_service

- -
-
- - - - - -
- - - - -
std::shared_ptr<io_service> tacopie::tcp_client::m_io_service
- 		-private
-
-

store io_service prevent deletion of io_service before the tcp_client itself

- -
-
- -

◆ m_is_connected

- -
-
- - - - - -
- - - - -
std::atomic<bool> tacopie::tcp_client::m_is_connected = ATOMIC_VAR_INIT(false)
- 		-private
-
-

whether the client is currently connected or not

- -
-
- -

◆ m_read_requests

- -
-
- - - - - -
- - - - -
std::queue<read_request> tacopie::tcp_client::m_read_requests
- 		-private
-
-

read requests

- -
-
- -

◆ m_read_requests_mtx

- -
-
- - - - - -
- - - - -
std::mutex tacopie::tcp_client::m_read_requests_mtx
- 		-private
-
-

read requests thread safety

- -
-
- -

◆ m_socket

- -
-
- - - - - -
- - - - -
tacopie::tcp_socket tacopie::tcp_client::m_socket
- 		-private
-
-

client socket

- -
-
- -

◆ m_write_requests

- -
-
- - - - - -
- - - - -
std::queue<write_request> tacopie::tcp_client::m_write_requests
- 		-private
-
-

write requests

- -
-
- -

◆ m_write_requests_mtx

- -
-
- - - - - -
- - - - -
std::mutex tacopie::tcp_client::m_write_requests_mtx
- 		-private
-
-

write requests thread safety

-
The documentation for this class was generated from the following file:
    diff --git a/docs/html/classtacopie_1_1tcp__server-members.html b/docs/html/classtacopie_1_1tcp__server-members.html index c56da3a..0e170d6 100644 --- a/docs/html/classtacopie_1_1tcp__server-members.html +++ b/docs/html/classtacopie_1_1tcp__server-members.html @@ -61,7 +61,7 @@
@@ -77,15 +77,7 @@ get_socket(void)tacopie::tcp_server get_socket(void) consttacopie::tcp_server is_running(void) consttacopie::tcp_server - m_clientstacopie::tcp_serverprivate - m_clients_mtxtacopie::tcp_serverprivate - m_io_servicetacopie::tcp_serverprivate - m_is_runningtacopie::tcp_serverprivate - m_on_new_connection_callbacktacopie::tcp_serverprivate - m_sockettacopie::tcp_serverprivate - on_client_disconnected(const std::shared_ptr< tcp_client > &client)tacopie::tcp_serverprivate - on_new_connection_callback_t typedeftacopie::tcp_server - on_read_available(fd_t fd)tacopie::tcp_serverprivate + on_new_connection_callback_t typedeftacopie::tcp_server operator!=(const tcp_server &rhs) consttacopie::tcp_server operator=(const tcp_server &)=deletetacopie::tcp_server operator==(const tcp_server &rhs) consttacopie::tcp_server diff --git a/docs/html/classtacopie_1_1tcp__server.html b/docs/html/classtacopie_1_1tcp__server.html index 7020106..f599029 100644 --- a/docs/html/classtacopie_1_1tcp__server.html +++ b/docs/html/classtacopie_1_1tcp__server.html @@ -61,15 +61,13 @@
Public Types | Public Member Functions | -Private Member Functions | -Private Attributes | List of all members
tacopie::tcp_server Class Reference
@@ -85,17 +83,21 @@ - - + + - - + + - - + + - - + + @@ -115,28 +117,6 @@ -

Public Member Functions

 tcp_server (void)
 ctor More...
+ tcp_server (void)
 ctor
 
 ~tcp_server (void)
 dtor More...
+ ~tcp_server (void)
 dtor
 
 tcp_server (const tcp_server &)=delete
 copy ctor More...
+ tcp_server (const tcp_server &)=delete
 copy ctor
 
tcp_server & operator= (const tcp_server &)=delete
 assignment operator More...
+tcp_server & operator= (const tcp_server &)=delete
 assignment operator
 
bool operator== (const tcp_server &rhs) const
 
 
const std::list< std::shared_ptr< tacopie::tcp_client > > & get_clients (void) const
 
- - - - - -

-Private Member Functions

void on_read_available (fd_t fd)
 
void on_client_disconnected (const std::shared_ptr< tcp_client > &client)
 
- - - - - - - - - - - - -

-Private Attributes

std::shared_ptr< io_service > m_io_service
 
tacopie::tcp_socket m_socket
 
std::atomic< bool > m_is_running = ATOMIC_VAR_INIT(false)
 
std::list< std::shared_ptr< tacopie::tcp_client > > m_clients
 
std::mutex m_clients_mtx
 
on_new_connection_callback_t m_on_new_connection_callback
 

Detailed Description

tacopie::tcp_server is the class providing TCP Server features. The tcp_client works entirely asynchronously, waiting for the io_service to notify whenever a new client wished to connect.

@@ -155,75 +135,6 @@

tcp_client that wishes to connect Returning true means connection is handled by tcp_client wrapper and nothing will be done by tcp_server. Returning false means connection is handled by tcp_server, will be stored in an internal list and tcp_client disconection_handler overriden.

-

-
-

Constructor & Destructor Documentation

- -

◆ tcp_server() [1/2]

- -
-
- - - - - - - - -
tacopie::tcp_server::tcp_server (void )
-
- -

ctor

- -
-
- -

◆ ~tcp_server()

- -
-
- - - - - - - - -
tacopie::tcp_server::~tcp_server (void )
-
- -

dtor

- -
-
- -

◆ tcp_server() [2/2]

- -
-
- - - - - -
- - - - - - - - -
tacopie::tcp_server::tcp_server (const tcp_server & )
- 		-delete
-
- -

copy ctor

-

Member Function Documentation

@@ -320,72 +231,6 @@

Returns
whether the server is currently running or not
- - - -

◆ on_client_disconnected()

- -
-
- - - - - -
- - - - - - - - -
void tacopie::tcp_server::on_client_disconnected (const std::shared_ptr< tcp_client > & client)
- 		-private
-
-

client disconnected called whenever a client disconnected from the tcp_server

-
Parameters
- - -
clientdisconnected client
-
-
- -
-
- -

◆ on_read_available()

- -
-
- - - - - -
- - - - - - - - -
void tacopie::tcp_server::on_read_available (fd_t fd)
- 		-private
-
-

io service read callback

-
Parameters
- - -
fdsocket that triggered the read callback
-
-
-
@@ -406,34 +251,6 @@

Returns
true when the underlying sockets are different (different file descriptor or socket type).
- - - -

◆ operator=()

- -
-
- - - - - -
- - - - - - - - -
tcp_server& tacopie::tcp_server::operator= (const tcp_server & )
- 		-delete
-
- -

assignment operator

-
@@ -533,145 +350,6 @@

Member Data Documentation

- -

◆ m_clients

- -
-
- - - - - -
- - - - -
std::list<std::shared_ptr<tacopie::tcp_client> > tacopie::tcp_server::m_clients
- 		-private
-
-

clients

- -
-
- -

◆ m_clients_mtx

- -
-
- - - - - -
- - - - -
std::mutex tacopie::tcp_server::m_clients_mtx
- 		-private
-
-

clients thread safety

- -
-
- -

◆ m_io_service

- -
-
- - - - - -
- - - - -
std::shared_ptr<io_service> tacopie::tcp_server::m_io_service
- 		-private
-
-

store io_service prevent deletion of io_service before the tcp_server itself

- -
-
- -

◆ m_is_running

- -
-
- - - - - -
- - - - -
std::atomic<bool> tacopie::tcp_server::m_is_running = ATOMIC_VAR_INIT(false)
- 		-private
-
-

whether the server is currently running or not

- -
-
- -

◆ m_on_new_connection_callback

- -
-
- - - - - -
- - - - -
on_new_connection_callback_t tacopie::tcp_server::m_on_new_connection_callback
- 		-private
-
-

on new connection callback

- -
-
- -

◆ m_socket

- -
-
- - - - - -
- - - - -
tacopie::tcp_socket tacopie::tcp_server::m_socket
- 		-private
-
-

server socket

-
The documentation for this class was generated from the following file:
    diff --git a/docs/html/classtacopie_1_1tcp__socket-members.html b/docs/html/classtacopie_1_1tcp__socket-members.html index 01d1ef2..82e4afe 100644 --- a/docs/html/classtacopie_1_1tcp__socket-members.html +++ b/docs/html/classtacopie_1_1tcp__socket-members.html @@ -61,7 +61,7 @@
@@ -74,19 +74,13 @@ - - - - + + - - - - diff --git a/docs/html/classtacopie_1_1tcp__socket.html b/docs/html/classtacopie_1_1tcp__socket.html index d4f2bd8..9940acd 100644 --- a/docs/html/classtacopie_1_1tcp__socket.html +++ b/docs/html/classtacopie_1_1tcp__socket.html @@ -61,15 +61,13 @@
Public Types | Public Member Functions | -Private Member Functions | -Private Attributes | List of all members
tacopie::tcp_socket Class Reference
@@ -80,30 +78,35 @@
accept(void)tacopie::tcp_socket
bind(const std::string &host, std::uint32_t port)tacopie::tcp_socket
check_or_set_type(type t)tacopie::tcp_socketprivate
close(void)tacopie::tcp_socket
connect(const std::string &host, std::uint32_t port, std::uint32_t timeout_msecs=0)tacopie::tcp_socket
create_socket_if_necessary(void)tacopie::tcp_socketprivate
close(void)tacopie::tcp_socket
connect(const std::string &host, std::uint32_t port, std::uint32_t timeout_msecs=0)tacopie::tcp_socket
get_fd(void) consttacopie::tcp_socket
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
m_fdtacopie::tcp_socketprivate
m_hosttacopie::tcp_socketprivate
m_porttacopie::tcp_socketprivate
m_typetacopie::tcp_socketprivate
operator!=(const tcp_socket &rhs) consttacopie::tcp_socket
operator=(const tcp_socket &)=deletetacopie::tcp_socket
operator==(const tcp_socket &rhs) consttacopie::tcp_socket
-

Public Types

enum  type { type::CLIENT, -type::SERVER, -type::UNKNOWN +
enum  type { CLIENT, +SERVER, +UNKNOWN }
 
- - + + - - + + - + - - + + - - + + - - + + @@ -131,26 +134,8 @@ - + -

Public Member Functions

 tcp_socket (void)
 ctor More...
+ tcp_socket (void)
 ctor
 
 ~tcp_socket (void)=default
 dtor More...
+ ~tcp_socket (void)=default
 dtor
 
 tcp_socket (fd_t fd, const std::string &host, std::uint32_t port, type t)
 tcp_socket (fd_t fd, const std::string &host, std::uint32_t port, type t)
 
 tcp_socket (tcp_socket &&)
 move ctor More...
+ tcp_socket (tcp_socket &&)
 move ctor
 
 tcp_socket (const tcp_socket &)=delete
 copy ctor More...
+ tcp_socket (const tcp_socket &)=delete
 copy ctor
 
tcp_socket & operator= (const tcp_socket &)=delete
 assignment operator More...
+tcp_socket & operator= (const tcp_socket &)=delete
 assignment operator
 
bool operator== (const tcp_socket &rhs) const
 
 
void set_type (type t)
 
fd_t get_fd (void) const
fd_t get_fd (void) const
 
- - - - - -

-Private Member Functions

void create_socket_if_necessary (void)
 
void check_or_set_type (type t)
 
- - - - - - - - -

-Private Attributes

fd_t m_fd
 
std::string m_host
 
std::uint32_t m_port
 
type m_type
 

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.

@@ -176,65 +161,12 @@

possible types of a TCP socket, either a client or a server type is used to prevent the used of client specific operations on a server socket (and vice-versa)

UNKNOWN is used when socket type could not be determined for now

- - - - -
Enumerator
CLIENT 
SERVER 
UNKNOWN 

Constructor & Destructor Documentation

- -

◆ tcp_socket() [1/4]

- -
-
- - - - - - - - -
tacopie::tcp_socket::tcp_socket (void )
-
- -

ctor

- -
-
- -

◆ ~tcp_socket()

- -
-
- - - - - -
- - - - - - - - -
tacopie::tcp_socket::~tcp_socket (void )
- 		-default
-
- -

dtor

- -
-
-

◆ tcp_socket() [2/4]

+

◆ tcp_socket()

@@ -242,7 +174,7 @@

tacopie::tcp_socket::tcp_socket ( - fd_t  + fd_t  fd, @@ -281,54 +213,6 @@

-

◆ tcp_socket() [3/4]

- -
-
- - - - - - - - -
tacopie::tcp_socket::tcp_socket (tcp_socket && )
-
- -

move ctor

- -
-
- -

◆ tcp_socket() [4/4]

- -
-
- - - - - -
- - - - - - - - -
tacopie::tcp_socket::tcp_socket (const tcp_socket & )
- 		-delete
-
- -

copy ctor

-

Member Function Documentation

@@ -386,39 +270,6 @@

-

◆ check_or_set_type()

- -
-
- - - - - -
- - - - - - - - -
void tacopie::tcp_socket::check_or_set_type (type t)
- 		-private
-
-

check whether the current socket has an approriate type for that kind of operation if current type is UNKNOWN, update internal type with given type

-
Parameters
- - -
texpected type of our socket to process the operation
-
-
-
@@ -481,33 +332,6 @@

-

◆ create_socket_if_necessary()

- -
-
- - - - - -
- - - - - - - - -
void tacopie::tcp_socket::create_socket_if_necessary (void )
- 		-private
-
-

create a new socket if no socket has been initialized yet

-
@@ -517,7 +341,7 @@

- + @@ -630,34 +454,6 @@

Returns
true when the underlying sockets are different (different file descriptor or socket type).
- - - -

◆ operator=()

- -
-
-

fd_t tacopie::tcp_socket::get_fd fd_t tacopie::tcp_socket::get_fd ( void  )
 - - - - -
- - - - - - - - -
tcp_socket& tacopie::tcp_socket::operator= (const tcp_socket & )
- 		-delete
-

- -

assignment operator

-
@@ -766,99 +562,6 @@

Member Data Documentation

- -

◆ m_fd

- -
-
- - - - - -
- - - - -
fd_t tacopie::tcp_socket::m_fd
- 		-private
-
-

fd associated to the socket

- -
-
- -

◆ m_host

- -
-
- - - - - -
- - - - -
std::string tacopie::tcp_socket::m_host
- 		-private
-
-

socket hostname information

- -
-
- -

◆ m_port

- -
-
- - - - - -
- - - - -
std::uint32_t tacopie::tcp_socket::m_port
- 		-private
-
-

socket port information

- -
-
- -

◆ m_type

- -
-
- - - - - -
- - - - -
type tacopie::tcp_socket::m_type
- 		-private
-
-

type of the socket

-
The documentation for this class was generated from the following file:
    diff --git a/docs/html/classtacopie_1_1utils_1_1thread__pool-members.html b/docs/html/classtacopie_1_1utils_1_1thread__pool-members.html index 521c284..341f0fe 100644 --- a/docs/html/classtacopie_1_1utils_1_1thread__pool-members.html +++ b/docs/html/classtacopie_1_1utils_1_1thread__pool-members.html @@ -61,7 +61,7 @@
@@ -73,24 +73,15 @@

This is the complete list of members for tacopie::utils::thread_pool, including all inherited members.

- - - - - - - - - - - + + + - - - - - - + + + + +
add_task(const task_t &task)tacopie::utils::thread_pool
fetch_task(void)tacopie::utils::thread_poolprivate
is_running(void) consttacopie::utils::thread_pool
m_nb_threadstacopie::utils::thread_poolprivate
m_should_stoptacopie::utils::thread_poolprivate
m_taskstacopie::utils::thread_poolprivate
m_tasks_condvartacopie::utils::thread_poolprivate
m_tasks_mtxtacopie::utils::thread_poolprivate
m_workerstacopie::utils::thread_poolprivate
operator<<(const task_t &task)tacopie::utils::thread_pool
operator=(const thread_pool &)=deletetacopie::utils::thread_pool
run(void)tacopie::utils::thread_poolprivate
is_running(void) consttacopie::utils::thread_pool
operator<<(const task_t &task)tacopie::utils::thread_pool
operator=(const thread_pool &)=deletetacopie::utils::thread_pool
set_nb_threads(std::size_t nb_threads)tacopie::utils::thread_pool
should_stop(void) consttacopie::utils::thread_poolprivate
stop(void)tacopie::utils::thread_pool
task_t typedeftacopie::utils::thread_pool
thread_pool(std::size_t nb_threads)tacopie::utils::thread_poolexplicit
thread_pool(const thread_pool &)=deletetacopie::utils::thread_pool
~thread_pool(void)tacopie::utils::thread_pool
stop(void)tacopie::utils::thread_pool
task_t typedeftacopie::utils::thread_pool
thread_pool(std::size_t nb_threads)tacopie::utils::thread_poolexplicit
thread_pool(const thread_pool &)=deletetacopie::utils::thread_pool
~thread_pool(void)tacopie::utils::thread_pool
diff --git a/docs/html/classtacopie_1_1utils_1_1thread__pool.html b/docs/html/classtacopie_1_1utils_1_1thread__pool.html index cf32365..dad76b0 100644 --- a/docs/html/classtacopie_1_1utils_1_1thread__pool.html +++ b/docs/html/classtacopie_1_1utils_1_1thread__pool.html @@ -61,22 +61,18 @@
Public Types | Public Member Functions | -Private Member Functions | -Private Attributes | List of all members
tacopie::utils::thread_pool Class Reference
- -

#include <thread_pool.hpp>

@@ -87,14 +83,17 @@ Public Member Functions - - + + - - + + - - + + @@ -106,30 +105,6 @@ -

Public Types

 thread_pool (std::size_t nb_threads)
 
 ~thread_pool (void)
 dtor More...
+ ~thread_pool (void)
 dtor
 
 thread_pool (const thread_pool &)=delete
 copy ctor More...
+ thread_pool (const thread_pool &)=delete
 copy ctor
 
thread_pool & operator= (const thread_pool &)=delete
 assignment operator More...
+thread_pool & operator= (const thread_pool &)=delete
 assignment operator
 
void add_task (const task_t &task)
 
 
void set_nb_threads (std::size_t nb_threads)
 
- - - - - - - -

-Private Member Functions

void run (void)
 
task_t fetch_task (void)
 
bool should_stop (void) const
 
- - - - - - - - - - - - -

-Private Attributes

std::vector< std::thread > m_workers
 
std::size_t m_nb_threads
 
std::atomic< bool > m_should_stop = ATOMIC_VAR_INIT(false)
 
std::queue< task_t > m_tasks
 
std::mutex m_tasks_mtx
 
std::condition_variable m_tasks_condvar
 

Member Typedef Documentation

@@ -149,7 +124,7 @@

Constructor & Destructor Documentation

-

◆ thread_pool() [1/2]

+

◆ thread_pool()

@@ -179,54 +154,6 @@

-

◆ ~thread_pool()

- -
-
- - - - - - - - -
tacopie::utils::thread_pool::~thread_pool (void )
-
- -

dtor

- -
-
- -

◆ thread_pool() [2/2]

- -
-
- - - - - -
- - - - - - - - -
tacopie::utils::thread_pool::thread_pool (const thread_pool & )
- 		-delete
-
- -

copy ctor

-

Member Function Documentation

@@ -253,33 +180,6 @@

-

◆ fetch_task()

- -
-
- - - - - -
- - - - - - - - -
task_t tacopie::utils::thread_pool::fetch_task (void )
- 		-private
-
-

retrieve a new task fetch the first element in the queue, or wait if no task are available may return null if the threadpool is stopped

-
@@ -325,61 +225,6 @@

Returns
current instance
-

-
- -

◆ operator=()

- -
-
- - - - - -
- - - - - - - - -
thread_pool& tacopie::utils::thread_pool::operator= (const thread_pool & )
- 		-delete
-
- -

assignment operator

- -
-
- -

◆ run()

- -
-
- - - - - -
- - - - - - - - -
void tacopie::utils::thread_pool::run (void )
- 		-private
-
-

worker main loop

-
@@ -407,33 +252,6 @@

-

◆ should_stop()

- -
-
- - - - - -
- - - - - - - - -
bool tacopie::utils::thread_pool::should_stop (void ) const
- 		-private
-
-
Returns
whether the thread should stop or not
-
@@ -453,145 +271,6 @@

stop the thread pool and wait for workers completion if some tasks are pending, they won't be executed

-

- -

Member Data Documentation

- -

◆ m_nb_threads

- -
-
- - - - - -
- - - - -
std::size_t tacopie::utils::thread_pool::m_nb_threads
- 		-private
-
-

number of threads allowed

- -
-
- -

◆ m_should_stop

- -
-
- - - - - -
- - - - -
std::atomic<bool> tacopie::utils::thread_pool::m_should_stop = ATOMIC_VAR_INIT(false)
- 		-private
-
-

whether the thread_pool should stop or not

- -
-
- -

◆ m_tasks

- -
-
- - - - - -
- - - - -
std::queue<task_t> tacopie::utils::thread_pool::m_tasks
- 		-private
-
-

tasks

- -
-
- -

◆ m_tasks_condvar

- -
-
- - - - - -
- - - - -
std::condition_variable tacopie::utils::thread_pool::m_tasks_condvar
- 		-private
-
-

task condvar to sync on tasks changes

- -
-
- -

◆ m_tasks_mtx

- -
-
- - - - - -
- - - - -
std::mutex tacopie::utils::thread_pool::m_tasks_mtx
- 		-private
-
-

tasks thread safety

- -
-
- -

◆ m_workers

- -
-
- - - - - -
- - - - -
std::vector<std::thread> tacopie::utils::thread_pool::m_workers
- 		-private
-
-

threads

-
The documentation for this class was generated from the following file:
    diff --git a/docs/html/dir_09e761304027c904456130627fd4dcf5.html b/docs/html/dir_09e761304027c904456130627fd4dcf5.html index 3a0882c..7d92682 100644 --- a/docs/html/dir_09e761304027c904456130627fd4dcf5.html +++ b/docs/html/dir_09e761304027c904456130627fd4dcf5.html @@ -69,12 +69,6 @@
    includes Directory Reference
    - - - - -

    -Directories

    directory  tacopie
     
    diff --git a/docs/html/dir_1619eefbac1db14eaf18adaf83ce3ccc.html b/docs/html/dir_1619eefbac1db14eaf18adaf83ce3ccc.html index 90ac487..97c9066 100644 --- a/docs/html/dir_1619eefbac1db14eaf18adaf83ce3ccc.html +++ b/docs/html/dir_1619eefbac1db14eaf18adaf83ce3ccc.html @@ -69,20 +69,6 @@
    network Directory Reference
    - - - - - - - - - - - - -

    -Files

    file  io_service.hpp [code]
     
    file  self_pipe.hpp [code]
     
    file  tcp_client.hpp [code]
     
    file  tcp_server.hpp [code]
     
    file  tcp_socket.hpp [code]
     
    diff --git a/docs/html/dir_38b559f7600c1df65fbc4b39f02eb3f8.html b/docs/html/dir_38b559f7600c1df65fbc4b39f02eb3f8.html index d5730cf..3117504 100644 --- a/docs/html/dir_38b559f7600c1df65fbc4b39f02eb3f8.html +++ b/docs/html/dir_38b559f7600c1df65fbc4b39f02eb3f8.html @@ -69,18 +69,6 @@
    utils Directory Reference
    - - - - - - - - - - -

    -Files

    file  error.hpp [code]
     
    file  logger.hpp [code]
     
    file  thread_pool.hpp [code]
     
    file  typedefs.hpp [code]
     
    diff --git a/docs/html/dir_9a013686e2522dd95763481288c1f90f.html b/docs/html/dir_9a013686e2522dd95763481288c1f90f.html index 52b9c0a..f448fc2 100644 --- a/docs/html/dir_9a013686e2522dd95763481288c1f90f.html +++ b/docs/html/dir_9a013686e2522dd95763481288c1f90f.html @@ -72,10 +72,6 @@ - - - -

    Directories

    directory  network
     
    directory  utils
     
    diff --git a/docs/html/error_8hpp_source.html b/docs/html/error_8hpp_source.html index ef20622..8b57e67 100644 --- a/docs/html/error_8hpp_source.html +++ b/docs/html/error_8hpp_source.html @@ -69,13 +69,10 @@
    error.hpp
    -Go to the documentation of this file.
    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 <stdexcept>
    27 #include <string>
    28 
    29 #include <tacopie/utils/logger.hpp>
    30 
    31 namespace tacopie {
    32 
    36 class tacopie_error : public std::runtime_error {
    37 public:
    39  tacopie_error(const std::string& what, const std::string& file, std::size_t line);
    41  ~tacopie_error(void) = default;
    42 
    44  tacopie_error(const tacopie_error&) = default;
    46  tacopie_error& operator=(const tacopie_error&) = default;
    47 
    48 public:
    52  const std::string& get_file(void) const;
    53 
    57  std::size_t get_line(void) const;
    58 
    59 private:
    63  std::string m_file;
    64 
    68  std::size_t m_line;
    69 };
    70 
    71 } // namespace tacopie
    72 
    74 #define __TACOPIE_THROW(level, what) \
    75  { \
    76  __TACOPIE_LOG(level, (what)); \
    77  throw tacopie::tacopie_error((what), __FILE__, __LINE__); \
    78  }
    tacopie::tacopie_error::m_file
    std::string m_file
    Definition: error.hpp:63
    -
    tacopie::tacopie_error::get_file
    const std::string & get_file(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 <stdexcept>
    27 #include <string>
    28 
    29 #include <tacopie/utils/logger.hpp>
    30 
    31 namespace tacopie {
    32 
    36 class tacopie_error : public std::runtime_error {
    37 public:
    39  tacopie_error(const std::string& what, const std::string& file, std::size_t line);
    41  ~tacopie_error(void) = default;
    42 
    44  tacopie_error(const tacopie_error&) = default;
    46  tacopie_error& operator=(const tacopie_error&) = default;
    47 
    48 public:
    52  const std::string& get_file(void) const;
    53 
    57  std::size_t get_line(void) const;
    58 
    59 private:
    63  std::string m_file;
    64 
    68  std::size_t m_line;
    69 };
    70 
    71 } // namespace tacopie
    72 
    74 #define __TACOPIE_THROW(level, what) \
    75  { \
    76  __TACOPIE_LOG(level, (what)); \
    77  throw tacopie::tacopie_error((what), __FILE__, __LINE__); \
    78  }
    tacopie::tacopie_error::get_file
    const std::string & get_file(void) const
    tacopie::tacopie_error::tacopie_error
    tacopie_error(const std::string &what, const std::string &file, std::size_t line)
    ctor
    tacopie::tacopie_error
    Definition: error.hpp:36
    tacopie::tacopie_error::operator=
    tacopie_error & operator=(const tacopie_error &)=default
    assignment operator
    -
    tacopie::tacopie_error::m_line
    std::size_t m_line
    Definition: error.hpp:68
    -
    tacopie
    Definition: io_service.hpp:48
    tacopie::tacopie_error::get_line
    std::size_t get_line(void) const
    tacopie::tacopie_error::~tacopie_error
    ~tacopie_error(void)=default
    assignment operator
    diff --git a/docs/html/files.html b/docs/html/files.html index df109b1..f711e4c 100644 --- a/docs/html/files.html +++ b/docs/html/files.html @@ -65,21 +65,21 @@
    File List
    -
    Here is a list of all files with brief descriptions:
    +
    Here is a list of all documented files with brief descriptions:
    [detail level 1234]
    - - - - - + + + + + - - - - + + + +
     ▼ includes
     ▼ tacopie
     ▼ network
     io_service.hpp
     self_pipe.hpp
     tcp_client.hpp
     tcp_server.hpp
     tcp_socket.hpp
     io_service.hpp
     self_pipe.hpp
     tcp_client.hpp
     tcp_server.hpp
     tcp_socket.hpp
     ▼ utils
     error.hpp
     logger.hpp
     thread_pool.hpp
     typedefs.hpp
     error.hpp
     logger.hpp
     thread_pool.hpp
     typedefs.hpp
    diff --git a/docs/html/functions.html b/docs/html/functions.html index 13b3a15..d0066c6 100644 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -61,7 +61,7 @@
    -
    Here is a list of all class members with links to the classes they belong to:
    +
    Here is a list of all documented class members with links to the class documentation for each member:

    - a -

    diff --git a/docs/html/io__service_8hpp_source.html b/docs/html/io__service_8hpp_source.html index f71aa06..983e4ff 100644 --- a/docs/html/io__service_8hpp_source.html +++ b/docs/html/io__service_8hpp_source.html @@ -69,50 +69,18 @@
    io_service.hpp
    -Go to the documentation of this file.
    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 <atomic>
    26 #include <condition_variable>
    27 #include <functional>
    28 #include <memory>
    29 #include <mutex>
    30 #include <thread>
    31 #include <unordered_map>
    32 #include <vector>
    33 
    34 #ifdef _WIN32
    35 #include <Winsock2.h>
    36 #else
    37 #include <sys/select.h>
    38 #endif /* _WIN32 */
    39 
    40 #include <tacopie/network/self_pipe.hpp>
    41 #include <tacopie/network/tcp_socket.hpp>
    42 #include <tacopie/utils/thread_pool.hpp>
    43 
    44 #ifndef __TACOPIE_IO_SERVICE_NB_WORKERS
    45 #define __TACOPIE_IO_SERVICE_NB_WORKERS 1
    46 #endif /* __TACOPIE_IO_SERVICE_NB_WORKERS */
    47 
    48 namespace tacopie {
    49 
    54 class io_service {
    55 public:
    61  io_service(std::size_t nb_threads = __TACOPIE_IO_SERVICE_NB_WORKERS);
    62 
    64  ~io_service(void);
    65 
    67  io_service(const io_service&) = delete;
    69  io_service& operator=(const io_service&) = delete;
    70 
    71 public:
    79  void set_nb_workers(std::size_t nb_threads);
    80 
    81 public:
    84  typedef std::function<void(fd_t)> event_callback_t;
    85 
    87  void track(const tcp_socket& socket, const event_callback_t& rd_callback = nullptr, const event_callback_t& wr_callback = nullptr);
    88  void set_rd_callback(const tcp_socket& socket, const event_callback_t& event_callback);
    89  void set_wr_callback(const tcp_socket& socket, const event_callback_t& event_callback);
    90  void untrack(const tcp_socket& socket);
    91 
    94  void wait_for_removal(const tcp_socket& socket);
    95 
    96 private:
    107  struct tracked_socket {
    109  tracked_socket(void)
    110  : rd_callback(nullptr)
    111  , wr_callback(nullptr) {}
    112 
    114  event_callback_t rd_callback;
    115  std::atomic<bool> is_executing_rd_callback = ATOMIC_VAR_INIT(false);
    116 
    118  event_callback_t wr_callback;
    119  std::atomic<bool> is_executing_wr_callback = ATOMIC_VAR_INIT(false);
    120 
    122  std::atomic<bool> marked_for_untrack = ATOMIC_VAR_INIT(false);
    123  };
    124 
    125 private:
    130  void poll(void);
    131 
    138  int init_poll_fds_info(void);
    139 
    144  void process_events(void);
    145 
    152  void process_rd_event(const fd_t& fd, tracked_socket& socket);
    153 
    160  void process_wr_event(const fd_t& fd, tracked_socket& socket);
    161 
    162 private:
    166  std::unordered_map<fd_t, tracked_socket> m_tracked_sockets;
    167 
    171  std::atomic<bool> m_should_stop;
    172 
    176  std::thread m_poll_worker;
    177 
    181  utils::thread_pool m_callback_workers;
    182 
    186  std::mutex m_tracked_sockets_mtx;
    187 
    191  std::vector<fd_t> m_polled_fds;
    192 
    196  fd_set m_rd_set;
    197 
    201  fd_set m_wr_set;
    202 
    206  std::condition_variable m_wait_for_removal_condvar;
    207 
    211  tacopie::self_pipe m_notifier;
    212 };
    213 
    222 const std::shared_ptr<io_service>& get_default_io_service(std::uint32_t num_io_workers = 1);
    223 
    229 void set_default_io_service(const std::shared_ptr<io_service>& service);
    230 
    231 } // namespace tacopie
    tacopie::io_service::init_poll_fds_info
    int init_poll_fds_info(void)
    -
    tacopie::io_service::tracked_socket::is_executing_wr_callback
    std::atomic< bool > is_executing_wr_callback
    Definition: io_service.hpp:119
    -
    tacopie::set_default_io_service
    void set_default_io_service(const std::shared_ptr< io_service > &service)
    -
    tacopie::io_service::set_nb_workers
    void set_nb_workers(std::size_t nb_threads)
    -
    __TACOPIE_IO_SERVICE_NB_WORKERS
    #define __TACOPIE_IO_SERVICE_NB_WORKERS
    Definition: io_service.hpp:45
    -
    tacopie::io_service::tracked_socket::marked_for_untrack
    std::atomic< bool > marked_for_untrack
    marked for untrack
    Definition: io_service.hpp:122
    -
    tacopie::io_service::tracked_socket::tracked_socket
    tracked_socket(void)
    ctor
    Definition: io_service.hpp:109
    +
    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 <atomic>
    26 #include <condition_variable>
    27 #include <functional>
    28 #include <memory>
    29 #include <mutex>
    30 #include <thread>
    31 #include <unordered_map>
    32 #include <vector>
    33 
    34 #ifdef _WIN32
    35 #include <Winsock2.h>
    36 #else
    37 #include <sys/select.h>
    38 #endif /* _WIN32 */
    39 
    40 #include <tacopie/network/self_pipe.hpp>
    41 #include <tacopie/network/tcp_socket.hpp>
    42 #include <tacopie/utils/thread_pool.hpp>
    43 
    44 #ifndef __TACOPIE_IO_SERVICE_NB_WORKERS
    45 #define __TACOPIE_IO_SERVICE_NB_WORKERS 1
    46 #endif /* __TACOPIE_IO_SERVICE_NB_WORKERS */
    47 
    48 namespace tacopie {
    49 
    54 class io_service {
    55 public:
    61  io_service(std::size_t nb_threads = __TACOPIE_IO_SERVICE_NB_WORKERS);
    62 
    64  ~io_service(void);
    65 
    67  io_service(const io_service&) = delete;
    69  io_service& operator=(const io_service&) = delete;
    70 
    71 public:
    79  void set_nb_workers(std::size_t nb_threads);
    80 
    81 public:
    84  typedef std::function<void(fd_t)> event_callback_t;
    85 
    87  void track(const tcp_socket& socket, const event_callback_t& rd_callback = nullptr, const event_callback_t& wr_callback = nullptr);
    88  void set_rd_callback(const tcp_socket& socket, const event_callback_t& event_callback);
    89  void set_wr_callback(const tcp_socket& socket, const event_callback_t& event_callback);
    90  void untrack(const tcp_socket& socket);
    91 
    94  void wait_for_removal(const tcp_socket& socket);
    95 
    96 private:
    107  struct tracked_socket {
    109  tracked_socket(void)
    110  : rd_callback(nullptr)
    111  , wr_callback(nullptr) {}
    112 
    114  event_callback_t rd_callback;
    115  std::atomic<bool> is_executing_rd_callback = ATOMIC_VAR_INIT(false);
    116 
    118  event_callback_t wr_callback;
    119  std::atomic<bool> is_executing_wr_callback = ATOMIC_VAR_INIT(false);
    120 
    122  std::atomic<bool> marked_for_untrack = ATOMIC_VAR_INIT(false);
    123  };
    124 
    125 private:
    130  void poll(void);
    131 
    138  int init_poll_fds_info(void);
    139 
    144  void process_events(void);
    145 
    152  void process_rd_event(const fd_t& fd, tracked_socket& socket);
    153 
    160  void process_wr_event(const fd_t& fd, tracked_socket& socket);
    161 
    162 private:
    166  std::unordered_map<fd_t, tracked_socket> m_tracked_sockets;
    167 
    171  std::atomic<bool> m_should_stop;
    172 
    176  std::thread m_poll_worker;
    177 
    181  utils::thread_pool m_callback_workers;
    182 
    186  std::mutex m_tracked_sockets_mtx;
    187 
    191  std::vector<fd_t> m_polled_fds;
    192 
    196  fd_set m_rd_set;
    197 
    201  fd_set m_wr_set;
    202 
    206  std::condition_variable m_wait_for_removal_condvar;
    207 
    211  tacopie::self_pipe m_notifier;
    212 };
    213 
    222 const std::shared_ptr<io_service>& get_default_io_service(std::uint32_t num_io_workers = 1);
    223 
    229 void set_default_io_service(const std::shared_ptr<io_service>& service);
    230 
    231 } // namespace tacopie
    tacopie::io_service::set_nb_workers
    void set_nb_workers(std::size_t nb_threads)
    tacopie::io_service::~io_service
    ~io_service(void)
    dtor
    tacopie::io_service::event_callback_t
    std::function< void(fd_t)> event_callback_t
    Definition: io_service.hpp:84
    tacopie::io_service::io_service
    io_service(std::size_t nb_threads=__TACOPIE_IO_SERVICE_NB_WORKERS)
    -
    self_pipe.hpp
    -
    tacopie::io_service::m_notifier
    tacopie::self_pipe m_notifier
    Definition: io_service.hpp:211
    -
    tacopie::io_service::untrack
    void untrack(const tcp_socket &socket)
    -
    tacopie::io_service::process_wr_event
    void process_wr_event(const fd_t &fd, tracked_socket &socket)
    tacopie::io_service::operator=
    io_service & operator=(const io_service &)=delete
    assignment operator
    tacopie::tcp_socket
    Definition: tcp_socket.hpp:38
    tacopie::io_service
    Definition: io_service.hpp:54
    -
    tacopie::io_service::m_should_stop
    std::atomic< bool > m_should_stop
    Definition: io_service.hpp:171
    -
    tacopie::io_service::m_callback_workers
    utils::thread_pool m_callback_workers
    Definition: io_service.hpp:181
    -
    tacopie::io_service::m_wait_for_removal_condvar
    std::condition_variable m_wait_for_removal_condvar
    Definition: io_service.hpp:206
    -
    tacopie::io_service::m_rd_set
    fd_set m_rd_set
    Definition: io_service.hpp:196
    tacopie::io_service::wait_for_removal
    void wait_for_removal(const tcp_socket &socket)
    -
    tacopie::io_service::m_tracked_sockets_mtx
    std::mutex m_tracked_sockets_mtx
    Definition: io_service.hpp:186
    tacopie::self_pipe
    Definition: self_pipe.hpp:29
    -
    tacopie::io_service::m_poll_worker
    std::thread m_poll_worker
    Definition: io_service.hpp:176
    -
    tcp_socket.hpp
    -
    tacopie::io_service::m_polled_fds
    std::vector< fd_t > m_polled_fds
    Definition: io_service.hpp:191
    tacopie
    Definition: io_service.hpp:48
    -
    tacopie::io_service::process_rd_event
    void process_rd_event(const fd_t &fd, tracked_socket &socket)
    -
    tacopie::io_service::m_tracked_sockets
    std::unordered_map< fd_t, tracked_socket > m_tracked_sockets
    Definition: io_service.hpp:166
    -
    tacopie::io_service::set_wr_callback
    void set_wr_callback(const tcp_socket &socket, const event_callback_t &event_callback)
    -
    tacopie::io_service::tracked_socket
    Definition: io_service.hpp:107
    -
    thread_pool.hpp
    -
    tacopie::io_service::m_wr_set
    fd_set m_wr_set
    Definition: io_service.hpp:201
    -
    tacopie::io_service::process_events
    void process_events(void)
    -
    tacopie::io_service::tracked_socket::rd_callback
    event_callback_t rd_callback
    rd event
    Definition: io_service.hpp:114
    tacopie::io_service::track
    void track(const tcp_socket &socket, const event_callback_t &rd_callback=nullptr, const event_callback_t &wr_callback=nullptr)
    track & untrack socket
    tacopie::utils::thread_pool
    Definition: thread_pool.hpp:37
    -
    tacopie::fd_t
    int fd_t
    file descriptor platform type
    Definition: typedefs.hpp:36
    -
    tacopie::io_service::set_rd_callback
    void set_rd_callback(const tcp_socket &socket, const event_callback_t &event_callback)
    -
    tacopie::get_default_io_service
    const std::shared_ptr< io_service > & get_default_io_service(std::uint32_t num_io_workers=1)
    -
    tacopie::io_service::poll
    void poll(void)
    -
    tacopie::io_service::tracked_socket::wr_callback
    event_callback_t wr_callback
    wr event
    Definition: io_service.hpp:118
    -
    tacopie::io_service::tracked_socket::is_executing_rd_callback
    std::atomic< bool > is_executing_rd_callback
    Definition: io_service.hpp:115
    diff --git a/docs/html/logger_8hpp_source.html b/docs/html/logger_8hpp_source.html index 604b07e..e650c9f 100644 --- a/docs/html/logger_8hpp_source.html +++ b/docs/html/logger_8hpp_source.html @@ -69,21 +69,17 @@
    logger.hpp
    -Go to the documentation of this file.
    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 <memory>
    26 #include <mutex>
    27 #include <string>
    28 
    29 namespace tacopie {
    30 
    35 class logger_iface {
    36 public:
    38  logger_iface(void) = default;
    40  virtual ~logger_iface(void) = default;
    41 
    43  logger_iface(const logger_iface&) = default;
    45  logger_iface& operator=(const logger_iface&) = default;
    46 
    47 public:
    55  virtual void debug(const std::string& msg, const std::string& file, std::size_t line) = 0;
    56 
    64  virtual void info(const std::string& msg, const std::string& file, std::size_t line) = 0;
    65 
    73  virtual void warn(const std::string& msg, const std::string& file, std::size_t line) = 0;
    74 
    82  virtual void error(const std::string& msg, const std::string& file, std::size_t line) = 0;
    83 };
    84 
    88 class logger : public logger_iface {
    89 public:
    93  enum class log_level {
    94  error = 0,
    95  warn = 1,
    96  info = 2,
    97  debug = 3
    98  };
    99 
    100 public:
    102  logger(log_level level = log_level::info);
    104  ~logger(void) = default;
    105 
    107  logger(const logger&) = default;
    109  logger& operator=(const logger&) = default;
    110 
    111 public:
    119  void debug(const std::string& msg, const std::string& file, std::size_t line);
    120 
    128  void info(const std::string& msg, const std::string& file, std::size_t line);
    129 
    137  void warn(const std::string& msg, const std::string& file, std::size_t line);
    138 
    146  void error(const std::string& msg, const std::string& file, std::size_t line);
    147 
    148 private:
    152  log_level m_level;
    153 
    157  std::mutex m_mutex;
    158 };
    159 
    164 extern std::unique_ptr<logger_iface> active_logger;
    165 
    174 void debug(const std::string& msg, const std::string& file, std::size_t line);
    175 
    184 void info(const std::string& msg, const std::string& file, std::size_t line);
    185 
    194 void warn(const std::string& msg, const std::string& file, std::size_t line);
    195 
    204 void error(const std::string& msg, const std::string& file, std::size_t line);
    205 
    209 #ifdef __TACOPIE_LOGGING_ENABLED
    210 #define __TACOPIE_LOG(level, msg) tacopie::level(msg, __FILE__, __LINE__);
    211 #else
    212 #define __TACOPIE_LOG(level, msg)
    213 #endif /* __TACOPIE_LOGGING_ENABLED */
    214 
    215 } // namespace tacopie
    tacopie::logger
    Definition: logger.hpp:88
    +
    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 <memory>
    26 #include <mutex>
    27 #include <string>
    28 
    29 namespace tacopie {
    30 
    35 class logger_iface {
    36 public:
    38  logger_iface(void) = default;
    40  virtual ~logger_iface(void) = default;
    41 
    43  logger_iface(const logger_iface&) = default;
    45  logger_iface& operator=(const logger_iface&) = default;
    46 
    47 public:
    55  virtual void debug(const std::string& msg, const std::string& file, std::size_t line) = 0;
    56 
    64  virtual void info(const std::string& msg, const std::string& file, std::size_t line) = 0;
    65 
    73  virtual void warn(const std::string& msg, const std::string& file, std::size_t line) = 0;
    74 
    82  virtual void error(const std::string& msg, const std::string& file, std::size_t line) = 0;
    83 };
    84 
    88 class logger : public logger_iface {
    89 public:
    93  enum class log_level {
    94  error = 0,
    95  warn = 1,
    96  info = 2,
    97  debug = 3
    98  };
    99 
    100 public:
    102  logger(log_level level = log_level::info);
    104  ~logger(void) = default;
    105 
    107  logger(const logger&) = default;
    109  logger& operator=(const logger&) = default;
    110 
    111 public:
    119  void debug(const std::string& msg, const std::string& file, std::size_t line);
    120 
    128  void info(const std::string& msg, const std::string& file, std::size_t line);
    129 
    137  void warn(const std::string& msg, const std::string& file, std::size_t line);
    138 
    146  void error(const std::string& msg, const std::string& file, std::size_t line);
    147 
    148 private:
    152  log_level m_level;
    153 
    157  std::mutex m_mutex;
    158 };
    159 
    164 extern std::unique_ptr<logger_iface> active_logger;
    165 
    174 void debug(const std::string& msg, const std::string& file, std::size_t line);
    175 
    184 void info(const std::string& msg, const std::string& file, std::size_t line);
    185 
    194 void warn(const std::string& msg, const std::string& file, std::size_t line);
    195 
    204 void error(const std::string& msg, const std::string& file, std::size_t line);
    205 
    209 #ifdef __TACOPIE_LOGGING_ENABLED
    210 #define __TACOPIE_LOG(level, msg) tacopie::level(msg, __FILE__, __LINE__);
    211 #else
    212 #define __TACOPIE_LOG(level, msg)
    213 #endif /* __TACOPIE_LOGGING_ENABLED */
    214 
    215 } // namespace tacopie
    tacopie::logger
    Definition: logger.hpp:88
    tacopie::logger_iface::debug
    virtual void debug(const std::string &msg, const std::string &file, std::size_t line)=0
    tacopie::logger_iface::warn
    virtual void warn(const std::string &msg, const std::string &file, std::size_t line)=0
    tacopie::logger_iface::logger_iface
    logger_iface(void)=default
    ctor
    tacopie
    Definition: io_service.hpp:48
    -
    tacopie::logger::m_level
    log_level m_level
    Definition: logger.hpp:152
    tacopie::logger_iface::~logger_iface
    virtual ~logger_iface(void)=default
    dtor
    tacopie::logger_iface::error
    virtual void error(const std::string &msg, const std::string &file, std::size_t line)=0
    tacopie::logger::log_level
    log_level
    Definition: logger.hpp:93
    -
    tacopie::info
    void info(const std::string &msg, const std::string &file, std::size_t line)
    tacopie::logger_iface::info
    virtual void info(const std::string &msg, const std::string &file, std::size_t line)=0
    -
    tacopie::active_logger
    std::unique_ptr< logger_iface > active_logger
    tacopie::logger_iface::operator=
    logger_iface & operator=(const logger_iface &)=default
    assignment operator
    tacopie::logger_iface
    Definition: logger.hpp:35
    -
    tacopie::logger::m_mutex
    std::mutex m_mutex
    Definition: logger.hpp:157
    diff --git a/docs/html/menudata.js b/docs/html/menudata.js index ad13cff..99b9d26 100644 --- a/docs/html/menudata.js +++ b/docs/html/menudata.js @@ -1,12 +1,5 @@ var menudata={children:[ {text:"Main Page",url:"index.html"}, -{text:"Namespaces",url:"namespaces.html",children:[ -{text:"Namespace List",url:"namespaces.html"}, -{text:"Namespace Members",url:"namespacemembers.html",children:[ -{text:"All",url:"namespacemembers.html"}, -{text:"Functions",url:"namespacemembers_func.html"}, -{text:"Variables",url:"namespacemembers_vars.html"}, -{text:"Typedefs",url:"namespacemembers_type.html"}]}]}, {text:"Classes",url:"annotated.html",children:[ {text:"Class List",url:"annotated.html"}, {text:"Class Index",url:"classes.html"}, @@ -18,18 +11,14 @@ var menudata={children:[ {text:"c",url:"functions.html#index_c"}, {text:"d",url:"functions.html#index_d"}, {text:"e",url:"functions.html#index_e"}, -{text:"f",url:"functions.html#index_f"}, {text:"g",url:"functions.html#index_g"}, {text:"i",url:"functions.html#index_i"}, {text:"l",url:"functions.html#index_l"}, -{text:"m",url:"functions.html#index_m"}, {text:"n",url:"functions.html#index_n"}, {text:"o",url:"functions.html#index_o"}, -{text:"p",url:"functions.html#index_p"}, {text:"r",url:"functions.html#index_r"}, {text:"s",url:"functions.html#index_s"}, {text:"t",url:"functions.html#index_t"}, -{text:"u",url:"functions.html#index_u"}, {text:"w",url:"functions.html#index_w"}, {text:"~",url:"functions.html#index_0x7e"}]}, {text:"Functions",url:"functions_func.html",children:[ @@ -38,31 +27,17 @@ var menudata={children:[ {text:"c",url:"functions_func.html#index_c"}, {text:"d",url:"functions_func.html#index_d"}, {text:"e",url:"functions_func.html#index_e"}, -{text:"f",url:"functions_func.html#index_f"}, {text:"g",url:"functions_func.html#index_g"}, {text:"i",url:"functions_func.html#index_i"}, {text:"l",url:"functions_func.html#index_l"}, {text:"n",url:"functions_func.html#index_n"}, {text:"o",url:"functions_func.html#index_o"}, -{text:"p",url:"functions_func.html#index_p"}, {text:"r",url:"functions_func.html#index_r"}, {text:"s",url:"functions_func.html#index_s"}, {text:"t",url:"functions_func.html#index_t"}, -{text:"u",url:"functions_func.html#index_u"}, {text:"w",url:"functions_func.html#index_w"}, {text:"~",url:"functions_func.html#index_0x7e"}]}, -{text:"Variables",url:"functions_vars.html",children:[ -{text:"a",url:"functions_vars.html#index_a"}, -{text:"b",url:"functions_vars.html#index_b"}, -{text:"i",url:"functions_vars.html#index_i"}, -{text:"m",url:"functions_vars.html#index_m"}, -{text:"r",url:"functions_vars.html#index_r"}, -{text:"s",url:"functions_vars.html#index_s"}, -{text:"w",url:"functions_vars.html#index_w"}]}, {text:"Typedefs",url:"functions_type.html"}, {text:"Enumerations",url:"functions_enum.html"}]}]}, {text:"Files",url:"files.html",children:[ -{text:"File List",url:"files.html"}, -{text:"File Members",url:"globals.html",children:[ -{text:"All",url:"globals.html"}, -{text:"Macros",url:"globals_defs.html"}]}]}]} +{text:"File List",url:"files.html"}]}]} diff --git a/docs/html/search/all_0.js b/docs/html/search/all_0.js index 280406d..14d2cee 100644 --- a/docs/html/search/all_0.js +++ b/docs/html/search/all_0.js @@ -1,8 +1,9 @@ var searchData= [ - ['_5f_5ftacopie_5fconnection_5fqueue_5fsize',['__TACOPIE_CONNECTION_QUEUE_SIZE',['../tcp__server_8hpp.html#adebb9fdca4ff2a2f68e6177d77a5ce7b',1,'tcp_server.hpp']]], - ['_5f_5ftacopie_5finvalid_5ffd',['__TACOPIE_INVALID_FD',['../typedefs_8hpp.html#a0e879255fa9ca4ba90dfc6f91c5f592f',1,'typedefs.hpp']]], - ['_5f_5ftacopie_5fio_5fservice_5fnb_5fworkers',['__TACOPIE_IO_SERVICE_NB_WORKERS',['../io__service_8hpp.html#a822f465d034836ecbc765ad422eec064',1,'io_service.hpp']]], - ['_5f_5ftacopie_5flog',['__TACOPIE_LOG',['../logger_8hpp.html#a845e651e4529d5322a7cebc54a923bce',1,'logger.hpp']]], - ['_5f_5ftacopie_5fthrow',['__TACOPIE_THROW',['../error_8hpp.html#aacdfb7799f2e2e2f57d6f1392ff3220a',1,'error.hpp']]] + ['accept',['accept',['../classtacopie_1_1tcp__socket.html#af5113c9332f83643cdaaf15c3f137760',1,'tacopie::tcp_socket']]], + ['add_5ftask',['add_task',['../classtacopie_1_1utils_1_1thread__pool.html#a450bee2b7b2cd0aa0bc3935c8adc9ace',1,'tacopie::utils::thread_pool']]], + ['async_5fread',['async_read',['../classtacopie_1_1tcp__client.html#a120e3ec2902acc902f7a0b27074bda6b',1,'tacopie::tcp_client']]], + ['async_5fread_5fcallback_5ft',['async_read_callback_t',['../classtacopie_1_1tcp__client.html#acdf9dea8bac6c56f7b04ce38b9432322',1,'tacopie::tcp_client']]], + ['async_5fwrite',['async_write',['../classtacopie_1_1tcp__client.html#a2304ed6d4ca0cbc74e6aa72d3e92b76a',1,'tacopie::tcp_client']]], + ['async_5fwrite_5fcallback_5ft',['async_write_callback_t',['../classtacopie_1_1tcp__client.html#ad48b8c8dff8a77490eb2e3e802c82b97',1,'tacopie::tcp_client']]] ]; diff --git a/docs/html/search/all_1.js b/docs/html/search/all_1.js index 5458034..a403a92 100644 --- a/docs/html/search/all_1.js +++ b/docs/html/search/all_1.js @@ -1,12 +1,4 @@ var searchData= [ - ['accept',['accept',['../classtacopie_1_1tcp__socket.html#af5113c9332f83643cdaaf15c3f137760',1,'tacopie::tcp_socket']]], - ['active_5flogger',['active_logger',['../namespacetacopie.html#a043624ac998613a9387aca78a7f39f41',1,'tacopie']]], - ['add_5ftask',['add_task',['../classtacopie_1_1utils_1_1thread__pool.html#a450bee2b7b2cd0aa0bc3935c8adc9ace',1,'tacopie::utils::thread_pool']]], - ['async_5fread',['async_read',['../classtacopie_1_1tcp__client.html#a120e3ec2902acc902f7a0b27074bda6b',1,'tacopie::tcp_client']]], - ['async_5fread_5fcallback',['async_read_callback',['../structtacopie_1_1tcp__client_1_1read__request.html#a3d495e82e38efebf763f595392b0db46',1,'tacopie::tcp_client::read_request']]], - ['async_5fread_5fcallback_5ft',['async_read_callback_t',['../classtacopie_1_1tcp__client.html#acdf9dea8bac6c56f7b04ce38b9432322',1,'tacopie::tcp_client']]], - ['async_5fwrite',['async_write',['../classtacopie_1_1tcp__client.html#a2304ed6d4ca0cbc74e6aa72d3e92b76a',1,'tacopie::tcp_client']]], - ['async_5fwrite_5fcallback',['async_write_callback',['../structtacopie_1_1tcp__client_1_1write__request.html#a04fd3e5484ba322d0112024bf8823623',1,'tacopie::tcp_client::write_request']]], - ['async_5fwrite_5fcallback_5ft',['async_write_callback_t',['../classtacopie_1_1tcp__client.html#ad48b8c8dff8a77490eb2e3e802c82b97',1,'tacopie::tcp_client']]] + ['bind',['bind',['../classtacopie_1_1tcp__socket.html#a910a183d7c45483f1cdacd10a1896155',1,'tacopie::tcp_socket']]] ]; diff --git a/docs/html/search/all_2.js b/docs/html/search/all_2.js index c94fb21..33c5eab 100644 --- a/docs/html/search/all_2.js +++ b/docs/html/search/all_2.js @@ -1,5 +1,6 @@ var searchData= [ - ['bind',['bind',['../classtacopie_1_1tcp__socket.html#a910a183d7c45483f1cdacd10a1896155',1,'tacopie::tcp_socket']]], - ['buffer',['buffer',['../structtacopie_1_1tcp__client_1_1read__result.html#a50d22ea3a43d085d88d54bbf59a357dc',1,'tacopie::tcp_client::read_result::buffer()'],['../structtacopie_1_1tcp__client_1_1write__request.html#a4ee0c159b630c14f81d6b6d7d4b4e826',1,'tacopie::tcp_client::write_request::buffer()']]] + ['close',['close',['../classtacopie_1_1tcp__socket.html#ad5a30b17b1dad9f0ff40305e246a9213',1,'tacopie::tcp_socket']]], + ['clr_5fbuffer',['clr_buffer',['../classtacopie_1_1self__pipe.html#a4f55a34bd882d59bdcc73b87222ba3d8',1,'tacopie::self_pipe']]], + ['connect',['connect',['../classtacopie_1_1tcp__client.html#a0cfbb18cb72aa3b6a41921f61cacc425',1,'tacopie::tcp_client::connect()'],['../classtacopie_1_1tcp__socket.html#a6748c78312763dca6b8be05c4c8c3419',1,'tacopie::tcp_socket::connect()']]] ]; diff --git a/docs/html/search/all_3.js b/docs/html/search/all_3.js index 9dc66e2..fbc3eb2 100644 --- a/docs/html/search/all_3.js +++ b/docs/html/search/all_3.js @@ -1,12 +1,6 @@ var searchData= [ - ['call_5fdisconnection_5fhandler',['call_disconnection_handler',['../classtacopie_1_1tcp__client.html#ae38ae1f64909dd36592a02fc3c245672',1,'tacopie::tcp_client']]], - ['check_5for_5fset_5ftype',['check_or_set_type',['../classtacopie_1_1tcp__socket.html#a53067d6b401c7a7d8c8da3be0713480c',1,'tacopie::tcp_socket']]], - ['clear_5fread_5frequests',['clear_read_requests',['../classtacopie_1_1tcp__client.html#afdb370d07800a95448a645f4605d54e1',1,'tacopie::tcp_client']]], - ['clear_5fwrite_5frequests',['clear_write_requests',['../classtacopie_1_1tcp__client.html#acd8c8d54f359ed99be3a2dd50ef0ec77',1,'tacopie::tcp_client']]], - ['client',['CLIENT',['../classtacopie_1_1tcp__socket.html#ad8376e85df96ab9523f5d079ed7172abaef10c650df47bffd6399e5e78da2a9b1',1,'tacopie::tcp_socket']]], - ['close',['close',['../classtacopie_1_1tcp__socket.html#ad5a30b17b1dad9f0ff40305e246a9213',1,'tacopie::tcp_socket']]], - ['clr_5fbuffer',['clr_buffer',['../classtacopie_1_1self__pipe.html#a4f55a34bd882d59bdcc73b87222ba3d8',1,'tacopie::self_pipe']]], - ['connect',['connect',['../classtacopie_1_1tcp__client.html#a0cfbb18cb72aa3b6a41921f61cacc425',1,'tacopie::tcp_client::connect()'],['../classtacopie_1_1tcp__socket.html#a6748c78312763dca6b8be05c4c8c3419',1,'tacopie::tcp_socket::connect()']]], - ['create_5fsocket_5fif_5fnecessary',['create_socket_if_necessary',['../classtacopie_1_1tcp__socket.html#ac2f77e32211a33e0cf4fd8de33946761',1,'tacopie::tcp_socket']]] + ['debug',['debug',['../classtacopie_1_1logger__iface.html#a156abb02ab852ea4033fc13f4902ee7a',1,'tacopie::logger_iface::debug()'],['../classtacopie_1_1logger.html#aff31bbc7d3fdbbe60a2331fe24ec76ff',1,'tacopie::logger::debug()']]], + ['disconnect',['disconnect',['../classtacopie_1_1tcp__client.html#a7562e0bfa24912595d6f695f848b9e51',1,'tacopie::tcp_client']]], + ['disconnection_5fhandler_5ft',['disconnection_handler_t',['../classtacopie_1_1tcp__client.html#aca5df52e5ee6fa673cf212532ada1453',1,'tacopie::tcp_client']]] ]; diff --git a/docs/html/search/all_4.js b/docs/html/search/all_4.js index 7d471cf..4e36078 100644 --- a/docs/html/search/all_4.js +++ b/docs/html/search/all_4.js @@ -1,6 +1,5 @@ var searchData= [ - ['debug',['debug',['../classtacopie_1_1logger__iface.html#a156abb02ab852ea4033fc13f4902ee7a',1,'tacopie::logger_iface::debug()'],['../classtacopie_1_1logger.html#aff31bbc7d3fdbbe60a2331fe24ec76ff',1,'tacopie::logger::debug(const std::string &msg, const std::string &file, std::size_t line)'],['../classtacopie_1_1logger.html#ae7dd235972bbf86a017fc39b3af80efeaad42f6697b035b7580e4fef93be20b4d',1,'tacopie::logger::debug()'],['../namespacetacopie.html#a0833874b07ad56b5ba2c7847f1e514b0',1,'tacopie::debug()']]], - ['disconnect',['disconnect',['../classtacopie_1_1tcp__client.html#a7562e0bfa24912595d6f695f848b9e51',1,'tacopie::tcp_client']]], - ['disconnection_5fhandler_5ft',['disconnection_handler_t',['../classtacopie_1_1tcp__client.html#aca5df52e5ee6fa673cf212532ada1453',1,'tacopie::tcp_client']]] + ['error',['error',['../classtacopie_1_1logger__iface.html#a18f9c02fc19be4b9900ac9fb1a361624',1,'tacopie::logger_iface::error()'],['../classtacopie_1_1logger.html#a3fe1be02ac2f4e4fe44a0bdaf8359546',1,'tacopie::logger::error()']]], + ['event_5fcallback_5ft',['event_callback_t',['../classtacopie_1_1io__service.html#abb66850c32d9c724f4418d77bd04bcfd',1,'tacopie::io_service']]] ]; diff --git a/docs/html/search/all_5.js b/docs/html/search/all_5.js index bfe3e1d..d84d45a 100644 --- a/docs/html/search/all_5.js +++ b/docs/html/search/all_5.js @@ -1,6 +1,14 @@ var searchData= [ - ['error',['error',['../classtacopie_1_1logger__iface.html#a18f9c02fc19be4b9900ac9fb1a361624',1,'tacopie::logger_iface::error()'],['../classtacopie_1_1logger.html#a3fe1be02ac2f4e4fe44a0bdaf8359546',1,'tacopie::logger::error(const std::string &msg, const std::string &file, std::size_t line)'],['../classtacopie_1_1logger.html#ae7dd235972bbf86a017fc39b3af80efeacb5e100e5a9a3e7f6d1fd97512215282',1,'tacopie::logger::error()'],['../namespacetacopie.html#a48f7b277b1559f2333c1186fa629ef01',1,'tacopie::error()']]], - ['error_2ehpp',['error.hpp',['../error_8hpp.html',1,'']]], - ['event_5fcallback_5ft',['event_callback_t',['../classtacopie_1_1io__service.html#abb66850c32d9c724f4418d77bd04bcfd',1,'tacopie::io_service']]] + ['get_5fclients',['get_clients',['../classtacopie_1_1tcp__server.html#a0df81b943243ad51102c37d4944be8d7',1,'tacopie::tcp_server']]], + ['get_5ffd',['get_fd',['../classtacopie_1_1tcp__socket.html#a4fd367a1802ed6ae7fa0e33fc07ed255',1,'tacopie::tcp_socket']]], + ['get_5ffile',['get_file',['../classtacopie_1_1tacopie__error.html#a10360163c780a1bd9c95fcecca5aa6da',1,'tacopie::tacopie_error']]], + ['get_5fhost',['get_host',['../classtacopie_1_1tcp__client.html#ad38ab710c5eca64de2f887abc455b15d',1,'tacopie::tcp_client::get_host()'],['../classtacopie_1_1tcp__socket.html#ad294565f9a0fa52639ecfbf133eecd59',1,'tacopie::tcp_socket::get_host()']]], + ['get_5fio_5fservice',['get_io_service',['../classtacopie_1_1tcp__client.html#aafbf0aa37cd0472778d09fb163362314',1,'tacopie::tcp_client::get_io_service()'],['../classtacopie_1_1tcp__server.html#aace4796627b6abccccce1a541908414f',1,'tacopie::tcp_server::get_io_service()']]], + ['get_5fline',['get_line',['../classtacopie_1_1tacopie__error.html#a39704d2cb6f076aa47d45f53f174b257',1,'tacopie::tacopie_error']]], + ['get_5fport',['get_port',['../classtacopie_1_1tcp__client.html#a3b42ae2afe6d5ee5f2f16b8bd7846f37',1,'tacopie::tcp_client::get_port()'],['../classtacopie_1_1tcp__socket.html#a5276fdc687ac3c5089a05e3e2d9de4fb',1,'tacopie::tcp_socket::get_port()']]], + ['get_5fread_5ffd',['get_read_fd',['../classtacopie_1_1self__pipe.html#a301b416f5f8236a383065b381385b88c',1,'tacopie::self_pipe']]], + ['get_5fsocket',['get_socket',['../classtacopie_1_1tcp__client.html#a1a3834deb1d263ec5816066f74286298',1,'tacopie::tcp_client::get_socket(void)'],['../classtacopie_1_1tcp__client.html#a9cf1f3ccf43f9a0a883a17b15e3668d6',1,'tacopie::tcp_client::get_socket(void) const'],['../classtacopie_1_1tcp__server.html#a39a51b9203d42babfd9c4c1a0f4cc340',1,'tacopie::tcp_server::get_socket(void)'],['../classtacopie_1_1tcp__server.html#a373aec294e24a52c3ef6c44920af36e2',1,'tacopie::tcp_server::get_socket(void) const']]], + ['get_5ftype',['get_type',['../classtacopie_1_1tcp__socket.html#a4f663be51b845520505bc20a88b411ee',1,'tacopie::tcp_socket']]], + ['get_5fwrite_5ffd',['get_write_fd',['../classtacopie_1_1self__pipe.html#ab36a4deb45bb408988f26315aedc0d74',1,'tacopie::self_pipe']]] ]; diff --git a/docs/html/search/all_6.js b/docs/html/search/all_6.js index 68bfd4e..aafc307 100644 --- a/docs/html/search/all_6.js +++ b/docs/html/search/all_6.js @@ -1,5 +1,7 @@ var searchData= [ - ['fd_5ft',['fd_t',['../namespacetacopie.html#acce7ad26b2d30156b1e6fa353f727026',1,'tacopie']]], - ['fetch_5ftask',['fetch_task',['../classtacopie_1_1utils_1_1thread__pool.html#a182472a7727edc7d37d2309ccbc2dea7',1,'tacopie::utils::thread_pool']]] + ['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_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/all_7.js b/docs/html/search/all_7.js index 89d2025..de1c50f 100644 --- a/docs/html/search/all_7.js +++ b/docs/html/search/all_7.js @@ -1,15 +1,7 @@ var searchData= [ - ['get_5fclients',['get_clients',['../classtacopie_1_1tcp__server.html#a0df81b943243ad51102c37d4944be8d7',1,'tacopie::tcp_server']]], - ['get_5fdefault_5fio_5fservice',['get_default_io_service',['../namespacetacopie.html#a08584acd5790cf1f3c9af96e5a8494a6',1,'tacopie']]], - ['get_5ffd',['get_fd',['../classtacopie_1_1tcp__socket.html#a4fd367a1802ed6ae7fa0e33fc07ed255',1,'tacopie::tcp_socket']]], - ['get_5ffile',['get_file',['../classtacopie_1_1tacopie__error.html#a10360163c780a1bd9c95fcecca5aa6da',1,'tacopie::tacopie_error']]], - ['get_5fhost',['get_host',['../classtacopie_1_1tcp__client.html#ad38ab710c5eca64de2f887abc455b15d',1,'tacopie::tcp_client::get_host()'],['../classtacopie_1_1tcp__socket.html#ad294565f9a0fa52639ecfbf133eecd59',1,'tacopie::tcp_socket::get_host()']]], - ['get_5fio_5fservice',['get_io_service',['../classtacopie_1_1tcp__client.html#aafbf0aa37cd0472778d09fb163362314',1,'tacopie::tcp_client::get_io_service()'],['../classtacopie_1_1tcp__server.html#aace4796627b6abccccce1a541908414f',1,'tacopie::tcp_server::get_io_service()']]], - ['get_5fline',['get_line',['../classtacopie_1_1tacopie__error.html#a39704d2cb6f076aa47d45f53f174b257',1,'tacopie::tacopie_error']]], - ['get_5fport',['get_port',['../classtacopie_1_1tcp__client.html#a3b42ae2afe6d5ee5f2f16b8bd7846f37',1,'tacopie::tcp_client::get_port()'],['../classtacopie_1_1tcp__socket.html#a5276fdc687ac3c5089a05e3e2d9de4fb',1,'tacopie::tcp_socket::get_port()']]], - ['get_5fread_5ffd',['get_read_fd',['../classtacopie_1_1self__pipe.html#a301b416f5f8236a383065b381385b88c',1,'tacopie::self_pipe']]], - ['get_5fsocket',['get_socket',['../classtacopie_1_1tcp__client.html#a1a3834deb1d263ec5816066f74286298',1,'tacopie::tcp_client::get_socket(void)'],['../classtacopie_1_1tcp__client.html#a9cf1f3ccf43f9a0a883a17b15e3668d6',1,'tacopie::tcp_client::get_socket(void) const'],['../classtacopie_1_1tcp__server.html#a39a51b9203d42babfd9c4c1a0f4cc340',1,'tacopie::tcp_server::get_socket(void)'],['../classtacopie_1_1tcp__server.html#a373aec294e24a52c3ef6c44920af36e2',1,'tacopie::tcp_server::get_socket(void) const']]], - ['get_5ftype',['get_type',['../classtacopie_1_1tcp__socket.html#a4f663be51b845520505bc20a88b411ee',1,'tacopie::tcp_socket']]], - ['get_5fwrite_5ffd',['get_write_fd',['../classtacopie_1_1self__pipe.html#ab36a4deb45bb408988f26315aedc0d74',1,'tacopie::self_pipe']]] + ['listen',['listen',['../classtacopie_1_1tcp__socket.html#af0957ded2a84fb06d940cba98df477fb',1,'tacopie::tcp_socket']]], + ['log_5flevel',['log_level',['../classtacopie_1_1logger.html#ae7dd235972bbf86a017fc39b3af80efe',1,'tacopie::logger']]], + ['logger',['logger',['../classtacopie_1_1logger.html',1,'tacopie::logger'],['../classtacopie_1_1logger.html#af863301c0ef7f646469eb944285cb280',1,'tacopie::logger::logger(log_level level=log_level::info)'],['../classtacopie_1_1logger.html#af22e5c126a0e0dbd4c82dc1c40b2d16f',1,'tacopie::logger::logger(const logger &)=default']]], + ['logger_5fiface',['logger_iface',['../classtacopie_1_1logger__iface.html',1,'tacopie::logger_iface'],['../classtacopie_1_1logger__iface.html#afccf838f815d168e82e4722e2c4d0d90',1,'tacopie::logger_iface::logger_iface(void)=default'],['../classtacopie_1_1logger__iface.html#a34fb7873b2c5e908afd2d4a0d4965ec1',1,'tacopie::logger_iface::logger_iface(const logger_iface &)=default']]] ]; diff --git a/docs/html/search/all_8.js b/docs/html/search/all_8.js index fe8731f..764256b 100644 --- a/docs/html/search/all_8.js +++ b/docs/html/search/all_8.js @@ -1,11 +1,4 @@ var searchData= [ - ['info',['info',['../classtacopie_1_1logger__iface.html#af176525bca036944f75bad6469860929',1,'tacopie::logger_iface::info()'],['../classtacopie_1_1logger.html#a5089c5a6127586d4f2ea3a69a0bf6570',1,'tacopie::logger::info(const std::string &msg, const std::string &file, std::size_t line)'],['../classtacopie_1_1logger.html#ae7dd235972bbf86a017fc39b3af80efeacaf9b6b99962bf5c2264824231d7a40c',1,'tacopie::logger::info()'],['../namespacetacopie.html#acaa581a9e021e4ca6a20270667ce4e21',1,'tacopie::info()']]], - ['init_5fpoll_5ffds_5finfo',['init_poll_fds_info',['../classtacopie_1_1io__service.html#a7311358423dddd6a9d17c61b2c365ff8',1,'tacopie::io_service']]], - ['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']]], - ['io_5fservice_2ehpp',['io_service.hpp',['../io__service_8hpp.html',1,'']]], - ['is_5fconnected',['is_connected',['../classtacopie_1_1tcp__client.html#a9bf568812c8350260843842e7952c8c3',1,'tacopie::tcp_client']]], - ['is_5fexecuting_5frd_5fcallback',['is_executing_rd_callback',['../structtacopie_1_1io__service_1_1tracked__socket.html#ab7f5e0dc3e34376807ba696750bbf4f0',1,'tacopie::io_service::tracked_socket']]], - ['is_5fexecuting_5fwr_5fcallback',['is_executing_wr_callback',['../structtacopie_1_1io__service_1_1tracked__socket.html#a017198d90760674aaa9591e7a9eb48c8',1,'tacopie::io_service::tracked_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()']]] + ['notify',['notify',['../classtacopie_1_1self__pipe.html#ade9e0e3d19b8d4d22977935a578d508e',1,'tacopie::self_pipe']]] ]; diff --git a/docs/html/search/all_9.js b/docs/html/search/all_9.js index 84abe6c..f49a368 100644 --- a/docs/html/search/all_9.js +++ b/docs/html/search/all_9.js @@ -1,8 +1,8 @@ var searchData= [ - ['listen',['listen',['../classtacopie_1_1tcp__socket.html#af0957ded2a84fb06d940cba98df477fb',1,'tacopie::tcp_socket']]], - ['log_5flevel',['log_level',['../classtacopie_1_1logger.html#ae7dd235972bbf86a017fc39b3af80efe',1,'tacopie::logger']]], - ['logger',['logger',['../classtacopie_1_1logger.html',1,'tacopie::logger'],['../classtacopie_1_1logger.html#af863301c0ef7f646469eb944285cb280',1,'tacopie::logger::logger(log_level level=log_level::info)'],['../classtacopie_1_1logger.html#af22e5c126a0e0dbd4c82dc1c40b2d16f',1,'tacopie::logger::logger(const logger &)=default']]], - ['logger_2ehpp',['logger.hpp',['../logger_8hpp.html',1,'']]], - ['logger_5fiface',['logger_iface',['../classtacopie_1_1logger__iface.html',1,'tacopie::logger_iface'],['../classtacopie_1_1logger__iface.html#afccf838f815d168e82e4722e2c4d0d90',1,'tacopie::logger_iface::logger_iface(void)=default'],['../classtacopie_1_1logger__iface.html#a34fb7873b2c5e908afd2d4a0d4965ec1',1,'tacopie::logger_iface::logger_iface(const logger_iface &)=default']]] + ['on_5fnew_5fconnection_5fcallback_5ft',['on_new_connection_callback_t',['../classtacopie_1_1tcp__server.html#a103cb4e6fcab00f88a708aabd38b66ff',1,'tacopie::tcp_server']]], + ['operator_21_3d',['operator!=',['../classtacopie_1_1tcp__client.html#af352b6b1e939c919aec2761517051eb9',1,'tacopie::tcp_client::operator!=()'],['../classtacopie_1_1tcp__server.html#aa45611b77d60b536aeaf626d1724342d',1,'tacopie::tcp_server::operator!=()'],['../classtacopie_1_1tcp__socket.html#a76f69612969374b5aa542378d37ee398',1,'tacopie::tcp_socket::operator!=()']]], + ['operator_3c_3c',['operator<<',['../classtacopie_1_1utils_1_1thread__pool.html#afb7befd9fa5f1fbd44423fddc8cbc5d3',1,'tacopie::utils::thread_pool']]], + ['operator_3d',['operator=',['../classtacopie_1_1io__service.html#a980652008516b38357d405c16eda07fa',1,'tacopie::io_service::operator=()'],['../classtacopie_1_1self__pipe.html#a14e0fa3a880b6c9559c087eac480c518',1,'tacopie::self_pipe::operator=()'],['../classtacopie_1_1tcp__client.html#aeadcfb8cd727b2917ebcd357311d0a6b',1,'tacopie::tcp_client::operator=()'],['../classtacopie_1_1tcp__server.html#a7e7da4352e2e016f8d40d19bf9fee54b',1,'tacopie::tcp_server::operator=()'],['../classtacopie_1_1tcp__socket.html#aae3234c92bd36d5a614e44472d42bbf4',1,'tacopie::tcp_socket::operator=()'],['../classtacopie_1_1tacopie__error.html#ad30ae4932d33b460f75570f5f3a6e3f3',1,'tacopie::tacopie_error::operator=()'],['../classtacopie_1_1logger__iface.html#ac3ca89b7c5d227b8ed3a5adaa5b72527',1,'tacopie::logger_iface::operator=()'],['../classtacopie_1_1logger.html#a4ee4e53fa0857ee404ddfd5b40759162',1,'tacopie::logger::operator=()'],['../classtacopie_1_1utils_1_1thread__pool.html#aa0077461da4da6ba3f4dcac029351234',1,'tacopie::utils::thread_pool::operator=()']]], + ['operator_3d_3d',['operator==',['../classtacopie_1_1tcp__client.html#af7a1796c04efd00542349ecab692e073',1,'tacopie::tcp_client::operator==()'],['../classtacopie_1_1tcp__server.html#ab9b95a27afb405668bb4d5b1a312ceae',1,'tacopie::tcp_server::operator==()'],['../classtacopie_1_1tcp__socket.html#a69fde61058ab72d88ce48f557d8216cf',1,'tacopie::tcp_socket::operator==()']]] ]; diff --git a/docs/html/search/all_a.js b/docs/html/search/all_a.js index 367f7d8..170d765 100644 --- a/docs/html/search/all_a.js +++ b/docs/html/search/all_a.js @@ -1,40 +1,6 @@ var searchData= [ - ['m_5fcallback_5fworkers',['m_callback_workers',['../classtacopie_1_1io__service.html#ace8ecb6c752a0adb3b2fec1c92cf1161',1,'tacopie::io_service']]], - ['m_5fclients',['m_clients',['../classtacopie_1_1tcp__server.html#ab3e475c59504150c4f3dc68bdb932670',1,'tacopie::tcp_server']]], - ['m_5fclients_5fmtx',['m_clients_mtx',['../classtacopie_1_1tcp__server.html#ad4ee31fe6e01a38bb2a3b11a0f29ab9a',1,'tacopie::tcp_server']]], - ['m_5fdisconnection_5fhandler',['m_disconnection_handler',['../classtacopie_1_1tcp__client.html#a5ee7259fe6a8258515162e1ed516de20',1,'tacopie::tcp_client']]], - ['m_5ffd',['m_fd',['../classtacopie_1_1tcp__socket.html#a4787aed286af0211f97fd4d1518f7b66',1,'tacopie::tcp_socket']]], - ['m_5ffds',['m_fds',['../classtacopie_1_1self__pipe.html#a3e562cfb5ffdd3a8bc6a7c28eca2b7af',1,'tacopie::self_pipe']]], - ['m_5ffile',['m_file',['../classtacopie_1_1tacopie__error.html#a34c06192d25e3c78b1aed8b0c2ead413',1,'tacopie::tacopie_error']]], - ['m_5fhost',['m_host',['../classtacopie_1_1tcp__socket.html#a739f43e1f58c67ae7551cfebbcc7394a',1,'tacopie::tcp_socket']]], - ['m_5fio_5fservice',['m_io_service',['../classtacopie_1_1tcp__client.html#a2a5e4ae0f4fbcd375df4cb1f8070b993',1,'tacopie::tcp_client::m_io_service()'],['../classtacopie_1_1tcp__server.html#a91d9aa88e0de045dc0bb54cddf02e786',1,'tacopie::tcp_server::m_io_service()']]], - ['m_5fis_5fconnected',['m_is_connected',['../classtacopie_1_1tcp__client.html#adf45ef6f910a7723fcfe543417f1feaf',1,'tacopie::tcp_client']]], - ['m_5fis_5frunning',['m_is_running',['../classtacopie_1_1tcp__server.html#a7b7651a482cbc5bb19145b77fe322ced',1,'tacopie::tcp_server']]], - ['m_5flevel',['m_level',['../classtacopie_1_1logger.html#ae694159c13994aa03bc578feca597c04',1,'tacopie::logger']]], - ['m_5fline',['m_line',['../classtacopie_1_1tacopie__error.html#a1631d3a1ba6d610e6c6ab0ddaf70b354',1,'tacopie::tacopie_error']]], - ['m_5fmutex',['m_mutex',['../classtacopie_1_1logger.html#ab04fda465e61bc7a84aa456bf2e399b0',1,'tacopie::logger']]], - ['m_5fnb_5fthreads',['m_nb_threads',['../classtacopie_1_1utils_1_1thread__pool.html#acb37b2e75b5b0ded2b3bc3174c7ba43f',1,'tacopie::utils::thread_pool']]], - ['m_5fnotifier',['m_notifier',['../classtacopie_1_1io__service.html#ae8a17523ba4719b0e799d1c5d665e69f',1,'tacopie::io_service']]], - ['m_5fon_5fnew_5fconnection_5fcallback',['m_on_new_connection_callback',['../classtacopie_1_1tcp__server.html#a779d20d286c32e5daff0012548afdfd0',1,'tacopie::tcp_server']]], - ['m_5fpoll_5fworker',['m_poll_worker',['../classtacopie_1_1io__service.html#a882b2211bae06c87cdf6e9c04d2cb783',1,'tacopie::io_service']]], - ['m_5fpolled_5ffds',['m_polled_fds',['../classtacopie_1_1io__service.html#a5a505f908c39c88e19f092c603f29261',1,'tacopie::io_service']]], - ['m_5fport',['m_port',['../classtacopie_1_1tcp__socket.html#ade0f7688a535423f1057b680bc131d1b',1,'tacopie::tcp_socket']]], - ['m_5frd_5fset',['m_rd_set',['../classtacopie_1_1io__service.html#a1d4388ceffa22976892ac5de95936f58',1,'tacopie::io_service']]], - ['m_5fread_5frequests',['m_read_requests',['../classtacopie_1_1tcp__client.html#a458754e266c0f41b42e17806cc59dc2a',1,'tacopie::tcp_client']]], - ['m_5fread_5frequests_5fmtx',['m_read_requests_mtx',['../classtacopie_1_1tcp__client.html#a792be0da277e372460fbe6977f03d27b',1,'tacopie::tcp_client']]], - ['m_5fshould_5fstop',['m_should_stop',['../classtacopie_1_1io__service.html#a8d73334fcd84e31ccaada49f326d3463',1,'tacopie::io_service::m_should_stop()'],['../classtacopie_1_1utils_1_1thread__pool.html#a1463eb81724978e4c694b8409528b00a',1,'tacopie::utils::thread_pool::m_should_stop()']]], - ['m_5fsocket',['m_socket',['../classtacopie_1_1tcp__client.html#ad256815911a745fce8f2aed00fb45b21',1,'tacopie::tcp_client::m_socket()'],['../classtacopie_1_1tcp__server.html#a2838c1b655a8c4f5ccb1e157afc17284',1,'tacopie::tcp_server::m_socket()']]], - ['m_5ftasks',['m_tasks',['../classtacopie_1_1utils_1_1thread__pool.html#ad00580e9ab77e128cffaf35d80223291',1,'tacopie::utils::thread_pool']]], - ['m_5ftasks_5fcondvar',['m_tasks_condvar',['../classtacopie_1_1utils_1_1thread__pool.html#a6f5122cc6ef6429fdb778a6e6c37216b',1,'tacopie::utils::thread_pool']]], - ['m_5ftasks_5fmtx',['m_tasks_mtx',['../classtacopie_1_1utils_1_1thread__pool.html#aeae956282edc4d2171ee2e408cb1189f',1,'tacopie::utils::thread_pool']]], - ['m_5ftracked_5fsockets',['m_tracked_sockets',['../classtacopie_1_1io__service.html#a49c9b0b992a1fe203975029f8557ad1a',1,'tacopie::io_service']]], - ['m_5ftracked_5fsockets_5fmtx',['m_tracked_sockets_mtx',['../classtacopie_1_1io__service.html#af73671e872d70c6e7d1c856185b5ddd6',1,'tacopie::io_service']]], - ['m_5ftype',['m_type',['../classtacopie_1_1tcp__socket.html#a26ee0857e7e640fa4296af1782bfef7f',1,'tacopie::tcp_socket']]], - ['m_5fwait_5ffor_5fremoval_5fcondvar',['m_wait_for_removal_condvar',['../classtacopie_1_1io__service.html#ab48cce92a369604bf3409ebbbd6d345d',1,'tacopie::io_service']]], - ['m_5fworkers',['m_workers',['../classtacopie_1_1utils_1_1thread__pool.html#a5250ed4fbe845c69e3e28cb7edf4d796',1,'tacopie::utils::thread_pool']]], - ['m_5fwr_5fset',['m_wr_set',['../classtacopie_1_1io__service.html#afca4de707285a1a373751e7e10b413ff',1,'tacopie::io_service']]], - ['m_5fwrite_5frequests',['m_write_requests',['../classtacopie_1_1tcp__client.html#aabf49a27ada2707f252b295dcec13969',1,'tacopie::tcp_client']]], - ['m_5fwrite_5frequests_5fmtx',['m_write_requests_mtx',['../classtacopie_1_1tcp__client.html#abc7c664a73d528c0b1c226d35f7bae2f',1,'tacopie::tcp_client']]], - ['marked_5ffor_5funtrack',['marked_for_untrack',['../structtacopie_1_1io__service_1_1tracked__socket.html#ac72d2fbf2c0e314c7ea02afd2c081dcd',1,'tacopie::io_service::tracked_socket']]] + ['read_5frequest',['read_request',['../structtacopie_1_1tcp__client_1_1read__request.html',1,'tacopie::tcp_client']]], + ['read_5fresult',['read_result',['../structtacopie_1_1tcp__client_1_1read__result.html',1,'tacopie::tcp_client']]], + ['recv',['recv',['../classtacopie_1_1tcp__socket.html#a0d6d30258a902d12b3c2c62644756685',1,'tacopie::tcp_socket']]] ]; diff --git a/docs/html/search/all_b.js b/docs/html/search/all_b.js index 764256b..b7d5835 100644 --- a/docs/html/search/all_b.js +++ b/docs/html/search/all_b.js @@ -1,4 +1,11 @@ var searchData= [ - ['notify',['notify',['../classtacopie_1_1self__pipe.html#ade9e0e3d19b8d4d22977935a578d508e',1,'tacopie::self_pipe']]] + ['self_5fpipe',['self_pipe',['../classtacopie_1_1self__pipe.html',1,'tacopie::self_pipe'],['../classtacopie_1_1self__pipe.html#add8d2c43863d1505e6851789ab5d9b97',1,'tacopie::self_pipe::self_pipe(void)'],['../classtacopie_1_1self__pipe.html#a09ffc77b89ad48bc8db6635108c68b6b',1,'tacopie::self_pipe::self_pipe(const self_pipe &)=delete']]], + ['send',['send',['../classtacopie_1_1tcp__socket.html#a36521a8f502adc665ad0fb1c53583d04',1,'tacopie::tcp_socket']]], + ['set_5fnb_5fthreads',['set_nb_threads',['../classtacopie_1_1utils_1_1thread__pool.html#a7c7ae922cedff8fa323828ebb6dea829',1,'tacopie::utils::thread_pool']]], + ['set_5fnb_5fworkers',['set_nb_workers',['../classtacopie_1_1io__service.html#a7e2b0700c0a4591f86c344df8748b3a5',1,'tacopie::io_service']]], + ['set_5fon_5fdisconnection_5fhandler',['set_on_disconnection_handler',['../classtacopie_1_1tcp__client.html#a8c290d681186edb0578051c04f3c0762',1,'tacopie::tcp_client']]], + ['set_5ftype',['set_type',['../classtacopie_1_1tcp__socket.html#a89be86ab254eec3fc16eedfba8b16fb2',1,'tacopie::tcp_socket']]], + ['start',['start',['../classtacopie_1_1tcp__server.html#a6cb98b50d865b32dba497273a0eca1e9',1,'tacopie::tcp_server']]], + ['stop',['stop',['../classtacopie_1_1tcp__server.html#abc099e162432e2218faed93fc84180fd',1,'tacopie::tcp_server::stop()'],['../classtacopie_1_1utils_1_1thread__pool.html#a8874d7040d12fbe446519bc9f2bcff37',1,'tacopie::utils::thread_pool::stop()']]] ]; diff --git a/docs/html/search/all_c.js b/docs/html/search/all_c.js index 338c972..7f9524f 100644 --- a/docs/html/search/all_c.js +++ b/docs/html/search/all_c.js @@ -1,11 +1,11 @@ var searchData= [ - ['on_5fclient_5fdisconnected',['on_client_disconnected',['../classtacopie_1_1tcp__server.html#ad98bdefae28be6b16a213bf5bedbf7d9',1,'tacopie::tcp_server']]], - ['on_5fnew_5fconnection_5fcallback_5ft',['on_new_connection_callback_t',['../classtacopie_1_1tcp__server.html#a103cb4e6fcab00f88a708aabd38b66ff',1,'tacopie::tcp_server']]], - ['on_5fread_5favailable',['on_read_available',['../classtacopie_1_1tcp__client.html#acb08202e4ea7d85df4a6959dfe418eba',1,'tacopie::tcp_client::on_read_available()'],['../classtacopie_1_1tcp__server.html#a62b4b67ab9554b27881be8dbe869cc6e',1,'tacopie::tcp_server::on_read_available()']]], - ['on_5fwrite_5favailable',['on_write_available',['../classtacopie_1_1tcp__client.html#aee290ddef8906d49edf3bdc9e3555d0a',1,'tacopie::tcp_client']]], - ['operator_21_3d',['operator!=',['../classtacopie_1_1tcp__client.html#af352b6b1e939c919aec2761517051eb9',1,'tacopie::tcp_client::operator!=()'],['../classtacopie_1_1tcp__server.html#aa45611b77d60b536aeaf626d1724342d',1,'tacopie::tcp_server::operator!=()'],['../classtacopie_1_1tcp__socket.html#a76f69612969374b5aa542378d37ee398',1,'tacopie::tcp_socket::operator!=()']]], - ['operator_3c_3c',['operator<<',['../classtacopie_1_1utils_1_1thread__pool.html#afb7befd9fa5f1fbd44423fddc8cbc5d3',1,'tacopie::utils::thread_pool']]], - ['operator_3d',['operator=',['../classtacopie_1_1io__service.html#a980652008516b38357d405c16eda07fa',1,'tacopie::io_service::operator=()'],['../classtacopie_1_1self__pipe.html#a14e0fa3a880b6c9559c087eac480c518',1,'tacopie::self_pipe::operator=()'],['../classtacopie_1_1tcp__client.html#aeadcfb8cd727b2917ebcd357311d0a6b',1,'tacopie::tcp_client::operator=()'],['../classtacopie_1_1tcp__server.html#a7e7da4352e2e016f8d40d19bf9fee54b',1,'tacopie::tcp_server::operator=()'],['../classtacopie_1_1tcp__socket.html#aae3234c92bd36d5a614e44472d42bbf4',1,'tacopie::tcp_socket::operator=()'],['../classtacopie_1_1tacopie__error.html#ad30ae4932d33b460f75570f5f3a6e3f3',1,'tacopie::tacopie_error::operator=()'],['../classtacopie_1_1logger__iface.html#ac3ca89b7c5d227b8ed3a5adaa5b72527',1,'tacopie::logger_iface::operator=()'],['../classtacopie_1_1logger.html#a4ee4e53fa0857ee404ddfd5b40759162',1,'tacopie::logger::operator=()'],['../classtacopie_1_1utils_1_1thread__pool.html#aa0077461da4da6ba3f4dcac029351234',1,'tacopie::utils::thread_pool::operator=()']]], - ['operator_3d_3d',['operator==',['../classtacopie_1_1tcp__client.html#af7a1796c04efd00542349ecab692e073',1,'tacopie::tcp_client::operator==()'],['../classtacopie_1_1tcp__server.html#ab9b95a27afb405668bb4d5b1a312ceae',1,'tacopie::tcp_server::operator==()'],['../classtacopie_1_1tcp__socket.html#a69fde61058ab72d88ce48f557d8216cf',1,'tacopie::tcp_socket::operator==()']]] + ['tacopie_5ferror',['tacopie_error',['../classtacopie_1_1tacopie__error.html',1,'tacopie::tacopie_error'],['../classtacopie_1_1tacopie__error.html#a524fb8e9ac1825a57664421a3f32b9ce',1,'tacopie::tacopie_error::tacopie_error(const std::string &what, const std::string &file, std::size_t line)'],['../classtacopie_1_1tacopie__error.html#a0cb2a911165e08818ca03308891633e1',1,'tacopie::tacopie_error::tacopie_error(const tacopie_error &)=default']]], + ['task_5ft',['task_t',['../classtacopie_1_1utils_1_1thread__pool.html#a8ae8886fdeaa8e5c0abad12626a47296',1,'tacopie::utils::thread_pool']]], + ['tcp_5fclient',['tcp_client',['../classtacopie_1_1tcp__client.html',1,'tacopie::tcp_client'],['../classtacopie_1_1tcp__client.html#a0125e1cf017b0ba0370d682d4382d37b',1,'tacopie::tcp_client::tcp_client(std::uint32_t num_io_workers=1)'],['../classtacopie_1_1tcp__client.html#a773fbcbb5b79324c8d065e363de73282',1,'tacopie::tcp_client::tcp_client(tcp_socket &&socket)'],['../classtacopie_1_1tcp__client.html#a5e326782c52f63814cc8f42a901ffaf6',1,'tacopie::tcp_client::tcp_client(const tcp_client &)=delete']]], + ['tcp_5fserver',['tcp_server',['../classtacopie_1_1tcp__server.html',1,'tacopie::tcp_server'],['../classtacopie_1_1tcp__server.html#a4f67a38a0764924768cbcc7cf68527bf',1,'tacopie::tcp_server::tcp_server(void)'],['../classtacopie_1_1tcp__server.html#a2d9c6a2dea95a3c6a919c655d6e8e0ba',1,'tacopie::tcp_server::tcp_server(const tcp_server &)=delete']]], + ['tcp_5fsocket',['tcp_socket',['../classtacopie_1_1tcp__socket.html',1,'tacopie::tcp_socket'],['../classtacopie_1_1tcp__socket.html#a88ed1cadb0263591c4d31805e0a1a001',1,'tacopie::tcp_socket::tcp_socket(void)'],['../classtacopie_1_1tcp__socket.html#a191ffa48e0753ad4ec87d4d3a4a97822',1,'tacopie::tcp_socket::tcp_socket(fd_t fd, const std::string &host, std::uint32_t port, type t)'],['../classtacopie_1_1tcp__socket.html#a64f69cd1c185b523b543d4ea53cee1a2',1,'tacopie::tcp_socket::tcp_socket(tcp_socket &&)'],['../classtacopie_1_1tcp__socket.html#a5ae1a5b0f9713ef256164afdbeb1c193',1,'tacopie::tcp_socket::tcp_socket(const tcp_socket &)=delete']]], + ['thread_5fpool',['thread_pool',['../classtacopie_1_1utils_1_1thread__pool.html',1,'tacopie::utils::thread_pool'],['../classtacopie_1_1utils_1_1thread__pool.html#aa0068f000b8ecb21b2b0a0c50f77877c',1,'tacopie::utils::thread_pool::thread_pool(std::size_t nb_threads)'],['../classtacopie_1_1utils_1_1thread__pool.html#a63a850c39d21058eda9d655bb7eff452',1,'tacopie::utils::thread_pool::thread_pool(const thread_pool &)=delete']]], + ['track',['track',['../classtacopie_1_1io__service.html#a9f4c8bce3c0f6d660515b0b5eb109df8',1,'tacopie::io_service']]], + ['type',['type',['../classtacopie_1_1tcp__socket.html#ad8376e85df96ab9523f5d079ed7172ab',1,'tacopie::tcp_socket']]] ]; diff --git a/docs/html/search/all_d.js b/docs/html/search/all_d.js index bd492b7..a5b05d2 100644 --- a/docs/html/search/all_d.js +++ b/docs/html/search/all_d.js @@ -1,9 +1,7 @@ var searchData= [ - ['poll',['poll',['../classtacopie_1_1io__service.html#a03813e0e91d70d367f9fb0ff0d86d3dd',1,'tacopie::io_service']]], - ['process_5fevents',['process_events',['../classtacopie_1_1io__service.html#a90a2ab7b6bbaf10bbc0607ce371cc806',1,'tacopie::io_service']]], - ['process_5frd_5fevent',['process_rd_event',['../classtacopie_1_1io__service.html#a65c3ef9fa1473708b81b05029f6861f9',1,'tacopie::io_service']]], - ['process_5fread',['process_read',['../classtacopie_1_1tcp__client.html#a40308b6a1642a79a35a2b2d9c9b9a3f7',1,'tacopie::tcp_client']]], - ['process_5fwr_5fevent',['process_wr_event',['../classtacopie_1_1io__service.html#a55e334cdf75187b9296c03447e32a63f',1,'tacopie::io_service']]], - ['process_5fwrite',['process_write',['../classtacopie_1_1tcp__client.html#afd5e43d5f44930894de10ce05268607f',1,'tacopie::tcp_client']]] + ['wait_5ffor_5fremoval',['wait_for_removal',['../classtacopie_1_1io__service.html#aa57db619baeaa6db0aeb22e67b895cd7',1,'tacopie::io_service']]], + ['warn',['warn',['../classtacopie_1_1logger__iface.html#ab96d8f6bc2e2b514c7ceec4c856f8921',1,'tacopie::logger_iface::warn()'],['../classtacopie_1_1logger.html#aa4cd2ffc3f4b9d096a35c5c2aa8e0970',1,'tacopie::logger::warn()']]], + ['write_5frequest',['write_request',['../structtacopie_1_1tcp__client_1_1write__request.html',1,'tacopie::tcp_client']]], + ['write_5fresult',['write_result',['../structtacopie_1_1tcp__client_1_1write__result.html',1,'tacopie::tcp_client']]] ]; diff --git a/docs/html/search/all_e.js b/docs/html/search/all_e.js index 957286e..dd9469a 100644 --- a/docs/html/search/all_e.js +++ b/docs/html/search/all_e.js @@ -1,8 +1,11 @@ var searchData= [ - ['rd_5fcallback',['rd_callback',['../structtacopie_1_1io__service_1_1tracked__socket.html#a4e44d4d8132f5272de80e83156d44fc6',1,'tacopie::io_service::tracked_socket']]], - ['read_5frequest',['read_request',['../structtacopie_1_1tcp__client_1_1read__request.html',1,'tacopie::tcp_client']]], - ['read_5fresult',['read_result',['../structtacopie_1_1tcp__client_1_1read__result.html',1,'tacopie::tcp_client']]], - ['recv',['recv',['../classtacopie_1_1tcp__socket.html#a0d6d30258a902d12b3c2c62644756685',1,'tacopie::tcp_socket']]], - ['run',['run',['../classtacopie_1_1utils_1_1thread__pool.html#a6e4ae0994faf97d0d260c1f846ff4639',1,'tacopie::utils::thread_pool']]] + ['_7eio_5fservice',['~io_service',['../classtacopie_1_1io__service.html#ae423d7e4b13f07fe41fb051345ffbf8d',1,'tacopie::io_service']]], + ['_7elogger',['~logger',['../classtacopie_1_1logger.html#af5c89b85935dbe3b4da3199247d50398',1,'tacopie::logger']]], + ['_7elogger_5fiface',['~logger_iface',['../classtacopie_1_1logger__iface.html#a562dcc605198ca90904ba21fa98eb6ea',1,'tacopie::logger_iface']]], + ['_7eself_5fpipe',['~self_pipe',['../classtacopie_1_1self__pipe.html#a10a6c4b0d67a4a14abea397a05cee54c',1,'tacopie::self_pipe']]], + ['_7etacopie_5ferror',['~tacopie_error',['../classtacopie_1_1tacopie__error.html#a5bf6b0967f7f4cf2b8f8d0a2ef0912b2',1,'tacopie::tacopie_error']]], + ['_7etcp_5fserver',['~tcp_server',['../classtacopie_1_1tcp__server.html#a7841dc528e2d3dfc94fbe9b93824da50',1,'tacopie::tcp_server']]], + ['_7etcp_5fsocket',['~tcp_socket',['../classtacopie_1_1tcp__socket.html#a4bd737a76a2a326be03d704f79a35282',1,'tacopie::tcp_socket']]], + ['_7ethread_5fpool',['~thread_pool',['../classtacopie_1_1utils_1_1thread__pool.html#accddfc6fad613b0c6d407028799abfc5',1,'tacopie::utils::thread_pool']]] ]; diff --git a/docs/html/search/classes_4.js b/docs/html/search/classes_4.js index e1ce530..21e3be4 100644 --- a/docs/html/search/classes_4.js +++ b/docs/html/search/classes_4.js @@ -4,6 +4,5 @@ var searchData= ['tcp_5fclient',['tcp_client',['../classtacopie_1_1tcp__client.html',1,'tacopie']]], ['tcp_5fserver',['tcp_server',['../classtacopie_1_1tcp__server.html',1,'tacopie']]], ['tcp_5fsocket',['tcp_socket',['../classtacopie_1_1tcp__socket.html',1,'tacopie']]], - ['thread_5fpool',['thread_pool',['../classtacopie_1_1utils_1_1thread__pool.html',1,'tacopie::utils']]], - ['tracked_5fsocket',['tracked_socket',['../structtacopie_1_1io__service_1_1tracked__socket.html',1,'tacopie::io_service']]] + ['thread_5fpool',['thread_pool',['../classtacopie_1_1utils_1_1thread__pool.html',1,'tacopie::utils']]] ]; diff --git a/docs/html/search/functions_2.js b/docs/html/search/functions_2.js index 6dd058a..33c5eab 100644 --- a/docs/html/search/functions_2.js +++ b/docs/html/search/functions_2.js @@ -1,11 +1,6 @@ var searchData= [ - ['call_5fdisconnection_5fhandler',['call_disconnection_handler',['../classtacopie_1_1tcp__client.html#ae38ae1f64909dd36592a02fc3c245672',1,'tacopie::tcp_client']]], - ['check_5for_5fset_5ftype',['check_or_set_type',['../classtacopie_1_1tcp__socket.html#a53067d6b401c7a7d8c8da3be0713480c',1,'tacopie::tcp_socket']]], - ['clear_5fread_5frequests',['clear_read_requests',['../classtacopie_1_1tcp__client.html#afdb370d07800a95448a645f4605d54e1',1,'tacopie::tcp_client']]], - ['clear_5fwrite_5frequests',['clear_write_requests',['../classtacopie_1_1tcp__client.html#acd8c8d54f359ed99be3a2dd50ef0ec77',1,'tacopie::tcp_client']]], ['close',['close',['../classtacopie_1_1tcp__socket.html#ad5a30b17b1dad9f0ff40305e246a9213',1,'tacopie::tcp_socket']]], ['clr_5fbuffer',['clr_buffer',['../classtacopie_1_1self__pipe.html#a4f55a34bd882d59bdcc73b87222ba3d8',1,'tacopie::self_pipe']]], - ['connect',['connect',['../classtacopie_1_1tcp__client.html#a0cfbb18cb72aa3b6a41921f61cacc425',1,'tacopie::tcp_client::connect()'],['../classtacopie_1_1tcp__socket.html#a6748c78312763dca6b8be05c4c8c3419',1,'tacopie::tcp_socket::connect()']]], - ['create_5fsocket_5fif_5fnecessary',['create_socket_if_necessary',['../classtacopie_1_1tcp__socket.html#ac2f77e32211a33e0cf4fd8de33946761',1,'tacopie::tcp_socket']]] + ['connect',['connect',['../classtacopie_1_1tcp__client.html#a0cfbb18cb72aa3b6a41921f61cacc425',1,'tacopie::tcp_client::connect()'],['../classtacopie_1_1tcp__socket.html#a6748c78312763dca6b8be05c4c8c3419',1,'tacopie::tcp_socket::connect()']]] ]; diff --git a/docs/html/search/functions_3.js b/docs/html/search/functions_3.js index 36c26c2..beb06c3 100644 --- a/docs/html/search/functions_3.js +++ b/docs/html/search/functions_3.js @@ -1,5 +1,5 @@ var searchData= [ - ['debug',['debug',['../classtacopie_1_1logger__iface.html#a156abb02ab852ea4033fc13f4902ee7a',1,'tacopie::logger_iface::debug()'],['../classtacopie_1_1logger.html#aff31bbc7d3fdbbe60a2331fe24ec76ff',1,'tacopie::logger::debug()'],['../namespacetacopie.html#a0833874b07ad56b5ba2c7847f1e514b0',1,'tacopie::debug()']]], + ['debug',['debug',['../classtacopie_1_1logger__iface.html#a156abb02ab852ea4033fc13f4902ee7a',1,'tacopie::logger_iface::debug()'],['../classtacopie_1_1logger.html#aff31bbc7d3fdbbe60a2331fe24ec76ff',1,'tacopie::logger::debug()']]], ['disconnect',['disconnect',['../classtacopie_1_1tcp__client.html#a7562e0bfa24912595d6f695f848b9e51',1,'tacopie::tcp_client']]] ]; diff --git a/docs/html/search/functions_4.js b/docs/html/search/functions_4.js index f157032..85da3b9 100644 --- a/docs/html/search/functions_4.js +++ b/docs/html/search/functions_4.js @@ -1,4 +1,4 @@ var searchData= [ - ['error',['error',['../classtacopie_1_1logger__iface.html#a18f9c02fc19be4b9900ac9fb1a361624',1,'tacopie::logger_iface::error()'],['../classtacopie_1_1logger.html#a3fe1be02ac2f4e4fe44a0bdaf8359546',1,'tacopie::logger::error()'],['../namespacetacopie.html#a48f7b277b1559f2333c1186fa629ef01',1,'tacopie::error()']]] + ['error',['error',['../classtacopie_1_1logger__iface.html#a18f9c02fc19be4b9900ac9fb1a361624',1,'tacopie::logger_iface::error()'],['../classtacopie_1_1logger.html#a3fe1be02ac2f4e4fe44a0bdaf8359546',1,'tacopie::logger::error()']]] ]; diff --git a/docs/html/search/functions_5.js b/docs/html/search/functions_5.js index 7569c4a..d84d45a 100644 --- a/docs/html/search/functions_5.js +++ b/docs/html/search/functions_5.js @@ -1,4 +1,14 @@ var searchData= [ - ['fetch_5ftask',['fetch_task',['../classtacopie_1_1utils_1_1thread__pool.html#a182472a7727edc7d37d2309ccbc2dea7',1,'tacopie::utils::thread_pool']]] + ['get_5fclients',['get_clients',['../classtacopie_1_1tcp__server.html#a0df81b943243ad51102c37d4944be8d7',1,'tacopie::tcp_server']]], + ['get_5ffd',['get_fd',['../classtacopie_1_1tcp__socket.html#a4fd367a1802ed6ae7fa0e33fc07ed255',1,'tacopie::tcp_socket']]], + ['get_5ffile',['get_file',['../classtacopie_1_1tacopie__error.html#a10360163c780a1bd9c95fcecca5aa6da',1,'tacopie::tacopie_error']]], + ['get_5fhost',['get_host',['../classtacopie_1_1tcp__client.html#ad38ab710c5eca64de2f887abc455b15d',1,'tacopie::tcp_client::get_host()'],['../classtacopie_1_1tcp__socket.html#ad294565f9a0fa52639ecfbf133eecd59',1,'tacopie::tcp_socket::get_host()']]], + ['get_5fio_5fservice',['get_io_service',['../classtacopie_1_1tcp__client.html#aafbf0aa37cd0472778d09fb163362314',1,'tacopie::tcp_client::get_io_service()'],['../classtacopie_1_1tcp__server.html#aace4796627b6abccccce1a541908414f',1,'tacopie::tcp_server::get_io_service()']]], + ['get_5fline',['get_line',['../classtacopie_1_1tacopie__error.html#a39704d2cb6f076aa47d45f53f174b257',1,'tacopie::tacopie_error']]], + ['get_5fport',['get_port',['../classtacopie_1_1tcp__client.html#a3b42ae2afe6d5ee5f2f16b8bd7846f37',1,'tacopie::tcp_client::get_port()'],['../classtacopie_1_1tcp__socket.html#a5276fdc687ac3c5089a05e3e2d9de4fb',1,'tacopie::tcp_socket::get_port()']]], + ['get_5fread_5ffd',['get_read_fd',['../classtacopie_1_1self__pipe.html#a301b416f5f8236a383065b381385b88c',1,'tacopie::self_pipe']]], + ['get_5fsocket',['get_socket',['../classtacopie_1_1tcp__client.html#a1a3834deb1d263ec5816066f74286298',1,'tacopie::tcp_client::get_socket(void)'],['../classtacopie_1_1tcp__client.html#a9cf1f3ccf43f9a0a883a17b15e3668d6',1,'tacopie::tcp_client::get_socket(void) const'],['../classtacopie_1_1tcp__server.html#a39a51b9203d42babfd9c4c1a0f4cc340',1,'tacopie::tcp_server::get_socket(void)'],['../classtacopie_1_1tcp__server.html#a373aec294e24a52c3ef6c44920af36e2',1,'tacopie::tcp_server::get_socket(void) const']]], + ['get_5ftype',['get_type',['../classtacopie_1_1tcp__socket.html#a4f663be51b845520505bc20a88b411ee',1,'tacopie::tcp_socket']]], + ['get_5fwrite_5ffd',['get_write_fd',['../classtacopie_1_1self__pipe.html#ab36a4deb45bb408988f26315aedc0d74',1,'tacopie::self_pipe']]] ]; diff --git a/docs/html/search/functions_6.js b/docs/html/search/functions_6.js index 89d2025..342e37a 100644 --- a/docs/html/search/functions_6.js +++ b/docs/html/search/functions_6.js @@ -1,15 +1,7 @@ var searchData= [ - ['get_5fclients',['get_clients',['../classtacopie_1_1tcp__server.html#a0df81b943243ad51102c37d4944be8d7',1,'tacopie::tcp_server']]], - ['get_5fdefault_5fio_5fservice',['get_default_io_service',['../namespacetacopie.html#a08584acd5790cf1f3c9af96e5a8494a6',1,'tacopie']]], - ['get_5ffd',['get_fd',['../classtacopie_1_1tcp__socket.html#a4fd367a1802ed6ae7fa0e33fc07ed255',1,'tacopie::tcp_socket']]], - ['get_5ffile',['get_file',['../classtacopie_1_1tacopie__error.html#a10360163c780a1bd9c95fcecca5aa6da',1,'tacopie::tacopie_error']]], - ['get_5fhost',['get_host',['../classtacopie_1_1tcp__client.html#ad38ab710c5eca64de2f887abc455b15d',1,'tacopie::tcp_client::get_host()'],['../classtacopie_1_1tcp__socket.html#ad294565f9a0fa52639ecfbf133eecd59',1,'tacopie::tcp_socket::get_host()']]], - ['get_5fio_5fservice',['get_io_service',['../classtacopie_1_1tcp__client.html#aafbf0aa37cd0472778d09fb163362314',1,'tacopie::tcp_client::get_io_service()'],['../classtacopie_1_1tcp__server.html#aace4796627b6abccccce1a541908414f',1,'tacopie::tcp_server::get_io_service()']]], - ['get_5fline',['get_line',['../classtacopie_1_1tacopie__error.html#a39704d2cb6f076aa47d45f53f174b257',1,'tacopie::tacopie_error']]], - ['get_5fport',['get_port',['../classtacopie_1_1tcp__client.html#a3b42ae2afe6d5ee5f2f16b8bd7846f37',1,'tacopie::tcp_client::get_port()'],['../classtacopie_1_1tcp__socket.html#a5276fdc687ac3c5089a05e3e2d9de4fb',1,'tacopie::tcp_socket::get_port()']]], - ['get_5fread_5ffd',['get_read_fd',['../classtacopie_1_1self__pipe.html#a301b416f5f8236a383065b381385b88c',1,'tacopie::self_pipe']]], - ['get_5fsocket',['get_socket',['../classtacopie_1_1tcp__client.html#a1a3834deb1d263ec5816066f74286298',1,'tacopie::tcp_client::get_socket(void)'],['../classtacopie_1_1tcp__client.html#a9cf1f3ccf43f9a0a883a17b15e3668d6',1,'tacopie::tcp_client::get_socket(void) const'],['../classtacopie_1_1tcp__server.html#a39a51b9203d42babfd9c4c1a0f4cc340',1,'tacopie::tcp_server::get_socket(void)'],['../classtacopie_1_1tcp__server.html#a373aec294e24a52c3ef6c44920af36e2',1,'tacopie::tcp_server::get_socket(void) const']]], - ['get_5ftype',['get_type',['../classtacopie_1_1tcp__socket.html#a4f663be51b845520505bc20a88b411ee',1,'tacopie::tcp_socket']]], - ['get_5fwrite_5ffd',['get_write_fd',['../classtacopie_1_1self__pipe.html#ab36a4deb45bb408988f26315aedc0d74',1,'tacopie::self_pipe']]] + ['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_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_7.js b/docs/html/search/functions_7.js index 18ec26c..ff8703d 100644 --- a/docs/html/search/functions_7.js +++ b/docs/html/search/functions_7.js @@ -1,8 +1,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()'],['../namespacetacopie.html#acaa581a9e021e4ca6a20270667ce4e21',1,'tacopie::info()']]], - ['init_5fpoll_5ffds_5finfo',['init_poll_fds_info',['../classtacopie_1_1io__service.html#a7311358423dddd6a9d17c61b2c365ff8',1,'tacopie::io_service']]], - ['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_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()']]] + ['listen',['listen',['../classtacopie_1_1tcp__socket.html#af0957ded2a84fb06d940cba98df477fb',1,'tacopie::tcp_socket']]], + ['logger',['logger',['../classtacopie_1_1logger.html#af863301c0ef7f646469eb944285cb280',1,'tacopie::logger::logger(log_level level=log_level::info)'],['../classtacopie_1_1logger.html#af22e5c126a0e0dbd4c82dc1c40b2d16f',1,'tacopie::logger::logger(const logger &)=default']]], + ['logger_5fiface',['logger_iface',['../classtacopie_1_1logger__iface.html#afccf838f815d168e82e4722e2c4d0d90',1,'tacopie::logger_iface::logger_iface(void)=default'],['../classtacopie_1_1logger__iface.html#a34fb7873b2c5e908afd2d4a0d4965ec1',1,'tacopie::logger_iface::logger_iface(const logger_iface &)=default']]] ]; diff --git a/docs/html/search/functions_8.js b/docs/html/search/functions_8.js index ff8703d..764256b 100644 --- a/docs/html/search/functions_8.js +++ b/docs/html/search/functions_8.js @@ -1,6 +1,4 @@ var searchData= [ - ['listen',['listen',['../classtacopie_1_1tcp__socket.html#af0957ded2a84fb06d940cba98df477fb',1,'tacopie::tcp_socket']]], - ['logger',['logger',['../classtacopie_1_1logger.html#af863301c0ef7f646469eb944285cb280',1,'tacopie::logger::logger(log_level level=log_level::info)'],['../classtacopie_1_1logger.html#af22e5c126a0e0dbd4c82dc1c40b2d16f',1,'tacopie::logger::logger(const logger &)=default']]], - ['logger_5fiface',['logger_iface',['../classtacopie_1_1logger__iface.html#afccf838f815d168e82e4722e2c4d0d90',1,'tacopie::logger_iface::logger_iface(void)=default'],['../classtacopie_1_1logger__iface.html#a34fb7873b2c5e908afd2d4a0d4965ec1',1,'tacopie::logger_iface::logger_iface(const logger_iface &)=default']]] + ['notify',['notify',['../classtacopie_1_1self__pipe.html#ade9e0e3d19b8d4d22977935a578d508e',1,'tacopie::self_pipe']]] ]; diff --git a/docs/html/search/functions_9.js b/docs/html/search/functions_9.js index 764256b..5e594cd 100644 --- a/docs/html/search/functions_9.js +++ b/docs/html/search/functions_9.js @@ -1,4 +1,7 @@ var searchData= [ - ['notify',['notify',['../classtacopie_1_1self__pipe.html#ade9e0e3d19b8d4d22977935a578d508e',1,'tacopie::self_pipe']]] + ['operator_21_3d',['operator!=',['../classtacopie_1_1tcp__client.html#af352b6b1e939c919aec2761517051eb9',1,'tacopie::tcp_client::operator!=()'],['../classtacopie_1_1tcp__server.html#aa45611b77d60b536aeaf626d1724342d',1,'tacopie::tcp_server::operator!=()'],['../classtacopie_1_1tcp__socket.html#a76f69612969374b5aa542378d37ee398',1,'tacopie::tcp_socket::operator!=()']]], + ['operator_3c_3c',['operator<<',['../classtacopie_1_1utils_1_1thread__pool.html#afb7befd9fa5f1fbd44423fddc8cbc5d3',1,'tacopie::utils::thread_pool']]], + ['operator_3d',['operator=',['../classtacopie_1_1io__service.html#a980652008516b38357d405c16eda07fa',1,'tacopie::io_service::operator=()'],['../classtacopie_1_1self__pipe.html#a14e0fa3a880b6c9559c087eac480c518',1,'tacopie::self_pipe::operator=()'],['../classtacopie_1_1tcp__client.html#aeadcfb8cd727b2917ebcd357311d0a6b',1,'tacopie::tcp_client::operator=()'],['../classtacopie_1_1tcp__server.html#a7e7da4352e2e016f8d40d19bf9fee54b',1,'tacopie::tcp_server::operator=()'],['../classtacopie_1_1tcp__socket.html#aae3234c92bd36d5a614e44472d42bbf4',1,'tacopie::tcp_socket::operator=()'],['../classtacopie_1_1tacopie__error.html#ad30ae4932d33b460f75570f5f3a6e3f3',1,'tacopie::tacopie_error::operator=()'],['../classtacopie_1_1logger__iface.html#ac3ca89b7c5d227b8ed3a5adaa5b72527',1,'tacopie::logger_iface::operator=()'],['../classtacopie_1_1logger.html#a4ee4e53fa0857ee404ddfd5b40759162',1,'tacopie::logger::operator=()'],['../classtacopie_1_1utils_1_1thread__pool.html#aa0077461da4da6ba3f4dcac029351234',1,'tacopie::utils::thread_pool::operator=()']]], + ['operator_3d_3d',['operator==',['../classtacopie_1_1tcp__client.html#af7a1796c04efd00542349ecab692e073',1,'tacopie::tcp_client::operator==()'],['../classtacopie_1_1tcp__server.html#ab9b95a27afb405668bb4d5b1a312ceae',1,'tacopie::tcp_server::operator==()'],['../classtacopie_1_1tcp__socket.html#a69fde61058ab72d88ce48f557d8216cf',1,'tacopie::tcp_socket::operator==()']]] ]; diff --git a/docs/html/search/functions_a.js b/docs/html/search/functions_a.js index c5170ea..c3c1f07 100644 --- a/docs/html/search/functions_a.js +++ b/docs/html/search/functions_a.js @@ -1,10 +1,4 @@ var searchData= [ - ['on_5fclient_5fdisconnected',['on_client_disconnected',['../classtacopie_1_1tcp__server.html#ad98bdefae28be6b16a213bf5bedbf7d9',1,'tacopie::tcp_server']]], - ['on_5fread_5favailable',['on_read_available',['../classtacopie_1_1tcp__client.html#acb08202e4ea7d85df4a6959dfe418eba',1,'tacopie::tcp_client::on_read_available()'],['../classtacopie_1_1tcp__server.html#a62b4b67ab9554b27881be8dbe869cc6e',1,'tacopie::tcp_server::on_read_available()']]], - ['on_5fwrite_5favailable',['on_write_available',['../classtacopie_1_1tcp__client.html#aee290ddef8906d49edf3bdc9e3555d0a',1,'tacopie::tcp_client']]], - ['operator_21_3d',['operator!=',['../classtacopie_1_1tcp__client.html#af352b6b1e939c919aec2761517051eb9',1,'tacopie::tcp_client::operator!=()'],['../classtacopie_1_1tcp__server.html#aa45611b77d60b536aeaf626d1724342d',1,'tacopie::tcp_server::operator!=()'],['../classtacopie_1_1tcp__socket.html#a76f69612969374b5aa542378d37ee398',1,'tacopie::tcp_socket::operator!=()']]], - ['operator_3c_3c',['operator<<',['../classtacopie_1_1utils_1_1thread__pool.html#afb7befd9fa5f1fbd44423fddc8cbc5d3',1,'tacopie::utils::thread_pool']]], - ['operator_3d',['operator=',['../classtacopie_1_1io__service.html#a980652008516b38357d405c16eda07fa',1,'tacopie::io_service::operator=()'],['../classtacopie_1_1self__pipe.html#a14e0fa3a880b6c9559c087eac480c518',1,'tacopie::self_pipe::operator=()'],['../classtacopie_1_1tcp__client.html#aeadcfb8cd727b2917ebcd357311d0a6b',1,'tacopie::tcp_client::operator=()'],['../classtacopie_1_1tcp__server.html#a7e7da4352e2e016f8d40d19bf9fee54b',1,'tacopie::tcp_server::operator=()'],['../classtacopie_1_1tcp__socket.html#aae3234c92bd36d5a614e44472d42bbf4',1,'tacopie::tcp_socket::operator=()'],['../classtacopie_1_1tacopie__error.html#ad30ae4932d33b460f75570f5f3a6e3f3',1,'tacopie::tacopie_error::operator=()'],['../classtacopie_1_1logger__iface.html#ac3ca89b7c5d227b8ed3a5adaa5b72527',1,'tacopie::logger_iface::operator=()'],['../classtacopie_1_1logger.html#a4ee4e53fa0857ee404ddfd5b40759162',1,'tacopie::logger::operator=()'],['../classtacopie_1_1utils_1_1thread__pool.html#aa0077461da4da6ba3f4dcac029351234',1,'tacopie::utils::thread_pool::operator=()']]], - ['operator_3d_3d',['operator==',['../classtacopie_1_1tcp__client.html#af7a1796c04efd00542349ecab692e073',1,'tacopie::tcp_client::operator==()'],['../classtacopie_1_1tcp__server.html#ab9b95a27afb405668bb4d5b1a312ceae',1,'tacopie::tcp_server::operator==()'],['../classtacopie_1_1tcp__socket.html#a69fde61058ab72d88ce48f557d8216cf',1,'tacopie::tcp_socket::operator==()']]] + ['recv',['recv',['../classtacopie_1_1tcp__socket.html#a0d6d30258a902d12b3c2c62644756685',1,'tacopie::tcp_socket']]] ]; diff --git a/docs/html/search/functions_b.js b/docs/html/search/functions_b.js index bd492b7..f70d34e 100644 --- a/docs/html/search/functions_b.js +++ b/docs/html/search/functions_b.js @@ -1,9 +1,11 @@ var searchData= [ - ['poll',['poll',['../classtacopie_1_1io__service.html#a03813e0e91d70d367f9fb0ff0d86d3dd',1,'tacopie::io_service']]], - ['process_5fevents',['process_events',['../classtacopie_1_1io__service.html#a90a2ab7b6bbaf10bbc0607ce371cc806',1,'tacopie::io_service']]], - ['process_5frd_5fevent',['process_rd_event',['../classtacopie_1_1io__service.html#a65c3ef9fa1473708b81b05029f6861f9',1,'tacopie::io_service']]], - ['process_5fread',['process_read',['../classtacopie_1_1tcp__client.html#a40308b6a1642a79a35a2b2d9c9b9a3f7',1,'tacopie::tcp_client']]], - ['process_5fwr_5fevent',['process_wr_event',['../classtacopie_1_1io__service.html#a55e334cdf75187b9296c03447e32a63f',1,'tacopie::io_service']]], - ['process_5fwrite',['process_write',['../classtacopie_1_1tcp__client.html#afd5e43d5f44930894de10ce05268607f',1,'tacopie::tcp_client']]] + ['self_5fpipe',['self_pipe',['../classtacopie_1_1self__pipe.html#add8d2c43863d1505e6851789ab5d9b97',1,'tacopie::self_pipe::self_pipe(void)'],['../classtacopie_1_1self__pipe.html#a09ffc77b89ad48bc8db6635108c68b6b',1,'tacopie::self_pipe::self_pipe(const self_pipe &)=delete']]], + ['send',['send',['../classtacopie_1_1tcp__socket.html#a36521a8f502adc665ad0fb1c53583d04',1,'tacopie::tcp_socket']]], + ['set_5fnb_5fthreads',['set_nb_threads',['../classtacopie_1_1utils_1_1thread__pool.html#a7c7ae922cedff8fa323828ebb6dea829',1,'tacopie::utils::thread_pool']]], + ['set_5fnb_5fworkers',['set_nb_workers',['../classtacopie_1_1io__service.html#a7e2b0700c0a4591f86c344df8748b3a5',1,'tacopie::io_service']]], + ['set_5fon_5fdisconnection_5fhandler',['set_on_disconnection_handler',['../classtacopie_1_1tcp__client.html#a8c290d681186edb0578051c04f3c0762',1,'tacopie::tcp_client']]], + ['set_5ftype',['set_type',['../classtacopie_1_1tcp__socket.html#a89be86ab254eec3fc16eedfba8b16fb2',1,'tacopie::tcp_socket']]], + ['start',['start',['../classtacopie_1_1tcp__server.html#a6cb98b50d865b32dba497273a0eca1e9',1,'tacopie::tcp_server']]], + ['stop',['stop',['../classtacopie_1_1tcp__server.html#abc099e162432e2218faed93fc84180fd',1,'tacopie::tcp_server::stop()'],['../classtacopie_1_1utils_1_1thread__pool.html#a8874d7040d12fbe446519bc9f2bcff37',1,'tacopie::utils::thread_pool::stop()']]] ]; diff --git a/docs/html/search/functions_c.js b/docs/html/search/functions_c.js index f10f10d..be92152 100644 --- a/docs/html/search/functions_c.js +++ b/docs/html/search/functions_c.js @@ -1,5 +1,9 @@ var searchData= [ - ['recv',['recv',['../classtacopie_1_1tcp__socket.html#a0d6d30258a902d12b3c2c62644756685',1,'tacopie::tcp_socket']]], - ['run',['run',['../classtacopie_1_1utils_1_1thread__pool.html#a6e4ae0994faf97d0d260c1f846ff4639',1,'tacopie::utils::thread_pool']]] + ['tacopie_5ferror',['tacopie_error',['../classtacopie_1_1tacopie__error.html#a524fb8e9ac1825a57664421a3f32b9ce',1,'tacopie::tacopie_error::tacopie_error(const std::string &what, const std::string &file, std::size_t line)'],['../classtacopie_1_1tacopie__error.html#a0cb2a911165e08818ca03308891633e1',1,'tacopie::tacopie_error::tacopie_error(const tacopie_error &)=default']]], + ['tcp_5fclient',['tcp_client',['../classtacopie_1_1tcp__client.html#a0125e1cf017b0ba0370d682d4382d37b',1,'tacopie::tcp_client::tcp_client(std::uint32_t num_io_workers=1)'],['../classtacopie_1_1tcp__client.html#a773fbcbb5b79324c8d065e363de73282',1,'tacopie::tcp_client::tcp_client(tcp_socket &&socket)'],['../classtacopie_1_1tcp__client.html#a5e326782c52f63814cc8f42a901ffaf6',1,'tacopie::tcp_client::tcp_client(const tcp_client &)=delete']]], + ['tcp_5fserver',['tcp_server',['../classtacopie_1_1tcp__server.html#a4f67a38a0764924768cbcc7cf68527bf',1,'tacopie::tcp_server::tcp_server(void)'],['../classtacopie_1_1tcp__server.html#a2d9c6a2dea95a3c6a919c655d6e8e0ba',1,'tacopie::tcp_server::tcp_server(const tcp_server &)=delete']]], + ['tcp_5fsocket',['tcp_socket',['../classtacopie_1_1tcp__socket.html#a88ed1cadb0263591c4d31805e0a1a001',1,'tacopie::tcp_socket::tcp_socket(void)'],['../classtacopie_1_1tcp__socket.html#a191ffa48e0753ad4ec87d4d3a4a97822',1,'tacopie::tcp_socket::tcp_socket(fd_t fd, const std::string &host, std::uint32_t port, type t)'],['../classtacopie_1_1tcp__socket.html#a64f69cd1c185b523b543d4ea53cee1a2',1,'tacopie::tcp_socket::tcp_socket(tcp_socket &&)'],['../classtacopie_1_1tcp__socket.html#a5ae1a5b0f9713ef256164afdbeb1c193',1,'tacopie::tcp_socket::tcp_socket(const tcp_socket &)=delete']]], + ['thread_5fpool',['thread_pool',['../classtacopie_1_1utils_1_1thread__pool.html#aa0068f000b8ecb21b2b0a0c50f77877c',1,'tacopie::utils::thread_pool::thread_pool(std::size_t nb_threads)'],['../classtacopie_1_1utils_1_1thread__pool.html#a63a850c39d21058eda9d655bb7eff452',1,'tacopie::utils::thread_pool::thread_pool(const thread_pool &)=delete']]], + ['track',['track',['../classtacopie_1_1io__service.html#a9f4c8bce3c0f6d660515b0b5eb109df8',1,'tacopie::io_service']]] ]; diff --git a/docs/html/search/functions_d.js b/docs/html/search/functions_d.js index 8eed9ff..c9b721c 100644 --- a/docs/html/search/functions_d.js +++ b/docs/html/search/functions_d.js @@ -1,15 +1,5 @@ var searchData= [ - ['self_5fpipe',['self_pipe',['../classtacopie_1_1self__pipe.html#add8d2c43863d1505e6851789ab5d9b97',1,'tacopie::self_pipe::self_pipe(void)'],['../classtacopie_1_1self__pipe.html#a09ffc77b89ad48bc8db6635108c68b6b',1,'tacopie::self_pipe::self_pipe(const self_pipe &)=delete']]], - ['send',['send',['../classtacopie_1_1tcp__socket.html#a36521a8f502adc665ad0fb1c53583d04',1,'tacopie::tcp_socket']]], - ['set_5fdefault_5fio_5fservice',['set_default_io_service',['../namespacetacopie.html#a095c1c9a985cf34379d1fea9c030d2b9',1,'tacopie']]], - ['set_5fnb_5fthreads',['set_nb_threads',['../classtacopie_1_1utils_1_1thread__pool.html#a7c7ae922cedff8fa323828ebb6dea829',1,'tacopie::utils::thread_pool']]], - ['set_5fnb_5fworkers',['set_nb_workers',['../classtacopie_1_1io__service.html#a7e2b0700c0a4591f86c344df8748b3a5',1,'tacopie::io_service']]], - ['set_5fon_5fdisconnection_5fhandler',['set_on_disconnection_handler',['../classtacopie_1_1tcp__client.html#a8c290d681186edb0578051c04f3c0762',1,'tacopie::tcp_client']]], - ['set_5frd_5fcallback',['set_rd_callback',['../classtacopie_1_1io__service.html#a8094c1fec76c6821cc0c008fe524c89a',1,'tacopie::io_service']]], - ['set_5ftype',['set_type',['../classtacopie_1_1tcp__socket.html#a89be86ab254eec3fc16eedfba8b16fb2',1,'tacopie::tcp_socket']]], - ['set_5fwr_5fcallback',['set_wr_callback',['../classtacopie_1_1io__service.html#a7c4f56c7790c7ba52b09837a42aaffb1',1,'tacopie::io_service']]], - ['should_5fstop',['should_stop',['../classtacopie_1_1utils_1_1thread__pool.html#a7a4dbfe7877e2ce8a4189e6f3d3da3a9',1,'tacopie::utils::thread_pool']]], - ['start',['start',['../classtacopie_1_1tcp__server.html#a6cb98b50d865b32dba497273a0eca1e9',1,'tacopie::tcp_server']]], - ['stop',['stop',['../classtacopie_1_1tcp__server.html#abc099e162432e2218faed93fc84180fd',1,'tacopie::tcp_server::stop()'],['../classtacopie_1_1utils_1_1thread__pool.html#a8874d7040d12fbe446519bc9f2bcff37',1,'tacopie::utils::thread_pool::stop()']]] + ['wait_5ffor_5fremoval',['wait_for_removal',['../classtacopie_1_1io__service.html#aa57db619baeaa6db0aeb22e67b895cd7',1,'tacopie::io_service']]], + ['warn',['warn',['../classtacopie_1_1logger__iface.html#ab96d8f6bc2e2b514c7ceec4c856f8921',1,'tacopie::logger_iface::warn()'],['../classtacopie_1_1logger.html#aa4cd2ffc3f4b9d096a35c5c2aa8e0970',1,'tacopie::logger::warn()']]] ]; diff --git a/docs/html/search/functions_e.js b/docs/html/search/functions_e.js index d133428..dd9469a 100644 --- a/docs/html/search/functions_e.js +++ b/docs/html/search/functions_e.js @@ -1,10 +1,11 @@ var searchData= [ - ['tacopie_5ferror',['tacopie_error',['../classtacopie_1_1tacopie__error.html#a524fb8e9ac1825a57664421a3f32b9ce',1,'tacopie::tacopie_error::tacopie_error(const std::string &what, const std::string &file, std::size_t line)'],['../classtacopie_1_1tacopie__error.html#a0cb2a911165e08818ca03308891633e1',1,'tacopie::tacopie_error::tacopie_error(const tacopie_error &)=default']]], - ['tcp_5fclient',['tcp_client',['../classtacopie_1_1tcp__client.html#a0125e1cf017b0ba0370d682d4382d37b',1,'tacopie::tcp_client::tcp_client(std::uint32_t num_io_workers=1)'],['../classtacopie_1_1tcp__client.html#a773fbcbb5b79324c8d065e363de73282',1,'tacopie::tcp_client::tcp_client(tcp_socket &&socket)'],['../classtacopie_1_1tcp__client.html#a5e326782c52f63814cc8f42a901ffaf6',1,'tacopie::tcp_client::tcp_client(const tcp_client &)=delete']]], - ['tcp_5fserver',['tcp_server',['../classtacopie_1_1tcp__server.html#a4f67a38a0764924768cbcc7cf68527bf',1,'tacopie::tcp_server::tcp_server(void)'],['../classtacopie_1_1tcp__server.html#a2d9c6a2dea95a3c6a919c655d6e8e0ba',1,'tacopie::tcp_server::tcp_server(const tcp_server &)=delete']]], - ['tcp_5fsocket',['tcp_socket',['../classtacopie_1_1tcp__socket.html#a88ed1cadb0263591c4d31805e0a1a001',1,'tacopie::tcp_socket::tcp_socket(void)'],['../classtacopie_1_1tcp__socket.html#a191ffa48e0753ad4ec87d4d3a4a97822',1,'tacopie::tcp_socket::tcp_socket(fd_t fd, const std::string &host, std::uint32_t port, type t)'],['../classtacopie_1_1tcp__socket.html#a64f69cd1c185b523b543d4ea53cee1a2',1,'tacopie::tcp_socket::tcp_socket(tcp_socket &&)'],['../classtacopie_1_1tcp__socket.html#a5ae1a5b0f9713ef256164afdbeb1c193',1,'tacopie::tcp_socket::tcp_socket(const tcp_socket &)=delete']]], - ['thread_5fpool',['thread_pool',['../classtacopie_1_1utils_1_1thread__pool.html#aa0068f000b8ecb21b2b0a0c50f77877c',1,'tacopie::utils::thread_pool::thread_pool(std::size_t nb_threads)'],['../classtacopie_1_1utils_1_1thread__pool.html#a63a850c39d21058eda9d655bb7eff452',1,'tacopie::utils::thread_pool::thread_pool(const thread_pool &)=delete']]], - ['track',['track',['../classtacopie_1_1io__service.html#a9f4c8bce3c0f6d660515b0b5eb109df8',1,'tacopie::io_service']]], - ['tracked_5fsocket',['tracked_socket',['../structtacopie_1_1io__service_1_1tracked__socket.html#aa2bb26f180847ad15e09f303a2adc9ee',1,'tacopie::io_service::tracked_socket']]] + ['_7eio_5fservice',['~io_service',['../classtacopie_1_1io__service.html#ae423d7e4b13f07fe41fb051345ffbf8d',1,'tacopie::io_service']]], + ['_7elogger',['~logger',['../classtacopie_1_1logger.html#af5c89b85935dbe3b4da3199247d50398',1,'tacopie::logger']]], + ['_7elogger_5fiface',['~logger_iface',['../classtacopie_1_1logger__iface.html#a562dcc605198ca90904ba21fa98eb6ea',1,'tacopie::logger_iface']]], + ['_7eself_5fpipe',['~self_pipe',['../classtacopie_1_1self__pipe.html#a10a6c4b0d67a4a14abea397a05cee54c',1,'tacopie::self_pipe']]], + ['_7etacopie_5ferror',['~tacopie_error',['../classtacopie_1_1tacopie__error.html#a5bf6b0967f7f4cf2b8f8d0a2ef0912b2',1,'tacopie::tacopie_error']]], + ['_7etcp_5fserver',['~tcp_server',['../classtacopie_1_1tcp__server.html#a7841dc528e2d3dfc94fbe9b93824da50',1,'tacopie::tcp_server']]], + ['_7etcp_5fsocket',['~tcp_socket',['../classtacopie_1_1tcp__socket.html#a4bd737a76a2a326be03d704f79a35282',1,'tacopie::tcp_socket']]], + ['_7ethread_5fpool',['~thread_pool',['../classtacopie_1_1utils_1_1thread__pool.html#accddfc6fad613b0c6d407028799abfc5',1,'tacopie::utils::thread_pool']]] ]; diff --git a/docs/html/search/searchdata.js b/docs/html/search/searchdata.js index 2f01520..49ca358 100644 --- a/docs/html/search/searchdata.js +++ b/docs/html/search/searchdata.js @@ -1,42 +1,27 @@ var indexSectionsWithContent = { - 0: "_abcdefgilmnoprstuw~", + 0: "abcdegilnorstw~", 1: "ilrstw", - 2: "t", - 3: "eilst", - 4: "abcdefgilnoprstuw~", - 5: "abimrsw", - 6: "adefot", - 7: "lt", - 8: "cdeisuw", - 9: "_" + 2: "abcdegilnorstw~", + 3: "adeot", + 4: "lt" }; var indexSectionNames = { 0: "all", 1: "classes", - 2: "namespaces", - 3: "files", - 4: "functions", - 5: "variables", - 6: "typedefs", - 7: "enums", - 8: "enumvalues", - 9: "defines" + 2: "functions", + 3: "typedefs", + 4: "enums" }; var indexSectionLabels = { 0: "All", 1: "Classes", - 2: "Namespaces", - 3: "Files", - 4: "Functions", - 5: "Variables", - 6: "Typedefs", - 7: "Enumerations", - 8: "Enumerator", - 9: "Macros" + 2: "Functions", + 3: "Typedefs", + 4: "Enumerations" }; diff --git a/docs/html/search/typedefs_3.js b/docs/html/search/typedefs_3.js index d950e62..c570468 100644 --- a/docs/html/search/typedefs_3.js +++ b/docs/html/search/typedefs_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['fd_5ft',['fd_t',['../namespacetacopie.html#acce7ad26b2d30156b1e6fa353f727026',1,'tacopie']]] + ['on_5fnew_5fconnection_5fcallback_5ft',['on_new_connection_callback_t',['../classtacopie_1_1tcp__server.html#a103cb4e6fcab00f88a708aabd38b66ff',1,'tacopie::tcp_server']]] ]; diff --git a/docs/html/search/typedefs_4.js b/docs/html/search/typedefs_4.js index c570468..88e53e5 100644 --- a/docs/html/search/typedefs_4.js +++ b/docs/html/search/typedefs_4.js @@ -1,4 +1,4 @@ var searchData= [ - ['on_5fnew_5fconnection_5fcallback_5ft',['on_new_connection_callback_t',['../classtacopie_1_1tcp__server.html#a103cb4e6fcab00f88a708aabd38b66ff',1,'tacopie::tcp_server']]] + ['task_5ft',['task_t',['../classtacopie_1_1utils_1_1thread__pool.html#a8ae8886fdeaa8e5c0abad12626a47296',1,'tacopie::utils::thread_pool']]] ]; diff --git a/docs/html/self__pipe_8hpp_source.html b/docs/html/self__pipe_8hpp_source.html index 8ad435c..1edc9ce 100644 --- a/docs/html/self__pipe_8hpp_source.html +++ b/docs/html/self__pipe_8hpp_source.html @@ -69,18 +69,15 @@
    self_pipe.hpp
    -Go to the documentation of this file.
    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 <tacopie/utils/typedefs.hpp>
    26 
    27 namespace tacopie {
    28 
    29 class self_pipe {
    30 public:
    32  self_pipe(void);
    34  ~self_pipe(void);
    35 
    37  self_pipe(const self_pipe&) = delete;
    39  self_pipe& operator=(const self_pipe&) = delete;
    40 
    41 public:
    45  fd_t get_read_fd(void) const;
    46 
    50  fd_t get_write_fd(void) const;
    51 
    55  void notify(void);
    56 
    60  void clr_buffer(void);
    61 
    62 private:
    63 #ifdef _WIN32
    64  fd_t m_fd;
    68 
    72  struct sockaddr m_addr;
    73 
    77  int m_addr_len;
    78 #else
    79  fd_t m_fds[2];
    83 #endif /* _WIN32 */
    84 };
    85 
    86 } // namespace tacopie
    tacopie::self_pipe::notify
    void notify(void)
    +
    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 <tacopie/utils/typedefs.hpp>
    26 
    27 namespace tacopie {
    28 
    29 class self_pipe {
    30 public:
    32  self_pipe(void);
    34  ~self_pipe(void);
    35 
    37  self_pipe(const self_pipe&) = delete;
    39  self_pipe& operator=(const self_pipe&) = delete;
    40 
    41 public:
    45  fd_t get_read_fd(void) const;
    46 
    50  fd_t get_write_fd(void) const;
    51 
    55  void notify(void);
    56 
    60  void clr_buffer(void);
    61 
    62 private:
    63 #ifdef _WIN32
    64  fd_t m_fd;
    68 
    72  struct sockaddr m_addr;
    73 
    77  int m_addr_len;
    78 #else
    79  fd_t m_fds[2];
    83 #endif /* _WIN32 */
    84 };
    85 
    86 } // namespace tacopie
    tacopie::self_pipe::notify
    void notify(void)
    tacopie::self_pipe::operator=
    self_pipe & operator=(const self_pipe &)=delete
    assignment operator
    tacopie::self_pipe::~self_pipe
    ~self_pipe(void)
    dtor
    tacopie::self_pipe::get_write_fd
    fd_t get_write_fd(void) const
    tacopie::self_pipe::clr_buffer
    void clr_buffer(void)
    tacopie::self_pipe
    Definition: self_pipe.hpp:29
    tacopie
    Definition: io_service.hpp:48
    -
    tacopie::self_pipe::get_read_fd
    fd_t get_read_fd(void) const
    tacopie::self_pipe::self_pipe
    self_pipe(void)
    ctor
    -
    tacopie::fd_t
    int fd_t
    file descriptor platform type
    Definition: typedefs.hpp:36
    -
    tacopie::self_pipe::m_fds
    fd_t m_fds[2]
    Definition: self_pipe.hpp:82
    diff --git a/docs/html/structtacopie_1_1tcp__client_1_1read__request-members.html b/docs/html/structtacopie_1_1tcp__client_1_1read__request-members.html index 2e9f2ca..8e5a99e 100644 --- a/docs/html/structtacopie_1_1tcp__client_1_1read__request-members.html +++ b/docs/html/structtacopie_1_1tcp__client_1_1read__request-members.html @@ -61,7 +61,7 @@
@@ -72,8 +72,8 @@

This is the complete list of members for tacopie::tcp_client::read_request, including all inherited members.

- - + +
async_read_callbacktacopie::tcp_client::read_request
sizetacopie::tcp_client::read_request
async_read_callback (defined in tacopie::tcp_client::read_request)tacopie::tcp_client::read_request
size (defined in tacopie::tcp_client::read_request)tacopie::tcp_client::read_request
diff --git a/docs/html/structtacopie_1_1tcp__client_1_1read__request.html b/docs/html/structtacopie_1_1tcp__client_1_1read__request.html index b584bb7..0a26308 100644 --- a/docs/html/structtacopie_1_1tcp__client_1_1read__request.html +++ b/docs/html/structtacopie_1_1tcp__client_1_1read__request.html @@ -61,7 +61,7 @@
@@ -77,9 +77,11 @@ - + - +

Public Attributes

std::size_t size
+std::size_t size
 
async_read_callback_t async_read_callback
+async_read_callback_t async_read_callback
 

Detailed Description

@@ -87,36 +89,7 @@
  • size: Number of bytes to read
  • async_read_callback: Callback to be called on a read operation completion, even though the operation read less bytes than requested.
    • -

    Member Data Documentation

    - -

    ◆ async_read_callback

    - -
    -
    - - - - -
    async_read_callback_t tacopie::tcp_client::read_request::async_read_callback
    -
    - -
    -
    - -

    ◆ size

    - -
    -
    - - - - -
    std::size_t tacopie::tcp_client::read_request::size
    -
    - -
    -
    -
    The documentation for this struct was generated from the following file:
      +
      The documentation for this struct was generated from the following file: diff --git a/docs/html/structtacopie_1_1tcp__client_1_1read__result-members.html b/docs/html/structtacopie_1_1tcp__client_1_1read__result-members.html index 57f4490..80e6e4d 100644 --- a/docs/html/structtacopie_1_1tcp__client_1_1read__result-members.html +++ b/docs/html/structtacopie_1_1tcp__client_1_1read__result-members.html @@ -61,7 +61,7 @@
    @@ -72,8 +72,8 @@

    This is the complete list of members for tacopie::tcp_client::read_result, including all inherited members.

    - - + +
    buffertacopie::tcp_client::read_result
    successtacopie::tcp_client::read_result
    buffer (defined in tacopie::tcp_client::read_result)tacopie::tcp_client::read_result
    success (defined in tacopie::tcp_client::read_result)tacopie::tcp_client::read_result
    diff --git a/docs/html/structtacopie_1_1tcp__client_1_1read__result.html b/docs/html/structtacopie_1_1tcp__client_1_1read__result.html index 5abc6fd..ae3d1c6 100644 --- a/docs/html/structtacopie_1_1tcp__client_1_1read__result.html +++ b/docs/html/structtacopie_1_1tcp__client_1_1read__result.html @@ -61,7 +61,7 @@
    @@ -77,9 +77,11 @@ - + - +

    Public Attributes

    bool success
    +bool success
     
    std::vector< char > buffer
    +std::vector< char > buffer
     

    Detailed Description

    @@ -87,36 +89,7 @@
  • success: Whether the read operation has succeeded or not. If false, the client has been disconnected
  • buffer: Vector containing the read bytes
    • -

    Member Data Documentation

    - -

    ◆ buffer

    - -
    -
    - - - - -
    std::vector<char> tacopie::tcp_client::read_result::buffer
    -
    - -
    -
    - -

    ◆ success

    - -
    -
    - - - - -
    bool tacopie::tcp_client::read_result::success
    -
    - -
    -
    -
    The documentation for this struct was generated from the following file:
      +
      The documentation for this struct was generated from the following file: diff --git a/docs/html/structtacopie_1_1tcp__client_1_1write__request-members.html b/docs/html/structtacopie_1_1tcp__client_1_1write__request-members.html index ee41547..7a26850 100644 --- a/docs/html/structtacopie_1_1tcp__client_1_1write__request-members.html +++ b/docs/html/structtacopie_1_1tcp__client_1_1write__request-members.html @@ -61,7 +61,7 @@
    @@ -72,8 +72,8 @@

    This is the complete list of members for tacopie::tcp_client::write_request, including all inherited members.

    - - + +
    async_write_callbacktacopie::tcp_client::write_request
    buffertacopie::tcp_client::write_request
    async_write_callback (defined in tacopie::tcp_client::write_request)tacopie::tcp_client::write_request
    buffer (defined in tacopie::tcp_client::write_request)tacopie::tcp_client::write_request
    diff --git a/docs/html/structtacopie_1_1tcp__client_1_1write__request.html b/docs/html/structtacopie_1_1tcp__client_1_1write__request.html index 8d2403d..9270673 100644 --- a/docs/html/structtacopie_1_1tcp__client_1_1write__request.html +++ b/docs/html/structtacopie_1_1tcp__client_1_1write__request.html @@ -61,7 +61,7 @@
    @@ -77,9 +77,11 @@ - + - +

    Public Attributes

    std::vector< char > buffer
    +std::vector< char > buffer
     
    async_write_callback_t async_write_callback
    +async_write_callback_t async_write_callback
     

    Detailed Description

    @@ -87,36 +89,7 @@
  • buffer: Bytes to be written
  • async_write_callback: Callback to be called on a write operation completion, even though the operation wrote less bytes than requested.
    • -

    Member Data Documentation

    - -

    ◆ async_write_callback

    - -
    -
    - - - - -
    async_write_callback_t tacopie::tcp_client::write_request::async_write_callback
    -
    - -
    -
    - -

    ◆ buffer

    - -
    -
    - - - - -
    std::vector<char> tacopie::tcp_client::write_request::buffer
    -
    - -
    -
    -
    The documentation for this struct was generated from the following file:
      +
      The documentation for this struct was generated from the following file: diff --git a/docs/html/structtacopie_1_1tcp__client_1_1write__result-members.html b/docs/html/structtacopie_1_1tcp__client_1_1write__result-members.html index faf64f7..300fad4 100644 --- a/docs/html/structtacopie_1_1tcp__client_1_1write__result-members.html +++ b/docs/html/structtacopie_1_1tcp__client_1_1write__result-members.html @@ -61,7 +61,7 @@
    @@ -72,8 +72,8 @@

    This is the complete list of members for tacopie::tcp_client::write_result, including all inherited members.

    - - + +
    sizetacopie::tcp_client::write_result
    successtacopie::tcp_client::write_result
    size (defined in tacopie::tcp_client::write_result)tacopie::tcp_client::write_result
    success (defined in tacopie::tcp_client::write_result)tacopie::tcp_client::write_result
    diff --git a/docs/html/structtacopie_1_1tcp__client_1_1write__result.html b/docs/html/structtacopie_1_1tcp__client_1_1write__result.html index eecc8f6..4d6a1f7 100644 --- a/docs/html/structtacopie_1_1tcp__client_1_1write__result.html +++ b/docs/html/structtacopie_1_1tcp__client_1_1write__result.html @@ -61,7 +61,7 @@
    @@ -77,9 +77,11 @@ - + - +

    Public Attributes

    bool success
    +bool success
     
    std::size_t size
    +std::size_t size
     

    Detailed Description

    @@ -87,36 +89,7 @@
  • success: Whether the write operation has succeeded or not. If false, the client has been disconnected
  • size: Number of bytes written
    • -

    Member Data Documentation

    - -

    ◆ size

    - -
    -
    - - - - -
    std::size_t tacopie::tcp_client::write_result::size
    -
    - -
    -
    - -

    ◆ success

    - -
    -
    - - - - -
    bool tacopie::tcp_client::write_result::success
    -
    - -
    -
    -
    The documentation for this struct was generated from the following file:
      +
      The documentation for this struct was generated from the following file: diff --git a/docs/html/tcp__client_8hpp_source.html b/docs/html/tcp__client_8hpp_source.html index facfee9..36ad3b5 100644 --- a/docs/html/tcp__client_8hpp_source.html +++ b/docs/html/tcp__client_8hpp_source.html @@ -69,58 +69,30 @@
      tcp_client.hpp
      -Go to the documentation of this file.
      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 <atomic>
      26 #include <cstdint>
      27 #include <mutex>
      28 #include <queue>
      29 #include <string>
      30 
      31 #include <tacopie/network/io_service.hpp>
      32 #include <tacopie/network/tcp_socket.hpp>
      33 #include <tacopie/utils/typedefs.hpp>
      34 
      35 namespace tacopie {
      36 
      37 class tcp_client {
      38 public:
      40  tcp_client(std::uint32_t num_io_workers = 1);
      41  ~tcp_client(void);
      42 
      49  explicit tcp_client(tcp_socket&& socket);
      50 
      52  tcp_client(const tcp_client&) = delete;
      54  tcp_client& operator=(const tcp_client&) = delete;
      55 
      56 public:
      62  bool operator==(const tcp_client& rhs) const;
      63 
      69  bool operator!=(const tcp_client& rhs) const;
      70 
      71 public:
      75  const std::string& get_host(void) const;
      76 
      80  std::uint32_t get_port(void) const;
      81 
      82 public:
      90  void connect(const std::string& host, std::uint32_t port, std::uint32_t timeout_msecs = 0);
      91 
      97  void disconnect(bool wait_for_removal = false);
      98 
      102  bool is_connected(void) const;
      103 
      104 private:
      108  void call_disconnection_handler(void);
      109 
      110 public:
      116  struct read_result {
      117  bool success;
      118  std::vector<char> buffer;
      119  };
      120 
      126  struct write_result {
      127  bool success;
      128  std::size_t size;
      129  };
      130 
      131 public:
      136  typedef std::function<void(read_result&)> async_read_callback_t;
      137 
      142  typedef std::function<void(write_result&)> async_write_callback_t;
      143 
      144 public:
      150  struct read_request {
      151  std::size_t size;
      152  async_read_callback_t async_read_callback;
      153  };
      154 
      160  struct write_request {
      161  std::vector<char> buffer;
      162  async_write_callback_t async_write_callback;
      163  };
      164 
      165 public:
      171  void async_read(const read_request& request);
      172 
      178  void async_write(const write_request& request);
      179 
      180 public:
      184  tacopie::tcp_socket& get_socket(void);
      185 
      189  const tacopie::tcp_socket& get_socket(void) const;
      190 
      191 public:
      195  const std::shared_ptr<tacopie::io_service>& get_io_service(void) const;
      196 
      197 public:
      203  typedef std::function<void()> disconnection_handler_t;
      204 
      210  void set_on_disconnection_handler(const disconnection_handler_t& disconnection_handler);
      211 
      212 private:
      219  void on_read_available(fd_t fd);
      220 
      227  void on_write_available(fd_t fd);
      228 
      229 private:
      233  void clear_read_requests(void);
      234 
      238  void clear_write_requests(void);
      239 
      240 private:
      249  async_read_callback_t process_read(read_result& result);
      250 
      259  async_write_callback_t process_write(write_result& result);
      260 
      261 private:
      266  std::shared_ptr<io_service> m_io_service;
      267 
      271  tacopie::tcp_socket m_socket;
      272 
      276  std::atomic<bool> m_is_connected = ATOMIC_VAR_INIT(false);
      277 
      281  std::queue<read_request> m_read_requests;
      285  std::queue<write_request> m_write_requests;
      286 
      290  std::mutex m_read_requests_mtx;
      294  std::mutex m_write_requests_mtx;
      295 
      299  disconnection_handler_t m_disconnection_handler;
      300 };
      301 
      302 } // namespace tacopie
      tacopie::tcp_client::connect
      void connect(const std::string &host, std::uint32_t port, std::uint32_t timeout_msecs=0)
      -
      tacopie::tcp_client::read_result::success
      bool success
      Definition: tcp_client.hpp:117
      -
      tacopie::tcp_client::process_write
      async_write_callback_t process_write(write_result &result)
      -
      tacopie::tcp_client::clear_write_requests
      void clear_write_requests(void)
      -
      io_service.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 <atomic>
      26 #include <cstdint>
      27 #include <mutex>
      28 #include <queue>
      29 #include <string>
      30 
      31 #include <tacopie/network/io_service.hpp>
      32 #include <tacopie/network/tcp_socket.hpp>
      33 #include <tacopie/utils/typedefs.hpp>
      34 
      35 namespace tacopie {
      36 
      37 class tcp_client {
      38 public:
      40  tcp_client(std::uint32_t num_io_workers = 1);
      41  ~tcp_client(void);
      42 
      49  explicit tcp_client(tcp_socket&& socket);
      50 
      52  tcp_client(const tcp_client&) = delete;
      54  tcp_client& operator=(const tcp_client&) = delete;
      55 
      56 public:
      62  bool operator==(const tcp_client& rhs) const;
      63 
      69  bool operator!=(const tcp_client& rhs) const;
      70 
      71 public:
      75  const std::string& get_host(void) const;
      76 
      80  std::uint32_t get_port(void) const;
      81 
      82 public:
      90  void connect(const std::string& host, std::uint32_t port, std::uint32_t timeout_msecs = 0);
      91 
      97  void disconnect(bool wait_for_removal = false);
      98 
      102  bool is_connected(void) const;
      103 
      104 private:
      108  void call_disconnection_handler(void);
      109 
      110 public:
      116  struct read_result {
      117  bool success;
      118  std::vector<char> buffer;
      119  };
      120 
      126  struct write_result {
      127  bool success;
      128  std::size_t size;
      129  };
      130 
      131 public:
      136  typedef std::function<void(read_result&)> async_read_callback_t;
      137 
      142  typedef std::function<void(write_result&)> async_write_callback_t;
      143 
      144 public:
      150  struct read_request {
      151  std::size_t size;
      152  async_read_callback_t async_read_callback;
      153  };
      154 
      160  struct write_request {
      161  std::vector<char> buffer;
      162  async_write_callback_t async_write_callback;
      163  };
      164 
      165 public:
      171  void async_read(const read_request& request);
      172 
      178  void async_write(const write_request& request);
      179 
      180 public:
      184  tacopie::tcp_socket& get_socket(void);
      185 
      189  const tacopie::tcp_socket& get_socket(void) const;
      190 
      191 public:
      195  const std::shared_ptr<tacopie::io_service>& get_io_service(void) const;
      196 
      197 public:
      203  typedef std::function<void()> disconnection_handler_t;
      204 
      210  void set_on_disconnection_handler(const disconnection_handler_t& disconnection_handler);
      211 
      212 private:
      219  void on_read_available(fd_t fd);
      220 
      227  void on_write_available(fd_t fd);
      228 
      229 private:
      233  void clear_read_requests(void);
      234 
      238  void clear_write_requests(void);
      239 
      240 private:
      249  async_read_callback_t process_read(read_result& result);
      250 
      259  async_write_callback_t process_write(write_result& result);
      260 
      261 private:
      266  std::shared_ptr<io_service> m_io_service;
      267 
      271  tacopie::tcp_socket m_socket;
      272 
      276  std::atomic<bool> m_is_connected = ATOMIC_VAR_INIT(false);
      277 
      281  std::queue<read_request> m_read_requests;
      285  std::queue<write_request> m_write_requests;
      286 
      290  std::mutex m_read_requests_mtx;
      294  std::mutex m_write_requests_mtx;
      295 
      299  disconnection_handler_t m_disconnection_handler;
      300 };
      301 
      302 } // namespace tacopie
      tacopie::tcp_client::connect
      void connect(const std::string &host, std::uint32_t port, std::uint32_t timeout_msecs=0)
      tacopie::tcp_client::async_write_callback_t
      std::function< void(write_result &)> async_write_callback_t
      Definition: tcp_client.hpp:142
      tacopie::tcp_client::disconnect
      void disconnect(bool wait_for_removal=false)
      tacopie::tcp_client::async_read
      void async_read(const read_request &request)
      -
      tacopie::tcp_client::read_request::size
      std::size_t size
      Definition: tcp_client.hpp:151
      tacopie::tcp_socket
      Definition: tcp_socket.hpp:38
      tacopie::tcp_client::is_connected
      bool is_connected(void) const
      tacopie::tcp_client::get_io_service
      const std::shared_ptr< tacopie::io_service > & get_io_service(void) const
      -
      tacopie::tcp_client::m_socket
      tacopie::tcp_socket m_socket
      Definition: tcp_client.hpp:271
      -
      tacopie::tcp_client::on_write_available
      void on_write_available(fd_t fd)
      tacopie::tcp_client::set_on_disconnection_handler
      void set_on_disconnection_handler(const disconnection_handler_t &disconnection_handler)
      -
      tacopie::tcp_client::clear_read_requests
      void clear_read_requests(void)
      -
      tacopie::tcp_client::call_disconnection_handler
      void call_disconnection_handler(void)
      tacopie::tcp_client::read_result
      Definition: tcp_client.hpp:116
      tacopie::tcp_client::get_port
      std::uint32_t get_port(void) const
      tacopie::tcp_client::write_result
      Definition: tcp_client.hpp:126
      tacopie::tcp_client::operator==
      bool operator==(const tcp_client &rhs) const
      -
      tcp_socket.hpp
      tacopie::tcp_client::tcp_client
      tcp_client(std::uint32_t num_io_workers=1)
      ctor & dtor
      tacopie
      Definition: io_service.hpp:48
      -
      tacopie::tcp_client::operator!=
      bool operator!=(const tcp_client &rhs) const
      -
      tacopie::tcp_client::write_result::success
      bool success
      Definition: tcp_client.hpp:127
      -
      tacopie::tcp_client::m_write_requests_mtx
      std::mutex m_write_requests_mtx
      Definition: tcp_client.hpp:294
      -
      tacopie::tcp_client::write_request::buffer
      std::vector< char > buffer
      Definition: tcp_client.hpp:161
      tacopie::tcp_client::disconnection_handler_t
      std::function< void()> disconnection_handler_t
      Definition: tcp_client.hpp:203
      tacopie::tcp_client::async_read_callback_t
      std::function< void(read_result &)> async_read_callback_t
      Definition: tcp_client.hpp:136
      -
      tacopie::tcp_client::m_is_connected
      std::atomic< bool > m_is_connected
      Definition: tcp_client.hpp:276
      tacopie::tcp_client::read_request
      Definition: tcp_client.hpp:150
      tacopie::tcp_client
      Definition: tcp_client.hpp:37
      -
      tacopie::tcp_client::~tcp_client
      ~tcp_client(void)
      -
      tacopie::tcp_client::read_request::async_read_callback
      async_read_callback_t async_read_callback
      Definition: tcp_client.hpp:152
      -
      tacopie::tcp_client::process_read
      async_read_callback_t process_read(read_result &result)
      -
      tacopie::tcp_client::m_read_requests_mtx
      std::mutex m_read_requests_mtx
      Definition: tcp_client.hpp:290
      tacopie::tcp_client::get_socket
      tacopie::tcp_socket & get_socket(void)
      -
      tacopie::tcp_client::read_result::buffer
      std::vector< char > buffer
      Definition: tcp_client.hpp:118
      tacopie::tcp_client::async_write
      void async_write(const write_request &request)
      -
      tacopie::tcp_client::m_disconnection_handler
      disconnection_handler_t m_disconnection_handler
      Definition: tcp_client.hpp:299
      -
      tacopie::tcp_client::on_read_available
      void on_read_available(fd_t fd)
      tacopie::tcp_client::get_host
      const std::string & get_host(void) const
      tacopie::tcp_client::operator=
      tcp_client & operator=(const tcp_client &)=delete
      assignment operator
      -
      tacopie::tcp_client::write_result::size
      std::size_t size
      Definition: tcp_client.hpp:128
      tacopie::tcp_client::write_request
      Definition: tcp_client.hpp:160
      -
      tacopie::tcp_client::m_write_requests
      std::queue< write_request > m_write_requests
      Definition: tcp_client.hpp:285
      -
      tacopie::fd_t
      int fd_t
      file descriptor platform type
      Definition: typedefs.hpp:36
      -
      tacopie::tcp_client::write_request::async_write_callback
      async_write_callback_t async_write_callback
      Definition: tcp_client.hpp:162
      -
      tacopie::tcp_client::m_io_service
      std::shared_ptr< io_service > m_io_service
      Definition: tcp_client.hpp:266
      -
      tacopie::tcp_client::m_read_requests
      std::queue< read_request > m_read_requests
      Definition: tcp_client.hpp:281
      diff --git a/docs/html/tcp__server_8hpp_source.html b/docs/html/tcp__server_8hpp_source.html index a63c6ca..0a39dd8 100644 --- a/docs/html/tcp__server_8hpp_source.html +++ b/docs/html/tcp__server_8hpp_source.html @@ -69,31 +69,18 @@
      tcp_server.hpp
      -Go to the documentation of this file.
      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 <atomic>
      26 #include <cstdint>
      27 #include <list>
      28 #include <memory>
      29 #include <mutex>
      30 #include <string>
      31 
      32 #include <tacopie/network/io_service.hpp>
      33 #include <tacopie/network/tcp_client.hpp>
      34 #include <tacopie/network/tcp_socket.hpp>
      35 #include <tacopie/utils/typedefs.hpp>
      36 
      37 #define __TACOPIE_CONNECTION_QUEUE_SIZE 1024
      38 
      39 namespace tacopie {
      40 
      45 class tcp_server {
      46 public:
      48  tcp_server(void);
      50  ~tcp_server(void);
      51 
      53  tcp_server(const tcp_server&) = delete;
      55  tcp_server& operator=(const tcp_server&) = delete;
      56 
      57 public:
      63  bool operator==(const tcp_server& rhs) const;
      64 
      70  bool operator!=(const tcp_server& rhs) const;
      71 
      72 public:
      79  typedef std::function<bool(const std::shared_ptr<tcp_client>&)> on_new_connection_callback_t;
      80 
      88  void start(const std::string& host, std::uint32_t port, const on_new_connection_callback_t& callback = nullptr);
      89 
      96  void stop(bool wait_for_removal = false, bool recursive_wait_for_removal = true);
      97 
      101  bool is_running(void) const;
      102 
      103 public:
      107  tcp_socket& get_socket(void);
      108 
      112  const tcp_socket& get_socket(void) const;
      113 
      114 public:
      118  const std::shared_ptr<tacopie::io_service>& get_io_service(void) const;
      119 
      120 public:
      124  const std::list<std::shared_ptr<tacopie::tcp_client>>& get_clients(void) const;
      125 
      126 private:
      132  void on_read_available(fd_t fd);
      133 
      140  void on_client_disconnected(const std::shared_ptr<tcp_client>& client);
      141 
      142 private:
      147  std::shared_ptr<io_service> m_io_service;
      148 
      149  //1
      152  tacopie::tcp_socket m_socket;
      153 
      157  std::atomic<bool> m_is_running = ATOMIC_VAR_INIT(false);
      158 
      162  std::list<std::shared_ptr<tacopie::tcp_client>> m_clients;
      163 
      167  std::mutex m_clients_mtx;
      168 
      172  on_new_connection_callback_t m_on_new_connection_callback;
      173 };
      174 
      175 } // namespace tacopie
      tacopie::tcp_server::m_clients_mtx
      std::mutex m_clients_mtx
      Definition: tcp_server.hpp:167
      -
      tacopie::tcp_server::tcp_server
      tcp_server(void)
      ctor
      -
      io_service.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 <atomic>
      26 #include <cstdint>
      27 #include <list>
      28 #include <memory>
      29 #include <mutex>
      30 #include <string>
      31 
      32 #include <tacopie/network/io_service.hpp>
      33 #include <tacopie/network/tcp_client.hpp>
      34 #include <tacopie/network/tcp_socket.hpp>
      35 #include <tacopie/utils/typedefs.hpp>
      36 
      37 #define __TACOPIE_CONNECTION_QUEUE_SIZE 1024
      38 
      39 namespace tacopie {
      40 
      45 class tcp_server {
      46 public:
      48  tcp_server(void);
      50  ~tcp_server(void);
      51 
      53  tcp_server(const tcp_server&) = delete;
      55  tcp_server& operator=(const tcp_server&) = delete;
      56 
      57 public:
      63  bool operator==(const tcp_server& rhs) const;
      64 
      70  bool operator!=(const tcp_server& rhs) const;
      71 
      72 public:
      79  typedef std::function<bool(const std::shared_ptr<tcp_client>&)> on_new_connection_callback_t;
      80 
      88  void start(const std::string& host, std::uint32_t port, const on_new_connection_callback_t& callback = nullptr);
      89 
      96  void stop(bool wait_for_removal = false, bool recursive_wait_for_removal = true);
      97 
      101  bool is_running(void) const;
      102 
      103 public:
      107  tcp_socket& get_socket(void);
      108 
      112  const tcp_socket& get_socket(void) const;
      113 
      114 public:
      118  const std::shared_ptr<tacopie::io_service>& get_io_service(void) const;
      119 
      120 public:
      124  const std::list<std::shared_ptr<tacopie::tcp_client>>& get_clients(void) const;
      125 
      126 private:
      132  void on_read_available(fd_t fd);
      133 
      140  void on_client_disconnected(const std::shared_ptr<tcp_client>& client);
      141 
      142 private:
      147  std::shared_ptr<io_service> m_io_service;
      148 
      149  //1
      152  tacopie::tcp_socket m_socket;
      153 
      157  std::atomic<bool> m_is_running = ATOMIC_VAR_INIT(false);
      158 
      162  std::list<std::shared_ptr<tacopie::tcp_client>> m_clients;
      163 
      167  std::mutex m_clients_mtx;
      168 
      172  on_new_connection_callback_t m_on_new_connection_callback;
      173 };
      174 
      175 } // namespace tacopie
      tacopie::tcp_server::tcp_server
      tcp_server(void)
      ctor
      tacopie::tcp_server::operator=
      tcp_server & operator=(const tcp_server &)=delete
      assignment operator
      tacopie::tcp_server::stop
      void stop(bool wait_for_removal=false, bool recursive_wait_for_removal=true)
      -
      tcp_client.hpp
      tacopie::tcp_socket
      Definition: tcp_socket.hpp:38
      -
      tacopie::tcp_server::m_clients
      std::list< std::shared_ptr< tacopie::tcp_client > > m_clients
      Definition: tcp_server.hpp:162
      tacopie::tcp_server
      Definition: tcp_server.hpp:45
      tacopie::tcp_server::get_socket
      tcp_socket & get_socket(void)
      tacopie::tcp_server::~tcp_server
      ~tcp_server(void)
      dtor
      -
      tacopie::tcp_server::on_client_disconnected
      void on_client_disconnected(const std::shared_ptr< tcp_client > &client)
      -
      tcp_socket.hpp
      -
      tacopie::tcp_server::m_on_new_connection_callback
      on_new_connection_callback_t m_on_new_connection_callback
      Definition: tcp_server.hpp:172
      tacopie
      Definition: io_service.hpp:48
      -
      tacopie::tcp_server::on_new_connection_callback_t
      std::function< bool(const std::shared_ptr< tcp_client > &)> on_new_connection_callback_t
      Definition: tcp_server.hpp:79
      -
      tacopie::tcp_server::m_io_service
      std::shared_ptr< io_service > m_io_service
      Definition: tcp_server.hpp:147
      -
      tacopie::tcp_server::m_is_running
      std::atomic< bool > m_is_running
      Definition: tcp_server.hpp:157
      tacopie::tcp_server::operator==
      bool operator==(const tcp_server &rhs) const
      -
      tacopie::tcp_server::m_socket
      tacopie::tcp_socket m_socket
      Definition: tcp_server.hpp:152
      tacopie::tcp_server::get_clients
      const std::list< std::shared_ptr< tacopie::tcp_client > > & get_clients(void) const
      tacopie::tcp_server::get_io_service
      const std::shared_ptr< tacopie::io_service > & get_io_service(void) const
      -
      tacopie::fd_t
      int fd_t
      file descriptor platform type
      Definition: typedefs.hpp:36
      -
      tacopie::tcp_server::on_read_available
      void on_read_available(fd_t fd)
      tacopie::tcp_server::operator!=
      bool operator!=(const tcp_server &rhs) const
      tacopie::tcp_server::start
      void start(const std::string &host, std::uint32_t port, const on_new_connection_callback_t &callback=nullptr)
      tacopie::tcp_server::is_running
      bool is_running(void) const
      diff --git a/docs/html/tcp__socket_8hpp_source.html b/docs/html/tcp__socket_8hpp_source.html index d60e04a..10e60d8 100644 --- a/docs/html/tcp__socket_8hpp_source.html +++ b/docs/html/tcp__socket_8hpp_source.html @@ -69,34 +69,23 @@
      tcp_socket.hpp
      -Go to the documentation of this file.
      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::m_type
      type m_type
      Definition: tcp_socket.hpp:214
      -
      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 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
      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::type::CLIENT
      tacopie::tcp_socket::accept
      tcp_socket accept(void)
      tacopie::tcp_socket
      Definition: tcp_socket.hpp:38
      -
      tacopie::tcp_socket::type::UNKNOWN
      tacopie::tcp_socket::get_port
      std::uint32_t get_port(void) const
      tacopie::tcp_socket::~tcp_socket
      ~tcp_socket(void)=default
      dtor
      tacopie::tcp_socket::type
      type
      Definition: tcp_socket.hpp:46
      tacopie::tcp_socket::operator=
      tcp_socket & operator=(const tcp_socket &)=delete
      assignment operator
      tacopie
      Definition: io_service.hpp:48
      -
      tacopie::tcp_socket::tcp_socket
      tcp_socket(void)
      ctor
      -
      tacopie::tcp_socket::check_or_set_type
      void check_or_set_type(type t)
      -
      tacopie::tcp_socket::m_fd
      fd_t m_fd
      Definition: tcp_socket.hpp:200
      tacopie::tcp_socket::get_fd
      fd_t get_fd(void) const
      -
      tacopie::tcp_socket::type::SERVER
      -
      tacopie::tcp_socket::create_socket_if_necessary
      void create_socket_if_necessary(void)
      tacopie::tcp_socket::operator==
      bool operator==(const tcp_socket &rhs) const
      -
      tacopie::tcp_socket::m_port
      std::uint32_t m_port
      Definition: tcp_socket.hpp:209
      tacopie::tcp_socket::close
      void close(void)
      tacopie::tcp_socket::listen
      void listen(std::size_t max_connection_queue)
      tacopie::tcp_socket::get_host
      const std::string & get_host(void) const
      tacopie::tcp_socket::send
      std::size_t send(const std::vector< char > &data, std::size_t size_to_write)
      -
      tacopie::fd_t
      int fd_t
      file descriptor platform type
      Definition: typedefs.hpp:36
      -
      tacopie::tcp_socket::m_host
      std::string m_host
      Definition: tcp_socket.hpp:205
      tacopie::tcp_socket::operator!=
      bool operator!=(const tcp_socket &rhs) const
      tacopie::tcp_socket::bind
      void bind(const std::string &host, std::uint32_t port)
      tacopie::tcp_socket::recv
      std::vector< char > recv(std::size_t size_to_read)
      diff --git a/docs/html/thread__pool_8hpp_source.html b/docs/html/thread__pool_8hpp_source.html index 8b61b2f..b038a04 100644 --- a/docs/html/thread__pool_8hpp_source.html +++ b/docs/html/thread__pool_8hpp_source.html @@ -69,25 +69,16 @@
      thread_pool.hpp
      -Go to the documentation of this file.
      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 <atomic>
      26 #include <condition_variable>
      27 #include <functional>
      28 #include <mutex>
      29 #include <queue>
      30 #include <thread>
      31 #include <vector>
      32 
      33 namespace tacopie {
      34 
      35 namespace utils {
      36 
      37 class thread_pool {
      38 public:
      45  explicit thread_pool(std::size_t nb_threads);
      46 
      48  ~thread_pool(void);
      49 
      51  thread_pool(const thread_pool&) = delete;
      53  thread_pool& operator=(const thread_pool&) = delete;
      54 
      55 public:
      60  typedef std::function<void()> task_t;
      61 
      68  void add_task(const task_t& task);
      69 
      76  thread_pool& operator<<(const task_t& task);
      77 
      82  void stop(void);
      83 
      84 public:
      88  bool is_running(void) const;
      89 
      90 public:
      103  void set_nb_threads(std::size_t nb_threads);
      104 
      105 private:
      109  void run(void);
      110 
      116  task_t fetch_task(void);
      117 
      121  bool should_stop(void) const;
      122 
      123 private:
      127  std::vector<std::thread> m_workers;
      128 
      132  std::size_t m_nb_threads;
      133 
      137  std::atomic<bool> m_should_stop = ATOMIC_VAR_INIT(false);
      138 
      142  std::queue<task_t> m_tasks;
      143 
      147  std::mutex m_tasks_mtx;
      148 
      152  std::condition_variable m_tasks_condvar;
      153 };
      154 
      155 } // namespace utils
      156 
      157 } // namespace tacopie
      tacopie::utils::thread_pool::m_tasks_condvar
      std::condition_variable m_tasks_condvar
      Definition: thread_pool.hpp:152
      -
      tacopie::utils::thread_pool::~thread_pool
      ~thread_pool(void)
      dtor
      +
      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 <atomic>
      26 #include <condition_variable>
      27 #include <functional>
      28 #include <mutex>
      29 #include <queue>
      30 #include <thread>
      31 #include <vector>
      32 
      33 namespace tacopie {
      34 
      35 namespace utils {
      36 
      37 class thread_pool {
      38 public:
      45  explicit thread_pool(std::size_t nb_threads);
      46 
      48  ~thread_pool(void);
      49 
      51  thread_pool(const thread_pool&) = delete;
      53  thread_pool& operator=(const thread_pool&) = delete;
      54 
      55 public:
      60  typedef std::function<void()> task_t;
      61 
      68  void add_task(const task_t& task);
      69 
      76  thread_pool& operator<<(const task_t& task);
      77 
      82  void stop(void);
      83 
      84 public:
      88  bool is_running(void) const;
      89 
      90 public:
      103  void set_nb_threads(std::size_t nb_threads);
      104 
      105 private:
      109  void run(void);
      110 
      116  task_t fetch_task(void);
      117 
      121  bool should_stop(void) const;
      122 
      123 private:
      127  std::vector<std::thread> m_workers;
      128 
      132  std::size_t m_nb_threads;
      133 
      137  std::atomic<bool> m_should_stop = ATOMIC_VAR_INIT(false);
      138 
      142  std::queue<task_t> m_tasks;
      143 
      147  std::mutex m_tasks_mtx;
      148 
      152  std::condition_variable m_tasks_condvar;
      153 };
      154 
      155 } // namespace utils
      156 
      157 } // namespace tacopie
      tacopie::utils::thread_pool::~thread_pool
      ~thread_pool(void)
      dtor
      tacopie::utils::thread_pool::thread_pool
      thread_pool(std::size_t nb_threads)
      -
      tacopie::utils::thread_pool::run
      void run(void)
      -
      tacopie::utils::thread_pool::m_nb_threads
      std::size_t m_nb_threads
      Definition: thread_pool.hpp:132
      -
      tacopie::utils::thread_pool::m_tasks_mtx
      std::mutex m_tasks_mtx
      Definition: thread_pool.hpp:147
      tacopie::utils::thread_pool::operator=
      thread_pool & operator=(const thread_pool &)=delete
      assignment operator
      tacopie::utils::thread_pool::task_t
      std::function< void()> task_t
      Definition: thread_pool.hpp:60
      -
      tacopie::utils::thread_pool::m_should_stop
      std::atomic< bool > m_should_stop
      Definition: thread_pool.hpp:137
      -
      tacopie::utils::thread_pool::should_stop
      bool should_stop(void) const
      -
      tacopie::utils::thread_pool::fetch_task
      task_t fetch_task(void)
      tacopie
      Definition: io_service.hpp:48
      tacopie::utils::thread_pool::add_task
      void add_task(const task_t &task)
      tacopie::utils::thread_pool::stop
      void stop(void)
      -
      tacopie::utils::thread_pool::m_workers
      std::vector< std::thread > m_workers
      Definition: thread_pool.hpp:127
      tacopie::utils::thread_pool::operator<<
      thread_pool & operator<<(const task_t &task)
      tacopie::utils::thread_pool::set_nb_threads
      void set_nb_threads(std::size_t nb_threads)
      tacopie::utils::thread_pool
      Definition: thread_pool.hpp:37
      -
      tacopie::utils::thread_pool::m_tasks
      std::queue< task_t > m_tasks
      Definition: thread_pool.hpp:142
      tacopie::utils::thread_pool::is_running
      bool is_running(void) const
      diff --git a/docs/html/typedefs_8hpp_source.html b/docs/html/typedefs_8hpp_source.html index 251dcb4..90f74f3 100644 --- a/docs/html/typedefs_8hpp_source.html +++ b/docs/html/typedefs_8hpp_source.html @@ -69,8 +69,7 @@
      typedefs.hpp
      -Go to the documentation of this file.
      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 #ifdef _WIN32
      26 #include <Winsock2.h>
      27 #endif /* _WIN32 */
      28 
      29 namespace tacopie {
      30 
      32 #ifdef _WIN32
      33 typedef SOCKET fd_t;
      34 #define __TACOPIE_INVALID_FD INVALID_SOCKET
      35 #else
      36 typedef int fd_t;
      37 #define __TACOPIE_INVALID_FD -1
      38 #endif /* _WIN32 */
      39 
      41 #if defined(_MSC_VER)
      42 #include <BaseTsd.h>
      43 typedef SSIZE_T ssize_t;
      44 #endif
      45 
      46 }
      tacopie
      Definition: io_service.hpp:48
      -
      tacopie::fd_t
      int fd_t
      file descriptor platform type
      Definition: typedefs.hpp:36
      +
      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 #ifdef _WIN32
      26 #include <Winsock2.h>
      27 #endif /* _WIN32 */
      28 
      29 namespace tacopie {
      30 
      32 #ifdef _WIN32
      33 typedef SOCKET fd_t;
      34 #define __TACOPIE_INVALID_FD INVALID_SOCKET
      35 #else
      36 typedef int fd_t;
      37 #define __TACOPIE_INVALID_FD -1
      38 #endif /* _WIN32 */
      39 
      41 #if defined(_MSC_VER)
      42 #include <BaseTsd.h>
      43 typedef SSIZE_T ssize_t;
      44 #endif
      45 
      46 }
      tacopie
      Definition: io_service.hpp:48
      diff --git a/docs/latex/annotated.tex b/docs/latex/annotated.tex index 1aea71c..e0673e5 100644 --- a/docs/latex/annotated.tex +++ b/docs/latex/annotated.tex @@ -11,7 +11,6 @@ \section{Class List} \item\contentsline{section}{\hyperlink{classtacopie_1_1tcp__server}{tacopie\+::tcp\+\_\+server} }{\pageref{classtacopie_1_1tcp__server}}{} \item\contentsline{section}{\hyperlink{classtacopie_1_1tcp__socket}{tacopie\+::tcp\+\_\+socket} }{\pageref{classtacopie_1_1tcp__socket}}{} \item\contentsline{section}{\hyperlink{classtacopie_1_1utils_1_1thread__pool}{tacopie\+::utils\+::thread\+\_\+pool} }{\pageref{classtacopie_1_1utils_1_1thread__pool}}{} -\item\contentsline{section}{\hyperlink{structtacopie_1_1io__service_1_1tracked__socket}{tacopie\+::io\+\_\+service\+::tracked\+\_\+socket} }{\pageref{structtacopie_1_1io__service_1_1tracked__socket}}{} \item\contentsline{section}{\hyperlink{structtacopie_1_1tcp__client_1_1write__request}{tacopie\+::tcp\+\_\+client\+::write\+\_\+request} }{\pageref{structtacopie_1_1tcp__client_1_1write__request}}{} \item\contentsline{section}{\hyperlink{structtacopie_1_1tcp__client_1_1write__result}{tacopie\+::tcp\+\_\+client\+::write\+\_\+result} }{\pageref{structtacopie_1_1tcp__client_1_1write__result}}{} \end{DoxyCompactList} diff --git a/docs/latex/classtacopie_1_1io__service.tex b/docs/latex/classtacopie_1_1io__service.tex index 2ed1f9e..9c7e6b2 100644 --- a/docs/latex/classtacopie_1_1io__service.tex +++ b/docs/latex/classtacopie_1_1io__service.tex @@ -4,75 +4,41 @@ {\ttfamily \#include $<$io\+\_\+service.\+hpp$>$} -\subsection*{Classes} -\begin{DoxyCompactItemize} -\item -struct \hyperlink{structtacopie_1_1io__service_1_1tracked__socket}{tracked\+\_\+socket} -\end{DoxyCompactItemize} \subsection*{Public Types} \begin{DoxyCompactItemize} \item -typedef std\+::function$<$ void(\hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t})$>$ \hyperlink{classtacopie_1_1io__service_abb66850c32d9c724f4418d77bd04bcfd}{event\+\_\+callback\+\_\+t} +typedef std\+::function$<$ void(fd\+\_\+t)$>$ \hyperlink{classtacopie_1_1io__service_abb66850c32d9c724f4418d77bd04bcfd}{event\+\_\+callback\+\_\+t} \end{DoxyCompactItemize} \subsection*{Public Member Functions} \begin{DoxyCompactItemize} \item -\hyperlink{classtacopie_1_1io__service_a62edde9b62571610413d99d075df8102}{io\+\_\+service} (std\+::size\+\_\+t nb\+\_\+threads=\hyperlink{io__service_8hpp_a822f465d034836ecbc765ad422eec064}{\+\_\+\+\_\+\+T\+A\+C\+O\+P\+I\+E\+\_\+\+I\+O\+\_\+\+S\+E\+R\+V\+I\+C\+E\+\_\+\+N\+B\+\_\+\+W\+O\+R\+K\+E\+RS}) +\hyperlink{classtacopie_1_1io__service_a62edde9b62571610413d99d075df8102}{io\+\_\+service} (std\+::size\+\_\+t nb\+\_\+threads=\+\_\+\+\_\+\+T\+A\+C\+O\+P\+I\+E\+\_\+\+I\+O\+\_\+\+S\+E\+R\+V\+I\+C\+E\+\_\+\+N\+B\+\_\+\+W\+O\+R\+K\+E\+RS) \item +\mbox{\Hypertarget{classtacopie_1_1io__service_ae423d7e4b13f07fe41fb051345ffbf8d}\label{classtacopie_1_1io__service_ae423d7e4b13f07fe41fb051345ffbf8d}} \hyperlink{classtacopie_1_1io__service_ae423d7e4b13f07fe41fb051345ffbf8d}{$\sim$io\+\_\+service} (void) \begin{DoxyCompactList}\small\item\em dtor \end{DoxyCompactList}\item +\mbox{\Hypertarget{classtacopie_1_1io__service_ad5da7503d8fec083c6d28455ec9e21c7}\label{classtacopie_1_1io__service_ad5da7503d8fec083c6d28455ec9e21c7}} \hyperlink{classtacopie_1_1io__service_ad5da7503d8fec083c6d28455ec9e21c7}{io\+\_\+service} (const \hyperlink{classtacopie_1_1io__service}{io\+\_\+service} \&)=delete \begin{DoxyCompactList}\small\item\em copy ctor \end{DoxyCompactList}\item +\mbox{\Hypertarget{classtacopie_1_1io__service_a980652008516b38357d405c16eda07fa}\label{classtacopie_1_1io__service_a980652008516b38357d405c16eda07fa}} \hyperlink{classtacopie_1_1io__service}{io\+\_\+service} \& \hyperlink{classtacopie_1_1io__service_a980652008516b38357d405c16eda07fa}{operator=} (const \hyperlink{classtacopie_1_1io__service}{io\+\_\+service} \&)=delete \begin{DoxyCompactList}\small\item\em assignment operator \end{DoxyCompactList}\item void \hyperlink{classtacopie_1_1io__service_a7e2b0700c0a4591f86c344df8748b3a5}{set\+\_\+nb\+\_\+workers} (std\+::size\+\_\+t nb\+\_\+threads) \item +\mbox{\Hypertarget{classtacopie_1_1io__service_a9f4c8bce3c0f6d660515b0b5eb109df8}\label{classtacopie_1_1io__service_a9f4c8bce3c0f6d660515b0b5eb109df8}} void \hyperlink{classtacopie_1_1io__service_a9f4c8bce3c0f6d660515b0b5eb109df8}{track} (const \hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&socket, const \hyperlink{classtacopie_1_1io__service_abb66850c32d9c724f4418d77bd04bcfd}{event\+\_\+callback\+\_\+t} \&rd\+\_\+callback=nullptr, const \hyperlink{classtacopie_1_1io__service_abb66850c32d9c724f4418d77bd04bcfd}{event\+\_\+callback\+\_\+t} \&wr\+\_\+callback=nullptr) \begin{DoxyCompactList}\small\item\em track \& untrack socket \end{DoxyCompactList}\item -void \hyperlink{classtacopie_1_1io__service_a8094c1fec76c6821cc0c008fe524c89a}{set\+\_\+rd\+\_\+callback} (const \hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&socket, const \hyperlink{classtacopie_1_1io__service_abb66850c32d9c724f4418d77bd04bcfd}{event\+\_\+callback\+\_\+t} \&event\+\_\+callback) +\mbox{\Hypertarget{classtacopie_1_1io__service_a8094c1fec76c6821cc0c008fe524c89a}\label{classtacopie_1_1io__service_a8094c1fec76c6821cc0c008fe524c89a}} +void {\bfseries set\+\_\+rd\+\_\+callback} (const \hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&socket, const \hyperlink{classtacopie_1_1io__service_abb66850c32d9c724f4418d77bd04bcfd}{event\+\_\+callback\+\_\+t} \&event\+\_\+callback) \item -void \hyperlink{classtacopie_1_1io__service_a7c4f56c7790c7ba52b09837a42aaffb1}{set\+\_\+wr\+\_\+callback} (const \hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&socket, const \hyperlink{classtacopie_1_1io__service_abb66850c32d9c724f4418d77bd04bcfd}{event\+\_\+callback\+\_\+t} \&event\+\_\+callback) +\mbox{\Hypertarget{classtacopie_1_1io__service_a7c4f56c7790c7ba52b09837a42aaffb1}\label{classtacopie_1_1io__service_a7c4f56c7790c7ba52b09837a42aaffb1}} +void {\bfseries set\+\_\+wr\+\_\+callback} (const \hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&socket, const \hyperlink{classtacopie_1_1io__service_abb66850c32d9c724f4418d77bd04bcfd}{event\+\_\+callback\+\_\+t} \&event\+\_\+callback) \item -void \hyperlink{classtacopie_1_1io__service_a9a7672f0894a0fc1a3e6c593ca6df22c}{untrack} (const \hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&socket) +\mbox{\Hypertarget{classtacopie_1_1io__service_a9a7672f0894a0fc1a3e6c593ca6df22c}\label{classtacopie_1_1io__service_a9a7672f0894a0fc1a3e6c593ca6df22c}} +void {\bfseries untrack} (const \hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&socket) \item void \hyperlink{classtacopie_1_1io__service_aa57db619baeaa6db0aeb22e67b895cd7}{wait\+\_\+for\+\_\+removal} (const \hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&socket) \end{DoxyCompactItemize} -\subsection*{Private Member Functions} -\begin{DoxyCompactItemize} -\item -void \hyperlink{classtacopie_1_1io__service_a03813e0e91d70d367f9fb0ff0d86d3dd}{poll} (void) -\item -int \hyperlink{classtacopie_1_1io__service_a7311358423dddd6a9d17c61b2c365ff8}{init\+\_\+poll\+\_\+fds\+\_\+info} (void) -\item -void \hyperlink{classtacopie_1_1io__service_a90a2ab7b6bbaf10bbc0607ce371cc806}{process\+\_\+events} (void) -\item -void \hyperlink{classtacopie_1_1io__service_a65c3ef9fa1473708b81b05029f6861f9}{process\+\_\+rd\+\_\+event} (const \hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t} \&fd, \hyperlink{structtacopie_1_1io__service_1_1tracked__socket}{tracked\+\_\+socket} \&socket) -\item -void \hyperlink{classtacopie_1_1io__service_a55e334cdf75187b9296c03447e32a63f}{process\+\_\+wr\+\_\+event} (const \hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t} \&fd, \hyperlink{structtacopie_1_1io__service_1_1tracked__socket}{tracked\+\_\+socket} \&socket) -\end{DoxyCompactItemize} -\subsection*{Private Attributes} -\begin{DoxyCompactItemize} -\item -std\+::unordered\+\_\+map$<$ \hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t}, \hyperlink{structtacopie_1_1io__service_1_1tracked__socket}{tracked\+\_\+socket} $>$ \hyperlink{classtacopie_1_1io__service_a49c9b0b992a1fe203975029f8557ad1a}{m\+\_\+tracked\+\_\+sockets} -\item -std\+::atomic$<$ bool $>$ \hyperlink{classtacopie_1_1io__service_a8d73334fcd84e31ccaada49f326d3463}{m\+\_\+should\+\_\+stop} -\item -std\+::thread \hyperlink{classtacopie_1_1io__service_a882b2211bae06c87cdf6e9c04d2cb783}{m\+\_\+poll\+\_\+worker} -\item -\hyperlink{classtacopie_1_1utils_1_1thread__pool}{utils\+::thread\+\_\+pool} \hyperlink{classtacopie_1_1io__service_ace8ecb6c752a0adb3b2fec1c92cf1161}{m\+\_\+callback\+\_\+workers} -\item -std\+::mutex \hyperlink{classtacopie_1_1io__service_af73671e872d70c6e7d1c856185b5ddd6}{m\+\_\+tracked\+\_\+sockets\+\_\+mtx} -\item -std\+::vector$<$ \hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t} $>$ \hyperlink{classtacopie_1_1io__service_a5a505f908c39c88e19f092c603f29261}{m\+\_\+polled\+\_\+fds} -\item -fd\+\_\+set \hyperlink{classtacopie_1_1io__service_a1d4388ceffa22976892ac5de95936f58}{m\+\_\+rd\+\_\+set} -\item -fd\+\_\+set \hyperlink{classtacopie_1_1io__service_afca4de707285a1a373751e7e10b413ff}{m\+\_\+wr\+\_\+set} -\item -std\+::condition\+\_\+variable \hyperlink{classtacopie_1_1io__service_ab48cce92a369604bf3409ebbbd6d345d}{m\+\_\+wait\+\_\+for\+\_\+removal\+\_\+condvar} -\item -\hyperlink{classtacopie_1_1self__pipe}{tacopie\+::self\+\_\+pipe} \hyperlink{classtacopie_1_1io__service_ae8a17523ba4719b0e799d1c5d665e69f}{m\+\_\+notifier} -\end{DoxyCompactItemize} \subsection{Detailed Description} @@ -83,7 +49,7 @@ \subsection{Member Typedef Documentation} \index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!event\+\_\+callback\+\_\+t@{event\+\_\+callback\+\_\+t}} \index{event\+\_\+callback\+\_\+t@{event\+\_\+callback\+\_\+t}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} \subsubsection{\texorpdfstring{event\+\_\+callback\+\_\+t}{event\_callback\_t}} -{\footnotesize\ttfamily typedef std\+::function$<$void(\hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t})$>$ \hyperlink{classtacopie_1_1io__service_abb66850c32d9c724f4418d77bd04bcfd}{tacopie\+::io\+\_\+service\+::event\+\_\+callback\+\_\+t}} +{\footnotesize\ttfamily typedef std\+::function$<$void(fd\+\_\+t)$>$ \hyperlink{classtacopie_1_1io__service_abb66850c32d9c724f4418d77bd04bcfd}{tacopie\+::io\+\_\+service\+::event\+\_\+callback\+\_\+t}} callback handler typedef called on new socket event if register to \hyperlink{classtacopie_1_1io__service}{io\+\_\+service} @@ -91,8 +57,8 @@ \subsection{Constructor \& Destructor Documentation} \mbox{\Hypertarget{classtacopie_1_1io__service_a62edde9b62571610413d99d075df8102}\label{classtacopie_1_1io__service_a62edde9b62571610413d99d075df8102}} \index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!io\+\_\+service@{io\+\_\+service}} \index{io\+\_\+service@{io\+\_\+service}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{io\+\_\+service()}{io\_service()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily tacopie\+::io\+\_\+service\+::io\+\_\+service (\begin{DoxyParamCaption}\item[{std\+::size\+\_\+t}]{nb\+\_\+threads = {\ttfamily \hyperlink{io__service_8hpp_a822f465d034836ecbc765ad422eec064}{\+\_\+\+\_\+\+T\+A\+C\+O\+P\+I\+E\+\_\+\+I\+O\+\_\+\+S\+E\+R\+V\+I\+C\+E\+\_\+\+N\+B\+\_\+\+W\+O\+R\+K\+E\+RS}} }\end{DoxyParamCaption})} +\subsubsection{\texorpdfstring{io\+\_\+service()}{io\_service()}} +{\footnotesize\ttfamily tacopie\+::io\+\_\+service\+::io\+\_\+service (\begin{DoxyParamCaption}\item[{std\+::size\+\_\+t}]{nb\+\_\+threads = {\ttfamily \+\_\+\+\_\+TACOPIE\+\_\+IO\+\_\+SERVICE\+\_\+NB\+\_\+WORKERS} }\end{DoxyParamCaption})} ctor @@ -101,92 +67,9 @@ \subsubsection{\texorpdfstring{io\+\_\+service()}{io\_service()}\hspace{0.1cm}{\ {\em nb\+\_\+threads} & defines the number of background threads that will be used to process read and write callbacks. This must be a strictly positive value. \\ \hline \end{DoxyParams} -\mbox{\Hypertarget{classtacopie_1_1io__service_ae423d7e4b13f07fe41fb051345ffbf8d}\label{classtacopie_1_1io__service_ae423d7e4b13f07fe41fb051345ffbf8d}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!````~io\+\_\+service@{$\sim$io\+\_\+service}} -\index{````~io\+\_\+service@{$\sim$io\+\_\+service}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{$\sim$io\+\_\+service()}{~io\_service()}} -{\footnotesize\ttfamily tacopie\+::io\+\_\+service\+::$\sim$io\+\_\+service (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - - - -dtor - -\mbox{\Hypertarget{classtacopie_1_1io__service_ad5da7503d8fec083c6d28455ec9e21c7}\label{classtacopie_1_1io__service_ad5da7503d8fec083c6d28455ec9e21c7}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!io\+\_\+service@{io\+\_\+service}} -\index{io\+\_\+service@{io\+\_\+service}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{io\+\_\+service()}{io\_service()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily tacopie\+::io\+\_\+service\+::io\+\_\+service (\begin{DoxyParamCaption}\item[{const \hyperlink{classtacopie_1_1io__service}{io\+\_\+service} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [delete]}} - - - -copy ctor - \subsection{Member Function Documentation} -\mbox{\Hypertarget{classtacopie_1_1io__service_a7311358423dddd6a9d17c61b2c365ff8}\label{classtacopie_1_1io__service_a7311358423dddd6a9d17c61b2c365ff8}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!init\+\_\+poll\+\_\+fds\+\_\+info@{init\+\_\+poll\+\_\+fds\+\_\+info}} -\index{init\+\_\+poll\+\_\+fds\+\_\+info@{init\+\_\+poll\+\_\+fds\+\_\+info}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{init\+\_\+poll\+\_\+fds\+\_\+info()}{init\_poll\_fds\_info()}} -{\footnotesize\ttfamily int tacopie\+::io\+\_\+service\+::init\+\_\+poll\+\_\+fds\+\_\+info (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} - -init m\+\_\+poll\+\_\+fds\+\_\+info simply initialize m\+\_\+polled\+\_\+fds variable based on m\+\_\+tracked\+\_\+sockets information - -\begin{DoxyReturn}{Returns} -maximum fd value polled -\end{DoxyReturn} -\mbox{\Hypertarget{classtacopie_1_1io__service_a980652008516b38357d405c16eda07fa}\label{classtacopie_1_1io__service_a980652008516b38357d405c16eda07fa}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!operator=@{operator=}} -\index{operator=@{operator=}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{operator=()}{operator=()}} -{\footnotesize\ttfamily \hyperlink{classtacopie_1_1io__service}{io\+\_\+service}\& tacopie\+::io\+\_\+service\+::operator= (\begin{DoxyParamCaption}\item[{const \hyperlink{classtacopie_1_1io__service}{io\+\_\+service} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [delete]}} - - - -assignment operator - -\mbox{\Hypertarget{classtacopie_1_1io__service_a03813e0e91d70d367f9fb0ff0d86d3dd}\label{classtacopie_1_1io__service_a03813e0e91d70d367f9fb0ff0d86d3dd}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!poll@{poll}} -\index{poll@{poll}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{poll()}{poll()}} -{\footnotesize\ttfamily void tacopie\+::io\+\_\+service\+::poll (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} - -poll worker function main loop of the background thread in charge of the \hyperlink{classtacopie_1_1io__service}{io\+\_\+service} in charge of polling fds \mbox{\Hypertarget{classtacopie_1_1io__service_a90a2ab7b6bbaf10bbc0607ce371cc806}\label{classtacopie_1_1io__service_a90a2ab7b6bbaf10bbc0607ce371cc806}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!process\+\_\+events@{process\+\_\+events}} -\index{process\+\_\+events@{process\+\_\+events}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{process\+\_\+events()}{process\_events()}} -{\footnotesize\ttfamily void tacopie\+::io\+\_\+service\+::process\+\_\+events (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} - -process poll detected events called whenever select/poll completed to check read and write availablity \mbox{\Hypertarget{classtacopie_1_1io__service_a65c3ef9fa1473708b81b05029f6861f9}\label{classtacopie_1_1io__service_a65c3ef9fa1473708b81b05029f6861f9}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!process\+\_\+rd\+\_\+event@{process\+\_\+rd\+\_\+event}} -\index{process\+\_\+rd\+\_\+event@{process\+\_\+rd\+\_\+event}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{process\+\_\+rd\+\_\+event()}{process\_rd\_event()}} -{\footnotesize\ttfamily void tacopie\+::io\+\_\+service\+::process\+\_\+rd\+\_\+event (\begin{DoxyParamCaption}\item[{const \hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t} \&}]{fd, }\item[{\hyperlink{structtacopie_1_1io__service_1_1tracked__socket}{tracked\+\_\+socket} \&}]{socket }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} - -process read event reported by select/poll for a given socket - - -\begin{DoxyParams}{Parameters} -{\em fd} & fd for which a read event has been reported \\ -\hline -{\em socket} & \hyperlink{structtacopie_1_1io__service_1_1tracked__socket}{tracked\+\_\+socket} associated to the given fd \\ -\hline -\end{DoxyParams} -\mbox{\Hypertarget{classtacopie_1_1io__service_a55e334cdf75187b9296c03447e32a63f}\label{classtacopie_1_1io__service_a55e334cdf75187b9296c03447e32a63f}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!process\+\_\+wr\+\_\+event@{process\+\_\+wr\+\_\+event}} -\index{process\+\_\+wr\+\_\+event@{process\+\_\+wr\+\_\+event}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{process\+\_\+wr\+\_\+event()}{process\_wr\_event()}} -{\footnotesize\ttfamily void tacopie\+::io\+\_\+service\+::process\+\_\+wr\+\_\+event (\begin{DoxyParamCaption}\item[{const \hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t} \&}]{fd, }\item[{\hyperlink{structtacopie_1_1io__service_1_1tracked__socket}{tracked\+\_\+socket} \&}]{socket }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} - -process write event reported by select/poll for a given socket - - -\begin{DoxyParams}{Parameters} -{\em fd} & fd for which a write event has been reported \\ -\hline -{\em socket} & \hyperlink{structtacopie_1_1io__service_1_1tracked__socket}{tracked\+\_\+socket} associated to the given fd \\ -\hline -\end{DoxyParams} \mbox{\Hypertarget{classtacopie_1_1io__service_a7e2b0700c0a4591f86c344df8748b3a5}\label{classtacopie_1_1io__service_a7e2b0700c0a4591f86c344df8748b3a5}} \index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!set\+\_\+nb\+\_\+workers@{set\+\_\+nb\+\_\+workers}} \index{set\+\_\+nb\+\_\+workers@{set\+\_\+nb\+\_\+workers}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} @@ -200,34 +83,6 @@ \subsubsection{\texorpdfstring{set\+\_\+nb\+\_\+workers()}{set\_nb\_workers()}} {\em nb\+\_\+threads} & number of workers \\ \hline \end{DoxyParams} -\mbox{\Hypertarget{classtacopie_1_1io__service_a8094c1fec76c6821cc0c008fe524c89a}\label{classtacopie_1_1io__service_a8094c1fec76c6821cc0c008fe524c89a}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!set\+\_\+rd\+\_\+callback@{set\+\_\+rd\+\_\+callback}} -\index{set\+\_\+rd\+\_\+callback@{set\+\_\+rd\+\_\+callback}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{set\+\_\+rd\+\_\+callback()}{set\_rd\_callback()}} -{\footnotesize\ttfamily void tacopie\+::io\+\_\+service\+::set\+\_\+rd\+\_\+callback (\begin{DoxyParamCaption}\item[{const \hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&}]{socket, }\item[{const \hyperlink{classtacopie_1_1io__service_abb66850c32d9c724f4418d77bd04bcfd}{event\+\_\+callback\+\_\+t} \&}]{event\+\_\+callback }\end{DoxyParamCaption})} - -\mbox{\Hypertarget{classtacopie_1_1io__service_a7c4f56c7790c7ba52b09837a42aaffb1}\label{classtacopie_1_1io__service_a7c4f56c7790c7ba52b09837a42aaffb1}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!set\+\_\+wr\+\_\+callback@{set\+\_\+wr\+\_\+callback}} -\index{set\+\_\+wr\+\_\+callback@{set\+\_\+wr\+\_\+callback}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{set\+\_\+wr\+\_\+callback()}{set\_wr\_callback()}} -{\footnotesize\ttfamily void tacopie\+::io\+\_\+service\+::set\+\_\+wr\+\_\+callback (\begin{DoxyParamCaption}\item[{const \hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&}]{socket, }\item[{const \hyperlink{classtacopie_1_1io__service_abb66850c32d9c724f4418d77bd04bcfd}{event\+\_\+callback\+\_\+t} \&}]{event\+\_\+callback }\end{DoxyParamCaption})} - -\mbox{\Hypertarget{classtacopie_1_1io__service_a9f4c8bce3c0f6d660515b0b5eb109df8}\label{classtacopie_1_1io__service_a9f4c8bce3c0f6d660515b0b5eb109df8}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!track@{track}} -\index{track@{track}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{track()}{track()}} -{\footnotesize\ttfamily void tacopie\+::io\+\_\+service\+::track (\begin{DoxyParamCaption}\item[{const \hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&}]{socket, }\item[{const \hyperlink{classtacopie_1_1io__service_abb66850c32d9c724f4418d77bd04bcfd}{event\+\_\+callback\+\_\+t} \&}]{rd\+\_\+callback = {\ttfamily nullptr}, }\item[{const \hyperlink{classtacopie_1_1io__service_abb66850c32d9c724f4418d77bd04bcfd}{event\+\_\+callback\+\_\+t} \&}]{wr\+\_\+callback = {\ttfamily nullptr} }\end{DoxyParamCaption})} - - - -track \& untrack socket - -\mbox{\Hypertarget{classtacopie_1_1io__service_a9a7672f0894a0fc1a3e6c593ca6df22c}\label{classtacopie_1_1io__service_a9a7672f0894a0fc1a3e6c593ca6df22c}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!untrack@{untrack}} -\index{untrack@{untrack}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{untrack()}{untrack()}} -{\footnotesize\ttfamily void tacopie\+::io\+\_\+service\+::untrack (\begin{DoxyParamCaption}\item[{const \hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&}]{socket }\end{DoxyParamCaption})} - \mbox{\Hypertarget{classtacopie_1_1io__service_aa57db619baeaa6db0aeb22e67b895cd7}\label{classtacopie_1_1io__service_aa57db619baeaa6db0aeb22e67b895cd7}} \index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!wait\+\_\+for\+\_\+removal@{wait\+\_\+for\+\_\+removal}} \index{wait\+\_\+for\+\_\+removal@{wait\+\_\+for\+\_\+removal}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} @@ -236,69 +91,6 @@ \subsubsection{\texorpdfstring{wait\+\_\+for\+\_\+removal()}{wait\_for\_removal( wait until the socket has been effectively removed basically wait until all pending callbacks are executed -\subsection{Member Data Documentation} -\mbox{\Hypertarget{classtacopie_1_1io__service_ace8ecb6c752a0adb3b2fec1c92cf1161}\label{classtacopie_1_1io__service_ace8ecb6c752a0adb3b2fec1c92cf1161}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!m\+\_\+callback\+\_\+workers@{m\+\_\+callback\+\_\+workers}} -\index{m\+\_\+callback\+\_\+workers@{m\+\_\+callback\+\_\+workers}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{m\+\_\+callback\+\_\+workers}{m\_callback\_workers}} -{\footnotesize\ttfamily \hyperlink{classtacopie_1_1utils_1_1thread__pool}{utils\+::thread\+\_\+pool} tacopie\+::io\+\_\+service\+::m\+\_\+callback\+\_\+workers\hspace{0.3cm}{\ttfamily [private]}} - -callback workers \mbox{\Hypertarget{classtacopie_1_1io__service_ae8a17523ba4719b0e799d1c5d665e69f}\label{classtacopie_1_1io__service_ae8a17523ba4719b0e799d1c5d665e69f}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!m\+\_\+notifier@{m\+\_\+notifier}} -\index{m\+\_\+notifier@{m\+\_\+notifier}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{m\+\_\+notifier}{m\_notifier}} -{\footnotesize\ttfamily \hyperlink{classtacopie_1_1self__pipe}{tacopie\+::self\+\_\+pipe} tacopie\+::io\+\_\+service\+::m\+\_\+notifier\hspace{0.3cm}{\ttfamily [private]}} - -fd associated to the pipe used to wake up the poll call \mbox{\Hypertarget{classtacopie_1_1io__service_a882b2211bae06c87cdf6e9c04d2cb783}\label{classtacopie_1_1io__service_a882b2211bae06c87cdf6e9c04d2cb783}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!m\+\_\+poll\+\_\+worker@{m\+\_\+poll\+\_\+worker}} -\index{m\+\_\+poll\+\_\+worker@{m\+\_\+poll\+\_\+worker}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{m\+\_\+poll\+\_\+worker}{m\_poll\_worker}} -{\footnotesize\ttfamily std\+::thread tacopie\+::io\+\_\+service\+::m\+\_\+poll\+\_\+worker\hspace{0.3cm}{\ttfamily [private]}} - -poll thread \mbox{\Hypertarget{classtacopie_1_1io__service_a5a505f908c39c88e19f092c603f29261}\label{classtacopie_1_1io__service_a5a505f908c39c88e19f092c603f29261}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!m\+\_\+polled\+\_\+fds@{m\+\_\+polled\+\_\+fds}} -\index{m\+\_\+polled\+\_\+fds@{m\+\_\+polled\+\_\+fds}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{m\+\_\+polled\+\_\+fds}{m\_polled\_fds}} -{\footnotesize\ttfamily std\+::vector$<$\hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t}$>$ tacopie\+::io\+\_\+service\+::m\+\_\+polled\+\_\+fds\hspace{0.3cm}{\ttfamily [private]}} - -data structure given to select (list of fds to poll) \mbox{\Hypertarget{classtacopie_1_1io__service_a1d4388ceffa22976892ac5de95936f58}\label{classtacopie_1_1io__service_a1d4388ceffa22976892ac5de95936f58}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!m\+\_\+rd\+\_\+set@{m\+\_\+rd\+\_\+set}} -\index{m\+\_\+rd\+\_\+set@{m\+\_\+rd\+\_\+set}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{m\+\_\+rd\+\_\+set}{m\_rd\_set}} -{\footnotesize\ttfamily fd\+\_\+set tacopie\+::io\+\_\+service\+::m\+\_\+rd\+\_\+set\hspace{0.3cm}{\ttfamily [private]}} - -data structure given to select (list of fds to poll for read) \mbox{\Hypertarget{classtacopie_1_1io__service_a8d73334fcd84e31ccaada49f326d3463}\label{classtacopie_1_1io__service_a8d73334fcd84e31ccaada49f326d3463}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!m\+\_\+should\+\_\+stop@{m\+\_\+should\+\_\+stop}} -\index{m\+\_\+should\+\_\+stop@{m\+\_\+should\+\_\+stop}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{m\+\_\+should\+\_\+stop}{m\_should\_stop}} -{\footnotesize\ttfamily std\+::atomic$<$bool$>$ tacopie\+::io\+\_\+service\+::m\+\_\+should\+\_\+stop\hspace{0.3cm}{\ttfamily [private]}} - -whether the worker should stop or not \mbox{\Hypertarget{classtacopie_1_1io__service_a49c9b0b992a1fe203975029f8557ad1a}\label{classtacopie_1_1io__service_a49c9b0b992a1fe203975029f8557ad1a}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!m\+\_\+tracked\+\_\+sockets@{m\+\_\+tracked\+\_\+sockets}} -\index{m\+\_\+tracked\+\_\+sockets@{m\+\_\+tracked\+\_\+sockets}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{m\+\_\+tracked\+\_\+sockets}{m\_tracked\_sockets}} -{\footnotesize\ttfamily std\+::unordered\+\_\+map$<$\hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t}, \hyperlink{structtacopie_1_1io__service_1_1tracked__socket}{tracked\+\_\+socket}$>$ tacopie\+::io\+\_\+service\+::m\+\_\+tracked\+\_\+sockets\hspace{0.3cm}{\ttfamily [private]}} - -tracked sockets \mbox{\Hypertarget{classtacopie_1_1io__service_af73671e872d70c6e7d1c856185b5ddd6}\label{classtacopie_1_1io__service_af73671e872d70c6e7d1c856185b5ddd6}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!m\+\_\+tracked\+\_\+sockets\+\_\+mtx@{m\+\_\+tracked\+\_\+sockets\+\_\+mtx}} -\index{m\+\_\+tracked\+\_\+sockets\+\_\+mtx@{m\+\_\+tracked\+\_\+sockets\+\_\+mtx}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{m\+\_\+tracked\+\_\+sockets\+\_\+mtx}{m\_tracked\_sockets\_mtx}} -{\footnotesize\ttfamily std\+::mutex tacopie\+::io\+\_\+service\+::m\+\_\+tracked\+\_\+sockets\+\_\+mtx\hspace{0.3cm}{\ttfamily [private]}} - -thread safety \mbox{\Hypertarget{classtacopie_1_1io__service_ab48cce92a369604bf3409ebbbd6d345d}\label{classtacopie_1_1io__service_ab48cce92a369604bf3409ebbbd6d345d}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!m\+\_\+wait\+\_\+for\+\_\+removal\+\_\+condvar@{m\+\_\+wait\+\_\+for\+\_\+removal\+\_\+condvar}} -\index{m\+\_\+wait\+\_\+for\+\_\+removal\+\_\+condvar@{m\+\_\+wait\+\_\+for\+\_\+removal\+\_\+condvar}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{m\+\_\+wait\+\_\+for\+\_\+removal\+\_\+condvar}{m\_wait\_for\_removal\_condvar}} -{\footnotesize\ttfamily std\+::condition\+\_\+variable tacopie\+::io\+\_\+service\+::m\+\_\+wait\+\_\+for\+\_\+removal\+\_\+condvar\hspace{0.3cm}{\ttfamily [private]}} - -condition variable to wait on removal \mbox{\Hypertarget{classtacopie_1_1io__service_afca4de707285a1a373751e7e10b413ff}\label{classtacopie_1_1io__service_afca4de707285a1a373751e7e10b413ff}} -\index{tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}!m\+\_\+wr\+\_\+set@{m\+\_\+wr\+\_\+set}} -\index{m\+\_\+wr\+\_\+set@{m\+\_\+wr\+\_\+set}!tacopie\+::io\+\_\+service@{tacopie\+::io\+\_\+service}} -\subsubsection{\texorpdfstring{m\+\_\+wr\+\_\+set}{m\_wr\_set}} -{\footnotesize\ttfamily fd\+\_\+set tacopie\+::io\+\_\+service\+::m\+\_\+wr\+\_\+set\hspace{0.3cm}{\ttfamily [private]}} - -data structure given to select (list of fds to poll for write) - The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize} \item -includes/tacopie/network/\hyperlink{io__service_8hpp}{io\+\_\+service.\+hpp}\end{DoxyCompactItemize} +includes/tacopie/network/io\+\_\+service.\+hpp\end{DoxyCompactItemize} diff --git a/docs/latex/classtacopie_1_1logger.pdf b/docs/latex/classtacopie_1_1logger.pdf index 2caae9194c4323f8112823591b81dabe813ad3c8..73363a66115627d2b96ec280e5ba62d3484ac196 100644 GIT binary patch delta 297 zcmbQNHd$>$1`n@gilKqIp^2GpN}{p(WIaCl$y0c;Fhmt5Yx7$18JUI{T3VT!TbWvD z8yHP4=G8?PTE|{KNxk5Obsnf&A~RP8yKi-a_Rf#r?@1R zq-wZW85tOw8(1Q#*sLZvfic$9%-F!h%+b=x(a^-w!pO|c#MIQuz{1JE+0n_^z}3Lc hhM$1`n@AikV@OX`-cWim9RDWIaCl$y0c;Fhmt5Yx7$18CrxG8CsbbS(%#Z z8kkQm=G8?PTE|{KNxilEsP9JjKDUi8yKi-a_Rf#r?@1R zq-wZW85tOw8(1Q#*sLZvfic#^z}3>++0oL_+1SF!(!$Nn*wMt$)ydJw(a_b*)X2=v hhMGr)Xmb($impw%*@Qu)Wp!lz|_gr(8AQt LhLDQM|AeFgA}&Ld diff --git a/docs/latex/classtacopie_1_1logger__iface.tex b/docs/latex/classtacopie_1_1logger__iface.tex index 1b49eeb..d1927e1 100644 --- a/docs/latex/classtacopie_1_1logger__iface.tex +++ b/docs/latex/classtacopie_1_1logger__iface.tex @@ -13,12 +13,16 @@ \subsection*{Public Member Functions} \begin{DoxyCompactItemize} \item +\mbox{\Hypertarget{classtacopie_1_1logger__iface_afccf838f815d168e82e4722e2c4d0d90}\label{classtacopie_1_1logger__iface_afccf838f815d168e82e4722e2c4d0d90}} \hyperlink{classtacopie_1_1logger__iface_afccf838f815d168e82e4722e2c4d0d90}{logger\+\_\+iface} (void)=default \begin{DoxyCompactList}\small\item\em ctor \end{DoxyCompactList}\item +\mbox{\Hypertarget{classtacopie_1_1logger__iface_a562dcc605198ca90904ba21fa98eb6ea}\label{classtacopie_1_1logger__iface_a562dcc605198ca90904ba21fa98eb6ea}} virtual \hyperlink{classtacopie_1_1logger__iface_a562dcc605198ca90904ba21fa98eb6ea}{$\sim$logger\+\_\+iface} (void)=default \begin{DoxyCompactList}\small\item\em dtor \end{DoxyCompactList}\item +\mbox{\Hypertarget{classtacopie_1_1logger__iface_a34fb7873b2c5e908afd2d4a0d4965ec1}\label{classtacopie_1_1logger__iface_a34fb7873b2c5e908afd2d4a0d4965ec1}} \hyperlink{classtacopie_1_1logger__iface_a34fb7873b2c5e908afd2d4a0d4965ec1}{logger\+\_\+iface} (const \hyperlink{classtacopie_1_1logger__iface}{logger\+\_\+iface} \&)=default \begin{DoxyCompactList}\small\item\em copy ctor \end{DoxyCompactList}\item +\mbox{\Hypertarget{classtacopie_1_1logger__iface_ac3ca89b7c5d227b8ed3a5adaa5b72527}\label{classtacopie_1_1logger__iface_ac3ca89b7c5d227b8ed3a5adaa5b72527}} \hyperlink{classtacopie_1_1logger__iface}{logger\+\_\+iface} \& \hyperlink{classtacopie_1_1logger__iface_ac3ca89b7c5d227b8ed3a5adaa5b72527}{operator=} (const \hyperlink{classtacopie_1_1logger__iface}{logger\+\_\+iface} \&)=default \begin{DoxyCompactList}\small\item\em assignment operator \end{DoxyCompactList}\item virtual void \hyperlink{classtacopie_1_1logger__iface_a156abb02ab852ea4033fc13f4902ee7a}{debug} (const std\+::string \&msg, const std\+::string \&file, std\+::size\+\_\+t line)=0 @@ -34,39 +38,6 @@ \subsection*{Public Member Functions} \subsection{Detailed Description} \hyperlink{classtacopie_1_1logger__iface}{logger\+\_\+iface} should be inherited by any class intended to be used for logging -\subsection{Constructor \& Destructor Documentation} -\mbox{\Hypertarget{classtacopie_1_1logger__iface_afccf838f815d168e82e4722e2c4d0d90}\label{classtacopie_1_1logger__iface_afccf838f815d168e82e4722e2c4d0d90}} -\index{tacopie\+::logger\+\_\+iface@{tacopie\+::logger\+\_\+iface}!logger\+\_\+iface@{logger\+\_\+iface}} -\index{logger\+\_\+iface@{logger\+\_\+iface}!tacopie\+::logger\+\_\+iface@{tacopie\+::logger\+\_\+iface}} -\subsubsection{\texorpdfstring{logger\+\_\+iface()}{logger\_iface()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily tacopie\+::logger\+\_\+iface\+::logger\+\_\+iface (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [default]}} - - - -ctor - -\mbox{\Hypertarget{classtacopie_1_1logger__iface_a562dcc605198ca90904ba21fa98eb6ea}\label{classtacopie_1_1logger__iface_a562dcc605198ca90904ba21fa98eb6ea}} -\index{tacopie\+::logger\+\_\+iface@{tacopie\+::logger\+\_\+iface}!````~logger\+\_\+iface@{$\sim$logger\+\_\+iface}} -\index{````~logger\+\_\+iface@{$\sim$logger\+\_\+iface}!tacopie\+::logger\+\_\+iface@{tacopie\+::logger\+\_\+iface}} -\subsubsection{\texorpdfstring{$\sim$logger\+\_\+iface()}{~logger\_iface()}} -{\footnotesize\ttfamily virtual tacopie\+::logger\+\_\+iface\+::$\sim$logger\+\_\+iface (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [default]}} - - - -dtor - -\mbox{\Hypertarget{classtacopie_1_1logger__iface_a34fb7873b2c5e908afd2d4a0d4965ec1}\label{classtacopie_1_1logger__iface_a34fb7873b2c5e908afd2d4a0d4965ec1}} -\index{tacopie\+::logger\+\_\+iface@{tacopie\+::logger\+\_\+iface}!logger\+\_\+iface@{logger\+\_\+iface}} -\index{logger\+\_\+iface@{logger\+\_\+iface}!tacopie\+::logger\+\_\+iface@{tacopie\+::logger\+\_\+iface}} -\subsubsection{\texorpdfstring{logger\+\_\+iface()}{logger\_iface()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily tacopie\+::logger\+\_\+iface\+::logger\+\_\+iface (\begin{DoxyParamCaption}\item[{const \hyperlink{classtacopie_1_1logger__iface}{logger\+\_\+iface} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [default]}} - - - -copy ctor - - - \subsection{Member Function Documentation} \mbox{\Hypertarget{classtacopie_1_1logger__iface_a156abb02ab852ea4033fc13f4902ee7a}\label{classtacopie_1_1logger__iface_a156abb02ab852ea4033fc13f4902ee7a}} \index{tacopie\+::logger\+\_\+iface@{tacopie\+::logger\+\_\+iface}!debug@{debug}} @@ -131,16 +102,6 @@ \subsubsection{\texorpdfstring{info()}{info()}} Implemented in \hyperlink{classtacopie_1_1logger_a5089c5a6127586d4f2ea3a69a0bf6570}{tacopie\+::logger}. -\mbox{\Hypertarget{classtacopie_1_1logger__iface_ac3ca89b7c5d227b8ed3a5adaa5b72527}\label{classtacopie_1_1logger__iface_ac3ca89b7c5d227b8ed3a5adaa5b72527}} -\index{tacopie\+::logger\+\_\+iface@{tacopie\+::logger\+\_\+iface}!operator=@{operator=}} -\index{operator=@{operator=}!tacopie\+::logger\+\_\+iface@{tacopie\+::logger\+\_\+iface}} -\subsubsection{\texorpdfstring{operator=()}{operator=()}} -{\footnotesize\ttfamily \hyperlink{classtacopie_1_1logger__iface}{logger\+\_\+iface}\& tacopie\+::logger\+\_\+iface\+::operator= (\begin{DoxyParamCaption}\item[{const \hyperlink{classtacopie_1_1logger__iface}{logger\+\_\+iface} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [default]}} - - - -assignment operator - \mbox{\Hypertarget{classtacopie_1_1logger__iface_ab96d8f6bc2e2b514c7ceec4c856f8921}\label{classtacopie_1_1logger__iface_ab96d8f6bc2e2b514c7ceec4c856f8921}} \index{tacopie\+::logger\+\_\+iface@{tacopie\+::logger\+\_\+iface}!warn@{warn}} \index{warn@{warn}!tacopie\+::logger\+\_\+iface@{tacopie\+::logger\+\_\+iface}} @@ -166,4 +127,4 @@ \subsubsection{\texorpdfstring{warn()}{warn()}} The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize} \item -includes/tacopie/utils/\hyperlink{logger_8hpp}{logger.\+hpp}\end{DoxyCompactItemize} +includes/tacopie/utils/logger.\+hpp\end{DoxyCompactItemize} diff --git a/docs/latex/classtacopie_1_1self__pipe.tex b/docs/latex/classtacopie_1_1self__pipe.tex index 4d0e91f..7504e13 100644 --- a/docs/latex/classtacopie_1_1self__pipe.tex +++ b/docs/latex/classtacopie_1_1self__pipe.tex @@ -1,66 +1,28 @@ \hypertarget{classtacopie_1_1self__pipe}{}\section{tacopie\+:\+:self\+\_\+pipe Class Reference} \label{classtacopie_1_1self__pipe}\index{tacopie\+::self\+\_\+pipe@{tacopie\+::self\+\_\+pipe}} - - -{\ttfamily \#include $<$self\+\_\+pipe.\+hpp$>$} - \subsection*{Public Member Functions} \begin{DoxyCompactItemize} \item +\mbox{\Hypertarget{classtacopie_1_1self__pipe_add8d2c43863d1505e6851789ab5d9b97}\label{classtacopie_1_1self__pipe_add8d2c43863d1505e6851789ab5d9b97}} \hyperlink{classtacopie_1_1self__pipe_add8d2c43863d1505e6851789ab5d9b97}{self\+\_\+pipe} (void) \begin{DoxyCompactList}\small\item\em ctor \end{DoxyCompactList}\item +\mbox{\Hypertarget{classtacopie_1_1self__pipe_a10a6c4b0d67a4a14abea397a05cee54c}\label{classtacopie_1_1self__pipe_a10a6c4b0d67a4a14abea397a05cee54c}} \hyperlink{classtacopie_1_1self__pipe_a10a6c4b0d67a4a14abea397a05cee54c}{$\sim$self\+\_\+pipe} (void) \begin{DoxyCompactList}\small\item\em dtor \end{DoxyCompactList}\item +\mbox{\Hypertarget{classtacopie_1_1self__pipe_a09ffc77b89ad48bc8db6635108c68b6b}\label{classtacopie_1_1self__pipe_a09ffc77b89ad48bc8db6635108c68b6b}} \hyperlink{classtacopie_1_1self__pipe_a09ffc77b89ad48bc8db6635108c68b6b}{self\+\_\+pipe} (const \hyperlink{classtacopie_1_1self__pipe}{self\+\_\+pipe} \&)=delete \begin{DoxyCompactList}\small\item\em copy ctor \end{DoxyCompactList}\item +\mbox{\Hypertarget{classtacopie_1_1self__pipe_a14e0fa3a880b6c9559c087eac480c518}\label{classtacopie_1_1self__pipe_a14e0fa3a880b6c9559c087eac480c518}} \hyperlink{classtacopie_1_1self__pipe}{self\+\_\+pipe} \& \hyperlink{classtacopie_1_1self__pipe_a14e0fa3a880b6c9559c087eac480c518}{operator=} (const \hyperlink{classtacopie_1_1self__pipe}{self\+\_\+pipe} \&)=delete \begin{DoxyCompactList}\small\item\em assignment operator \end{DoxyCompactList}\item -\hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t} \hyperlink{classtacopie_1_1self__pipe_a301b416f5f8236a383065b381385b88c}{get\+\_\+read\+\_\+fd} (void) const +fd\+\_\+t \hyperlink{classtacopie_1_1self__pipe_a301b416f5f8236a383065b381385b88c}{get\+\_\+read\+\_\+fd} (void) const \item -\hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t} \hyperlink{classtacopie_1_1self__pipe_ab36a4deb45bb408988f26315aedc0d74}{get\+\_\+write\+\_\+fd} (void) const +fd\+\_\+t \hyperlink{classtacopie_1_1self__pipe_ab36a4deb45bb408988f26315aedc0d74}{get\+\_\+write\+\_\+fd} (void) const \item void \hyperlink{classtacopie_1_1self__pipe_ade9e0e3d19b8d4d22977935a578d508e}{notify} (void) \item void \hyperlink{classtacopie_1_1self__pipe_a4f55a34bd882d59bdcc73b87222ba3d8}{clr\+\_\+buffer} (void) \end{DoxyCompactItemize} -\subsection*{Private Attributes} -\begin{DoxyCompactItemize} -\item -\hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t} \hyperlink{classtacopie_1_1self__pipe_a3e562cfb5ffdd3a8bc6a7c28eca2b7af}{m\+\_\+fds} \mbox{[}2\mbox{]} -\end{DoxyCompactItemize} - - -\subsection{Constructor \& Destructor Documentation} -\mbox{\Hypertarget{classtacopie_1_1self__pipe_add8d2c43863d1505e6851789ab5d9b97}\label{classtacopie_1_1self__pipe_add8d2c43863d1505e6851789ab5d9b97}} -\index{tacopie\+::self\+\_\+pipe@{tacopie\+::self\+\_\+pipe}!self\+\_\+pipe@{self\+\_\+pipe}} -\index{self\+\_\+pipe@{self\+\_\+pipe}!tacopie\+::self\+\_\+pipe@{tacopie\+::self\+\_\+pipe}} -\subsubsection{\texorpdfstring{self\+\_\+pipe()}{self\_pipe()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily tacopie\+::self\+\_\+pipe\+::self\+\_\+pipe (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - - - -ctor - -\mbox{\Hypertarget{classtacopie_1_1self__pipe_a10a6c4b0d67a4a14abea397a05cee54c}\label{classtacopie_1_1self__pipe_a10a6c4b0d67a4a14abea397a05cee54c}} -\index{tacopie\+::self\+\_\+pipe@{tacopie\+::self\+\_\+pipe}!````~self\+\_\+pipe@{$\sim$self\+\_\+pipe}} -\index{````~self\+\_\+pipe@{$\sim$self\+\_\+pipe}!tacopie\+::self\+\_\+pipe@{tacopie\+::self\+\_\+pipe}} -\subsubsection{\texorpdfstring{$\sim$self\+\_\+pipe()}{~self\_pipe()}} -{\footnotesize\ttfamily tacopie\+::self\+\_\+pipe\+::$\sim$self\+\_\+pipe (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - - - -dtor - -\mbox{\Hypertarget{classtacopie_1_1self__pipe_a09ffc77b89ad48bc8db6635108c68b6b}\label{classtacopie_1_1self__pipe_a09ffc77b89ad48bc8db6635108c68b6b}} -\index{tacopie\+::self\+\_\+pipe@{tacopie\+::self\+\_\+pipe}!self\+\_\+pipe@{self\+\_\+pipe}} -\index{self\+\_\+pipe@{self\+\_\+pipe}!tacopie\+::self\+\_\+pipe@{tacopie\+::self\+\_\+pipe}} -\subsubsection{\texorpdfstring{self\+\_\+pipe()}{self\_pipe()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily tacopie\+::self\+\_\+pipe\+::self\+\_\+pipe (\begin{DoxyParamCaption}\item[{const \hyperlink{classtacopie_1_1self__pipe}{self\+\_\+pipe} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [delete]}} - - - -copy ctor - \subsection{Member Function Documentation} @@ -74,7 +36,7 @@ \subsubsection{\texorpdfstring{clr\+\_\+buffer()}{clr\_buffer()}} \index{tacopie\+::self\+\_\+pipe@{tacopie\+::self\+\_\+pipe}!get\+\_\+read\+\_\+fd@{get\+\_\+read\+\_\+fd}} \index{get\+\_\+read\+\_\+fd@{get\+\_\+read\+\_\+fd}!tacopie\+::self\+\_\+pipe@{tacopie\+::self\+\_\+pipe}} \subsubsection{\texorpdfstring{get\+\_\+read\+\_\+fd()}{get\_read\_fd()}} -{\footnotesize\ttfamily \hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t} tacopie\+::self\+\_\+pipe\+::get\+\_\+read\+\_\+fd (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const} +{\footnotesize\ttfamily fd\+\_\+t tacopie\+::self\+\_\+pipe\+::get\+\_\+read\+\_\+fd (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const} \begin{DoxyReturn}{Returns} the read fd of the pipe @@ -83,7 +45,7 @@ \subsubsection{\texorpdfstring{get\+\_\+read\+\_\+fd()}{get\_read\_fd()}} \index{tacopie\+::self\+\_\+pipe@{tacopie\+::self\+\_\+pipe}!get\+\_\+write\+\_\+fd@{get\+\_\+write\+\_\+fd}} \index{get\+\_\+write\+\_\+fd@{get\+\_\+write\+\_\+fd}!tacopie\+::self\+\_\+pipe@{tacopie\+::self\+\_\+pipe}} \subsubsection{\texorpdfstring{get\+\_\+write\+\_\+fd()}{get\_write\_fd()}} -{\footnotesize\ttfamily \hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t} tacopie\+::self\+\_\+pipe\+::get\+\_\+write\+\_\+fd (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const} +{\footnotesize\ttfamily fd\+\_\+t tacopie\+::self\+\_\+pipe\+::get\+\_\+write\+\_\+fd (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const} \begin{DoxyReturn}{Returns} the write fd of the pipe @@ -94,27 +56,8 @@ \subsubsection{\texorpdfstring{get\+\_\+write\+\_\+fd()}{get\_write\_fd()}} \subsubsection{\texorpdfstring{notify()}{notify()}} {\footnotesize\ttfamily void tacopie\+::self\+\_\+pipe\+::notify (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} -notify the self pipe (basically write to the pipe) \mbox{\Hypertarget{classtacopie_1_1self__pipe_a14e0fa3a880b6c9559c087eac480c518}\label{classtacopie_1_1self__pipe_a14e0fa3a880b6c9559c087eac480c518}} -\index{tacopie\+::self\+\_\+pipe@{tacopie\+::self\+\_\+pipe}!operator=@{operator=}} -\index{operator=@{operator=}!tacopie\+::self\+\_\+pipe@{tacopie\+::self\+\_\+pipe}} -\subsubsection{\texorpdfstring{operator=()}{operator=()}} -{\footnotesize\ttfamily \hyperlink{classtacopie_1_1self__pipe}{self\+\_\+pipe}\& tacopie\+::self\+\_\+pipe\+::operator= (\begin{DoxyParamCaption}\item[{const \hyperlink{classtacopie_1_1self__pipe}{self\+\_\+pipe} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [delete]}} - - - -assignment operator - - - -\subsection{Member Data Documentation} -\mbox{\Hypertarget{classtacopie_1_1self__pipe_a3e562cfb5ffdd3a8bc6a7c28eca2b7af}\label{classtacopie_1_1self__pipe_a3e562cfb5ffdd3a8bc6a7c28eca2b7af}} -\index{tacopie\+::self\+\_\+pipe@{tacopie\+::self\+\_\+pipe}!m\+\_\+fds@{m\+\_\+fds}} -\index{m\+\_\+fds@{m\+\_\+fds}!tacopie\+::self\+\_\+pipe@{tacopie\+::self\+\_\+pipe}} -\subsubsection{\texorpdfstring{m\+\_\+fds}{m\_fds}} -{\footnotesize\ttfamily \hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t} tacopie\+::self\+\_\+pipe\+::m\+\_\+fds\mbox{[}2\mbox{]}\hspace{0.3cm}{\ttfamily [private]}} - -pipe file descriptors +notify the self pipe (basically write to the pipe) The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize} \item -includes/tacopie/network/\hyperlink{self__pipe_8hpp}{self\+\_\+pipe.\+hpp}\end{DoxyCompactItemize} +includes/tacopie/network/self\+\_\+pipe.\+hpp\end{DoxyCompactItemize} diff --git a/docs/latex/classtacopie_1_1tacopie__error.pdf b/docs/latex/classtacopie_1_1tacopie__error.pdf index a4f38961adc1070680627d30f7f304d822fc27bc..33ca54c3b5a1e3fc318a774ac0201c0b6680d06c 100644 GIT binary patch delta 297 zcmZ3awn%M5IS;R8ilKqIp^2GpN}{p(HXJ-Q^17|ZsQ%hrG7iVWP14~yIOGi5! gf+}LU?CiLTOA?DpDvDCmxJ*pUOu1B5UH#p-0H%LV1ONa4 diff --git a/docs/latex/classtacopie_1_1tacopie__error.tex b/docs/latex/classtacopie_1_1tacopie__error.tex index 4fcad60..5cba181 100644 --- a/docs/latex/classtacopie_1_1tacopie__error.tex +++ b/docs/latex/classtacopie_1_1tacopie__error.tex @@ -13,63 +13,27 @@ \subsection*{Public Member Functions} \begin{DoxyCompactItemize} \item +\mbox{\Hypertarget{classtacopie_1_1tacopie__error_a524fb8e9ac1825a57664421a3f32b9ce}\label{classtacopie_1_1tacopie__error_a524fb8e9ac1825a57664421a3f32b9ce}} \hyperlink{classtacopie_1_1tacopie__error_a524fb8e9ac1825a57664421a3f32b9ce}{tacopie\+\_\+error} (const std\+::string \&what, const std\+::string \&file, std\+::size\+\_\+t line) \begin{DoxyCompactList}\small\item\em ctor \end{DoxyCompactList}\item +\mbox{\Hypertarget{classtacopie_1_1tacopie__error_a5bf6b0967f7f4cf2b8f8d0a2ef0912b2}\label{classtacopie_1_1tacopie__error_a5bf6b0967f7f4cf2b8f8d0a2ef0912b2}} \hyperlink{classtacopie_1_1tacopie__error_a5bf6b0967f7f4cf2b8f8d0a2ef0912b2}{$\sim$tacopie\+\_\+error} (void)=default \begin{DoxyCompactList}\small\item\em assignment operator \end{DoxyCompactList}\item +\mbox{\Hypertarget{classtacopie_1_1tacopie__error_a0cb2a911165e08818ca03308891633e1}\label{classtacopie_1_1tacopie__error_a0cb2a911165e08818ca03308891633e1}} \hyperlink{classtacopie_1_1tacopie__error_a0cb2a911165e08818ca03308891633e1}{tacopie\+\_\+error} (const \hyperlink{classtacopie_1_1tacopie__error}{tacopie\+\_\+error} \&)=default \begin{DoxyCompactList}\small\item\em copy ctor \end{DoxyCompactList}\item +\mbox{\Hypertarget{classtacopie_1_1tacopie__error_ad30ae4932d33b460f75570f5f3a6e3f3}\label{classtacopie_1_1tacopie__error_ad30ae4932d33b460f75570f5f3a6e3f3}} \hyperlink{classtacopie_1_1tacopie__error}{tacopie\+\_\+error} \& \hyperlink{classtacopie_1_1tacopie__error_ad30ae4932d33b460f75570f5f3a6e3f3}{operator=} (const \hyperlink{classtacopie_1_1tacopie__error}{tacopie\+\_\+error} \&)=default \begin{DoxyCompactList}\small\item\em assignment operator \end{DoxyCompactList}\item const std\+::string \& \hyperlink{classtacopie_1_1tacopie__error_a10360163c780a1bd9c95fcecca5aa6da}{get\+\_\+file} (void) const \item std\+::size\+\_\+t \hyperlink{classtacopie_1_1tacopie__error_a39704d2cb6f076aa47d45f53f174b257}{get\+\_\+line} (void) const \end{DoxyCompactItemize} -\subsection*{Private Attributes} -\begin{DoxyCompactItemize} -\item -std\+::string \hyperlink{classtacopie_1_1tacopie__error_a34c06192d25e3c78b1aed8b0c2ead413}{m\+\_\+file} -\item -std\+::size\+\_\+t \hyperlink{classtacopie_1_1tacopie__error_a1631d3a1ba6d610e6c6ab0ddaf70b354}{m\+\_\+line} -\end{DoxyCompactItemize} \subsection{Detailed Description} specialized runtime\+\_\+error used for tacopie error -\subsection{Constructor \& Destructor Documentation} -\mbox{\Hypertarget{classtacopie_1_1tacopie__error_a524fb8e9ac1825a57664421a3f32b9ce}\label{classtacopie_1_1tacopie__error_a524fb8e9ac1825a57664421a3f32b9ce}} -\index{tacopie\+::tacopie\+\_\+error@{tacopie\+::tacopie\+\_\+error}!tacopie\+\_\+error@{tacopie\+\_\+error}} -\index{tacopie\+\_\+error@{tacopie\+\_\+error}!tacopie\+::tacopie\+\_\+error@{tacopie\+::tacopie\+\_\+error}} -\subsubsection{\texorpdfstring{tacopie\+\_\+error()}{tacopie\_error()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily tacopie\+::tacopie\+\_\+error\+::tacopie\+\_\+error (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{what, }\item[{const std\+::string \&}]{file, }\item[{std\+::size\+\_\+t}]{line }\end{DoxyParamCaption})} - - - -ctor - -\mbox{\Hypertarget{classtacopie_1_1tacopie__error_a5bf6b0967f7f4cf2b8f8d0a2ef0912b2}\label{classtacopie_1_1tacopie__error_a5bf6b0967f7f4cf2b8f8d0a2ef0912b2}} -\index{tacopie\+::tacopie\+\_\+error@{tacopie\+::tacopie\+\_\+error}!````~tacopie\+\_\+error@{$\sim$tacopie\+\_\+error}} -\index{````~tacopie\+\_\+error@{$\sim$tacopie\+\_\+error}!tacopie\+::tacopie\+\_\+error@{tacopie\+::tacopie\+\_\+error}} -\subsubsection{\texorpdfstring{$\sim$tacopie\+\_\+error()}{~tacopie\_error()}} -{\footnotesize\ttfamily tacopie\+::tacopie\+\_\+error\+::$\sim$tacopie\+\_\+error (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [default]}} - - - -assignment operator - -\mbox{\Hypertarget{classtacopie_1_1tacopie__error_a0cb2a911165e08818ca03308891633e1}\label{classtacopie_1_1tacopie__error_a0cb2a911165e08818ca03308891633e1}} -\index{tacopie\+::tacopie\+\_\+error@{tacopie\+::tacopie\+\_\+error}!tacopie\+\_\+error@{tacopie\+\_\+error}} -\index{tacopie\+\_\+error@{tacopie\+\_\+error}!tacopie\+::tacopie\+\_\+error@{tacopie\+::tacopie\+\_\+error}} -\subsubsection{\texorpdfstring{tacopie\+\_\+error()}{tacopie\_error()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily tacopie\+::tacopie\+\_\+error\+::tacopie\+\_\+error (\begin{DoxyParamCaption}\item[{const \hyperlink{classtacopie_1_1tacopie__error}{tacopie\+\_\+error} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [default]}} - - - -copy ctor - - - \subsection{Member Function Documentation} \mbox{\Hypertarget{classtacopie_1_1tacopie__error_a10360163c780a1bd9c95fcecca5aa6da}\label{classtacopie_1_1tacopie__error_a10360163c780a1bd9c95fcecca5aa6da}} \index{tacopie\+::tacopie\+\_\+error@{tacopie\+::tacopie\+\_\+error}!get\+\_\+file@{get\+\_\+file}} @@ -89,33 +53,8 @@ \subsubsection{\texorpdfstring{get\+\_\+line()}{get\_line()}} \begin{DoxyReturn}{Returns} line at which the error occured \end{DoxyReturn} -\mbox{\Hypertarget{classtacopie_1_1tacopie__error_ad30ae4932d33b460f75570f5f3a6e3f3}\label{classtacopie_1_1tacopie__error_ad30ae4932d33b460f75570f5f3a6e3f3}} -\index{tacopie\+::tacopie\+\_\+error@{tacopie\+::tacopie\+\_\+error}!operator=@{operator=}} -\index{operator=@{operator=}!tacopie\+::tacopie\+\_\+error@{tacopie\+::tacopie\+\_\+error}} -\subsubsection{\texorpdfstring{operator=()}{operator=()}} -{\footnotesize\ttfamily \hyperlink{classtacopie_1_1tacopie__error}{tacopie\+\_\+error}\& tacopie\+::tacopie\+\_\+error\+::operator= (\begin{DoxyParamCaption}\item[{const \hyperlink{classtacopie_1_1tacopie__error}{tacopie\+\_\+error} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [default]}} - - - -assignment operator - - - -\subsection{Member Data Documentation} -\mbox{\Hypertarget{classtacopie_1_1tacopie__error_a34c06192d25e3c78b1aed8b0c2ead413}\label{classtacopie_1_1tacopie__error_a34c06192d25e3c78b1aed8b0c2ead413}} -\index{tacopie\+::tacopie\+\_\+error@{tacopie\+::tacopie\+\_\+error}!m\+\_\+file@{m\+\_\+file}} -\index{m\+\_\+file@{m\+\_\+file}!tacopie\+::tacopie\+\_\+error@{tacopie\+::tacopie\+\_\+error}} -\subsubsection{\texorpdfstring{m\+\_\+file}{m\_file}} -{\footnotesize\ttfamily std\+::string tacopie\+::tacopie\+\_\+error\+::m\+\_\+file\hspace{0.3cm}{\ttfamily [private]}} - -file location of the error \mbox{\Hypertarget{classtacopie_1_1tacopie__error_a1631d3a1ba6d610e6c6ab0ddaf70b354}\label{classtacopie_1_1tacopie__error_a1631d3a1ba6d610e6c6ab0ddaf70b354}} -\index{tacopie\+::tacopie\+\_\+error@{tacopie\+::tacopie\+\_\+error}!m\+\_\+line@{m\+\_\+line}} -\index{m\+\_\+line@{m\+\_\+line}!tacopie\+::tacopie\+\_\+error@{tacopie\+::tacopie\+\_\+error}} -\subsubsection{\texorpdfstring{m\+\_\+line}{m\_line}} -{\footnotesize\ttfamily std\+::size\+\_\+t tacopie\+::tacopie\+\_\+error\+::m\+\_\+line\hspace{0.3cm}{\ttfamily [private]}} -line location of the error The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize} \item -includes/tacopie/utils/\hyperlink{error_8hpp}{error.\+hpp}\end{DoxyCompactItemize} +includes/tacopie/utils/error.\+hpp\end{DoxyCompactItemize} diff --git a/docs/latex/classtacopie_1_1tcp__client.tex b/docs/latex/classtacopie_1_1tcp__client.tex index 17fc08d..553fd26 100644 --- a/docs/latex/classtacopie_1_1tcp__client.tex +++ b/docs/latex/classtacopie_1_1tcp__client.tex @@ -1,9 +1,5 @@ \hypertarget{classtacopie_1_1tcp__client}{}\section{tacopie\+:\+:tcp\+\_\+client Class Reference} \label{classtacopie_1_1tcp__client}\index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} - - -{\ttfamily \#include $<$tcp\+\_\+client.\+hpp$>$} - \subsection*{Classes} \begin{DoxyCompactItemize} \item @@ -27,14 +23,15 @@ \subsection*{Public Types} \subsection*{Public Member Functions} \begin{DoxyCompactItemize} \item +\mbox{\Hypertarget{classtacopie_1_1tcp__client_a0125e1cf017b0ba0370d682d4382d37b}\label{classtacopie_1_1tcp__client_a0125e1cf017b0ba0370d682d4382d37b}} \hyperlink{classtacopie_1_1tcp__client_a0125e1cf017b0ba0370d682d4382d37b}{tcp\+\_\+client} (std\+::uint32\+\_\+t num\+\_\+io\+\_\+workers=1) \begin{DoxyCompactList}\small\item\em ctor \& dtor \end{DoxyCompactList}\item -\hyperlink{classtacopie_1_1tcp__client_ae58e13ec11ab68e3b9e1af2f96933a64}{$\sim$tcp\+\_\+client} (void) -\item \hyperlink{classtacopie_1_1tcp__client_a773fbcbb5b79324c8d065e363de73282}{tcp\+\_\+client} (\hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&\&socket) \item +\mbox{\Hypertarget{classtacopie_1_1tcp__client_a5e326782c52f63814cc8f42a901ffaf6}\label{classtacopie_1_1tcp__client_a5e326782c52f63814cc8f42a901ffaf6}} \hyperlink{classtacopie_1_1tcp__client_a5e326782c52f63814cc8f42a901ffaf6}{tcp\+\_\+client} (const \hyperlink{classtacopie_1_1tcp__client}{tcp\+\_\+client} \&)=delete \begin{DoxyCompactList}\small\item\em copy ctor \end{DoxyCompactList}\item +\mbox{\Hypertarget{classtacopie_1_1tcp__client_aeadcfb8cd727b2917ebcd357311d0a6b}\label{classtacopie_1_1tcp__client_aeadcfb8cd727b2917ebcd357311d0a6b}} \hyperlink{classtacopie_1_1tcp__client}{tcp\+\_\+client} \& \hyperlink{classtacopie_1_1tcp__client_aeadcfb8cd727b2917ebcd357311d0a6b}{operator=} (const \hyperlink{classtacopie_1_1tcp__client}{tcp\+\_\+client} \&)=delete \begin{DoxyCompactList}\small\item\em assignment operator \end{DoxyCompactList}\item bool \hyperlink{classtacopie_1_1tcp__client_af7a1796c04efd00542349ecab692e073}{operator==} (const \hyperlink{classtacopie_1_1tcp__client}{tcp\+\_\+client} \&rhs) const @@ -63,42 +60,6 @@ \subsection*{Public Member Functions} \item void \hyperlink{classtacopie_1_1tcp__client_a8c290d681186edb0578051c04f3c0762}{set\+\_\+on\+\_\+disconnection\+\_\+handler} (const \hyperlink{classtacopie_1_1tcp__client_aca5df52e5ee6fa673cf212532ada1453}{disconnection\+\_\+handler\+\_\+t} \&disconnection\+\_\+handler) \end{DoxyCompactItemize} -\subsection*{Private Member Functions} -\begin{DoxyCompactItemize} -\item -void \hyperlink{classtacopie_1_1tcp__client_ae38ae1f64909dd36592a02fc3c245672}{call\+\_\+disconnection\+\_\+handler} (void) -\item -void \hyperlink{classtacopie_1_1tcp__client_acb08202e4ea7d85df4a6959dfe418eba}{on\+\_\+read\+\_\+available} (\hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t} fd) -\item -void \hyperlink{classtacopie_1_1tcp__client_aee290ddef8906d49edf3bdc9e3555d0a}{on\+\_\+write\+\_\+available} (\hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t} fd) -\item -void \hyperlink{classtacopie_1_1tcp__client_afdb370d07800a95448a645f4605d54e1}{clear\+\_\+read\+\_\+requests} (void) -\item -void \hyperlink{classtacopie_1_1tcp__client_acd8c8d54f359ed99be3a2dd50ef0ec77}{clear\+\_\+write\+\_\+requests} (void) -\item -\hyperlink{classtacopie_1_1tcp__client_acdf9dea8bac6c56f7b04ce38b9432322}{async\+\_\+read\+\_\+callback\+\_\+t} \hyperlink{classtacopie_1_1tcp__client_a40308b6a1642a79a35a2b2d9c9b9a3f7}{process\+\_\+read} (\hyperlink{structtacopie_1_1tcp__client_1_1read__result}{read\+\_\+result} \&result) -\item -\hyperlink{classtacopie_1_1tcp__client_ad48b8c8dff8a77490eb2e3e802c82b97}{async\+\_\+write\+\_\+callback\+\_\+t} \hyperlink{classtacopie_1_1tcp__client_afd5e43d5f44930894de10ce05268607f}{process\+\_\+write} (\hyperlink{structtacopie_1_1tcp__client_1_1write__result}{write\+\_\+result} \&result) -\end{DoxyCompactItemize} -\subsection*{Private Attributes} -\begin{DoxyCompactItemize} -\item -std\+::shared\+\_\+ptr$<$ \hyperlink{classtacopie_1_1io__service}{io\+\_\+service} $>$ \hyperlink{classtacopie_1_1tcp__client_a2a5e4ae0f4fbcd375df4cb1f8070b993}{m\+\_\+io\+\_\+service} -\item -\hyperlink{classtacopie_1_1tcp__socket}{tacopie\+::tcp\+\_\+socket} \hyperlink{classtacopie_1_1tcp__client_ad256815911a745fce8f2aed00fb45b21}{m\+\_\+socket} -\item -std\+::atomic$<$ bool $>$ \hyperlink{classtacopie_1_1tcp__client_adf45ef6f910a7723fcfe543417f1feaf}{m\+\_\+is\+\_\+connected} = A\+T\+O\+M\+I\+C\+\_\+\+V\+A\+R\+\_\+\+I\+N\+IT(false) -\item -std\+::queue$<$ \hyperlink{structtacopie_1_1tcp__client_1_1read__request}{read\+\_\+request} $>$ \hyperlink{classtacopie_1_1tcp__client_a458754e266c0f41b42e17806cc59dc2a}{m\+\_\+read\+\_\+requests} -\item -std\+::queue$<$ \hyperlink{structtacopie_1_1tcp__client_1_1write__request}{write\+\_\+request} $>$ \hyperlink{classtacopie_1_1tcp__client_aabf49a27ada2707f252b295dcec13969}{m\+\_\+write\+\_\+requests} -\item -std\+::mutex \hyperlink{classtacopie_1_1tcp__client_a792be0da277e372460fbe6977f03d27b}{m\+\_\+read\+\_\+requests\+\_\+mtx} -\item -std\+::mutex \hyperlink{classtacopie_1_1tcp__client_abc7c664a73d528c0b1c226d35f7bae2f}{m\+\_\+write\+\_\+requests\+\_\+mtx} -\item -\hyperlink{classtacopie_1_1tcp__client_aca5df52e5ee6fa673cf212532ada1453}{disconnection\+\_\+handler\+\_\+t} \hyperlink{classtacopie_1_1tcp__client_a5ee7259fe6a8258515162e1ed516de20}{m\+\_\+disconnection\+\_\+handler} -\end{DoxyCompactItemize} \subsection{Member Typedef Documentation} @@ -123,26 +84,10 @@ \subsubsection{\texorpdfstring{disconnection\+\_\+handler\+\_\+t}{disconnection\ disconnection handle called whenever a disconnection occured \subsection{Constructor \& Destructor Documentation} -\mbox{\Hypertarget{classtacopie_1_1tcp__client_a0125e1cf017b0ba0370d682d4382d37b}\label{classtacopie_1_1tcp__client_a0125e1cf017b0ba0370d682d4382d37b}} -\index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!tcp\+\_\+client@{tcp\+\_\+client}} -\index{tcp\+\_\+client@{tcp\+\_\+client}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} -\subsubsection{\texorpdfstring{tcp\+\_\+client()}{tcp\_client()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}} -{\footnotesize\ttfamily tacopie\+::tcp\+\_\+client\+::tcp\+\_\+client (\begin{DoxyParamCaption}\item[{std\+::uint32\+\_\+t}]{num\+\_\+io\+\_\+workers = {\ttfamily 1} }\end{DoxyParamCaption})} - - - -ctor \& dtor - -\mbox{\Hypertarget{classtacopie_1_1tcp__client_ae58e13ec11ab68e3b9e1af2f96933a64}\label{classtacopie_1_1tcp__client_ae58e13ec11ab68e3b9e1af2f96933a64}} -\index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!````~tcp\+\_\+client@{$\sim$tcp\+\_\+client}} -\index{````~tcp\+\_\+client@{$\sim$tcp\+\_\+client}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} -\subsubsection{\texorpdfstring{$\sim$tcp\+\_\+client()}{~tcp\_client()}} -{\footnotesize\ttfamily tacopie\+::tcp\+\_\+client\+::$\sim$tcp\+\_\+client (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - \mbox{\Hypertarget{classtacopie_1_1tcp__client_a773fbcbb5b79324c8d065e363de73282}\label{classtacopie_1_1tcp__client_a773fbcbb5b79324c8d065e363de73282}} \index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!tcp\+\_\+client@{tcp\+\_\+client}} \index{tcp\+\_\+client@{tcp\+\_\+client}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} -\subsubsection{\texorpdfstring{tcp\+\_\+client()}{tcp\_client()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}} +\subsubsection{\texorpdfstring{tcp\+\_\+client()}{tcp\_client()}} {\footnotesize\ttfamily tacopie\+::tcp\+\_\+client\+::tcp\+\_\+client (\begin{DoxyParamCaption}\item[{\hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&\&}]{socket }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [explicit]}} custom ctor build socket from existing socket @@ -152,16 +97,6 @@ \subsubsection{\texorpdfstring{tcp\+\_\+client()}{tcp\_client()}\hspace{0.1cm}{\ {\em socket} & \hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} instance to be used for building the client (socket will be moved) \\ \hline \end{DoxyParams} -\mbox{\Hypertarget{classtacopie_1_1tcp__client_a5e326782c52f63814cc8f42a901ffaf6}\label{classtacopie_1_1tcp__client_a5e326782c52f63814cc8f42a901ffaf6}} -\index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!tcp\+\_\+client@{tcp\+\_\+client}} -\index{tcp\+\_\+client@{tcp\+\_\+client}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} -\subsubsection{\texorpdfstring{tcp\+\_\+client()}{tcp\_client()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}} -{\footnotesize\ttfamily tacopie\+::tcp\+\_\+client\+::tcp\+\_\+client (\begin{DoxyParamCaption}\item[{const \hyperlink{classtacopie_1_1tcp__client}{tcp\+\_\+client} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [delete]}} - - - -copy ctor - \subsection{Member Function Documentation} @@ -191,25 +126,7 @@ \subsubsection{\texorpdfstring{async\+\_\+write()}{async\_write()}} {\em request} & write request information \\ \hline \end{DoxyParams} -\mbox{\Hypertarget{classtacopie_1_1tcp__client_ae38ae1f64909dd36592a02fc3c245672}\label{classtacopie_1_1tcp__client_ae38ae1f64909dd36592a02fc3c245672}} -\index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!call\+\_\+disconnection\+\_\+handler@{call\+\_\+disconnection\+\_\+handler}} -\index{call\+\_\+disconnection\+\_\+handler@{call\+\_\+disconnection\+\_\+handler}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} -\subsubsection{\texorpdfstring{call\+\_\+disconnection\+\_\+handler()}{call\_disconnection\_handler()}} -{\footnotesize\ttfamily void tacopie\+::tcp\+\_\+client\+::call\+\_\+disconnection\+\_\+handler (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} - -Call the user-\/defined disconnection handler \mbox{\Hypertarget{classtacopie_1_1tcp__client_afdb370d07800a95448a645f4605d54e1}\label{classtacopie_1_1tcp__client_afdb370d07800a95448a645f4605d54e1}} -\index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!clear\+\_\+read\+\_\+requests@{clear\+\_\+read\+\_\+requests}} -\index{clear\+\_\+read\+\_\+requests@{clear\+\_\+read\+\_\+requests}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} -\subsubsection{\texorpdfstring{clear\+\_\+read\+\_\+requests()}{clear\_read\_requests()}} -{\footnotesize\ttfamily void tacopie\+::tcp\+\_\+client\+::clear\+\_\+read\+\_\+requests (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} - -Clear pending read requests (basically empty the queue of read requests) \mbox{\Hypertarget{classtacopie_1_1tcp__client_acd8c8d54f359ed99be3a2dd50ef0ec77}\label{classtacopie_1_1tcp__client_acd8c8d54f359ed99be3a2dd50ef0ec77}} -\index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!clear\+\_\+write\+\_\+requests@{clear\+\_\+write\+\_\+requests}} -\index{clear\+\_\+write\+\_\+requests@{clear\+\_\+write\+\_\+requests}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} -\subsubsection{\texorpdfstring{clear\+\_\+write\+\_\+requests()}{clear\_write\_requests()}} -{\footnotesize\ttfamily void tacopie\+::tcp\+\_\+client\+::clear\+\_\+write\+\_\+requests (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} - -Clear pending write requests (basically empty the queue of write requests) \mbox{\Hypertarget{classtacopie_1_1tcp__client_a0cfbb18cb72aa3b6a41921f61cacc425}\label{classtacopie_1_1tcp__client_a0cfbb18cb72aa3b6a41921f61cacc425}} +\mbox{\Hypertarget{classtacopie_1_1tcp__client_a0cfbb18cb72aa3b6a41921f61cacc425}\label{classtacopie_1_1tcp__client_a0cfbb18cb72aa3b6a41921f61cacc425}} \index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!connect@{connect}} \index{connect@{connect}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} \subsubsection{\texorpdfstring{connect()}{connect()}} @@ -293,32 +210,6 @@ \subsubsection{\texorpdfstring{is\+\_\+connected()}{is\_connected()}} \begin{DoxyReturn}{Returns} whether the client is currently connected or not \end{DoxyReturn} -\mbox{\Hypertarget{classtacopie_1_1tcp__client_acb08202e4ea7d85df4a6959dfe418eba}\label{classtacopie_1_1tcp__client_acb08202e4ea7d85df4a6959dfe418eba}} -\index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!on\+\_\+read\+\_\+available@{on\+\_\+read\+\_\+available}} -\index{on\+\_\+read\+\_\+available@{on\+\_\+read\+\_\+available}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} -\subsubsection{\texorpdfstring{on\+\_\+read\+\_\+available()}{on\_read\_available()}} -{\footnotesize\ttfamily void tacopie\+::tcp\+\_\+client\+::on\+\_\+read\+\_\+available (\begin{DoxyParamCaption}\item[{\hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t}}]{fd }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} - -io service read callback called by the io service whenever the socket is readable - - -\begin{DoxyParams}{Parameters} -{\em fd} & file description of the socket for which the read is available \\ -\hline -\end{DoxyParams} -\mbox{\Hypertarget{classtacopie_1_1tcp__client_aee290ddef8906d49edf3bdc9e3555d0a}\label{classtacopie_1_1tcp__client_aee290ddef8906d49edf3bdc9e3555d0a}} -\index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!on\+\_\+write\+\_\+available@{on\+\_\+write\+\_\+available}} -\index{on\+\_\+write\+\_\+available@{on\+\_\+write\+\_\+available}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} -\subsubsection{\texorpdfstring{on\+\_\+write\+\_\+available()}{on\_write\_available()}} -{\footnotesize\ttfamily void tacopie\+::tcp\+\_\+client\+::on\+\_\+write\+\_\+available (\begin{DoxyParamCaption}\item[{\hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t}}]{fd }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} - -io service write callback called by the io service whenever the socket is writable - - -\begin{DoxyParams}{Parameters} -{\em fd} & file description of the socket for which the write is available \\ -\hline -\end{DoxyParams} \mbox{\Hypertarget{classtacopie_1_1tcp__client_af352b6b1e939c919aec2761517051eb9}\label{classtacopie_1_1tcp__client_af352b6b1e939c919aec2761517051eb9}} \index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!operator"!=@{operator"!=}} \index{operator"!=@{operator"!=}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} @@ -330,16 +221,6 @@ \subsubsection{\texorpdfstring{operator"!=()}{operator!=()}} \begin{DoxyReturn}{Returns} true when the underlying sockets are different (different file descriptor or socket type). \end{DoxyReturn} -\mbox{\Hypertarget{classtacopie_1_1tcp__client_aeadcfb8cd727b2917ebcd357311d0a6b}\label{classtacopie_1_1tcp__client_aeadcfb8cd727b2917ebcd357311d0a6b}} -\index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!operator=@{operator=}} -\index{operator=@{operator=}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} -\subsubsection{\texorpdfstring{operator=()}{operator=()}} -{\footnotesize\ttfamily \hyperlink{classtacopie_1_1tcp__client}{tcp\+\_\+client}\& tacopie\+::tcp\+\_\+client\+::operator= (\begin{DoxyParamCaption}\item[{const \hyperlink{classtacopie_1_1tcp__client}{tcp\+\_\+client} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [delete]}} - - - -assignment operator - \mbox{\Hypertarget{classtacopie_1_1tcp__client_af7a1796c04efd00542349ecab692e073}\label{classtacopie_1_1tcp__client_af7a1796c04efd00542349ecab692e073}} \index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!operator==@{operator==}} \index{operator==@{operator==}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} @@ -351,38 +232,6 @@ \subsubsection{\texorpdfstring{operator==()}{operator==()}} \begin{DoxyReturn}{Returns} true when the underlying sockets are the same (same file descriptor and socket type). \end{DoxyReturn} -\mbox{\Hypertarget{classtacopie_1_1tcp__client_a40308b6a1642a79a35a2b2d9c9b9a3f7}\label{classtacopie_1_1tcp__client_a40308b6a1642a79a35a2b2d9c9b9a3f7}} -\index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!process\+\_\+read@{process\+\_\+read}} -\index{process\+\_\+read@{process\+\_\+read}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} -\subsubsection{\texorpdfstring{process\+\_\+read()}{process\_read()}} -{\footnotesize\ttfamily \hyperlink{classtacopie_1_1tcp__client_acdf9dea8bac6c56f7b04ce38b9432322}{async\+\_\+read\+\_\+callback\+\_\+t} tacopie\+::tcp\+\_\+client\+::process\+\_\+read (\begin{DoxyParamCaption}\item[{\hyperlink{structtacopie_1_1tcp__client_1_1read__result}{read\+\_\+result} \&}]{result }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} - -process read operations when available basically called whenever on\+\_\+read\+\_\+available is called and try to read from the socket handle possible case of failure and fill in the result - - -\begin{DoxyParams}{Parameters} -{\em result} & result of the read operation \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -the callback to be executed (set in the read request) on read completion (may be null) -\end{DoxyReturn} -\mbox{\Hypertarget{classtacopie_1_1tcp__client_afd5e43d5f44930894de10ce05268607f}\label{classtacopie_1_1tcp__client_afd5e43d5f44930894de10ce05268607f}} -\index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!process\+\_\+write@{process\+\_\+write}} -\index{process\+\_\+write@{process\+\_\+write}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} -\subsubsection{\texorpdfstring{process\+\_\+write()}{process\_write()}} -{\footnotesize\ttfamily \hyperlink{classtacopie_1_1tcp__client_ad48b8c8dff8a77490eb2e3e802c82b97}{async\+\_\+write\+\_\+callback\+\_\+t} tacopie\+::tcp\+\_\+client\+::process\+\_\+write (\begin{DoxyParamCaption}\item[{\hyperlink{structtacopie_1_1tcp__client_1_1write__result}{write\+\_\+result} \&}]{result }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} - -process write operations when available basically called whenever on\+\_\+write\+\_\+available is called and try to write to the socket handle possible case of failure and fill in the result - - -\begin{DoxyParams}{Parameters} -{\em result} & result of the write operation \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -the callback to be executed (set in the write request) on read completion (may be null) -\end{DoxyReturn} \mbox{\Hypertarget{classtacopie_1_1tcp__client_a8c290d681186edb0578051c04f3c0762}\label{classtacopie_1_1tcp__client_a8c290d681186edb0578051c04f3c0762}} \index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!set\+\_\+on\+\_\+disconnection\+\_\+handler@{set\+\_\+on\+\_\+disconnection\+\_\+handler}} \index{set\+\_\+on\+\_\+disconnection\+\_\+handler@{set\+\_\+on\+\_\+disconnection\+\_\+handler}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} @@ -398,57 +247,6 @@ \subsubsection{\texorpdfstring{set\+\_\+on\+\_\+disconnection\+\_\+handler()}{se \end{DoxyParams} -\subsection{Member Data Documentation} -\mbox{\Hypertarget{classtacopie_1_1tcp__client_a5ee7259fe6a8258515162e1ed516de20}\label{classtacopie_1_1tcp__client_a5ee7259fe6a8258515162e1ed516de20}} -\index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!m\+\_\+disconnection\+\_\+handler@{m\+\_\+disconnection\+\_\+handler}} -\index{m\+\_\+disconnection\+\_\+handler@{m\+\_\+disconnection\+\_\+handler}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} -\subsubsection{\texorpdfstring{m\+\_\+disconnection\+\_\+handler}{m\_disconnection\_handler}} -{\footnotesize\ttfamily \hyperlink{classtacopie_1_1tcp__client_aca5df52e5ee6fa673cf212532ada1453}{disconnection\+\_\+handler\+\_\+t} tacopie\+::tcp\+\_\+client\+::m\+\_\+disconnection\+\_\+handler\hspace{0.3cm}{\ttfamily [private]}} - -disconnection handler \mbox{\Hypertarget{classtacopie_1_1tcp__client_a2a5e4ae0f4fbcd375df4cb1f8070b993}\label{classtacopie_1_1tcp__client_a2a5e4ae0f4fbcd375df4cb1f8070b993}} -\index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!m\+\_\+io\+\_\+service@{m\+\_\+io\+\_\+service}} -\index{m\+\_\+io\+\_\+service@{m\+\_\+io\+\_\+service}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} -\subsubsection{\texorpdfstring{m\+\_\+io\+\_\+service}{m\_io\_service}} -{\footnotesize\ttfamily std\+::shared\+\_\+ptr$<$\hyperlink{classtacopie_1_1io__service}{io\+\_\+service}$>$ tacopie\+::tcp\+\_\+client\+::m\+\_\+io\+\_\+service\hspace{0.3cm}{\ttfamily [private]}} - -store \hyperlink{classtacopie_1_1io__service}{io\+\_\+service} prevent deletion of \hyperlink{classtacopie_1_1io__service}{io\+\_\+service} before the \hyperlink{classtacopie_1_1tcp__client}{tcp\+\_\+client} itself \mbox{\Hypertarget{classtacopie_1_1tcp__client_adf45ef6f910a7723fcfe543417f1feaf}\label{classtacopie_1_1tcp__client_adf45ef6f910a7723fcfe543417f1feaf}} -\index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!m\+\_\+is\+\_\+connected@{m\+\_\+is\+\_\+connected}} -\index{m\+\_\+is\+\_\+connected@{m\+\_\+is\+\_\+connected}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} -\subsubsection{\texorpdfstring{m\+\_\+is\+\_\+connected}{m\_is\_connected}} -{\footnotesize\ttfamily std\+::atomic$<$bool$>$ tacopie\+::tcp\+\_\+client\+::m\+\_\+is\+\_\+connected = A\+T\+O\+M\+I\+C\+\_\+\+V\+A\+R\+\_\+\+I\+N\+IT(false)\hspace{0.3cm}{\ttfamily [private]}} - -whether the client is currently connected or not \mbox{\Hypertarget{classtacopie_1_1tcp__client_a458754e266c0f41b42e17806cc59dc2a}\label{classtacopie_1_1tcp__client_a458754e266c0f41b42e17806cc59dc2a}} -\index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!m\+\_\+read\+\_\+requests@{m\+\_\+read\+\_\+requests}} -\index{m\+\_\+read\+\_\+requests@{m\+\_\+read\+\_\+requests}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} -\subsubsection{\texorpdfstring{m\+\_\+read\+\_\+requests}{m\_read\_requests}} -{\footnotesize\ttfamily std\+::queue$<$\hyperlink{structtacopie_1_1tcp__client_1_1read__request}{read\+\_\+request}$>$ tacopie\+::tcp\+\_\+client\+::m\+\_\+read\+\_\+requests\hspace{0.3cm}{\ttfamily [private]}} - -read requests \mbox{\Hypertarget{classtacopie_1_1tcp__client_a792be0da277e372460fbe6977f03d27b}\label{classtacopie_1_1tcp__client_a792be0da277e372460fbe6977f03d27b}} -\index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!m\+\_\+read\+\_\+requests\+\_\+mtx@{m\+\_\+read\+\_\+requests\+\_\+mtx}} -\index{m\+\_\+read\+\_\+requests\+\_\+mtx@{m\+\_\+read\+\_\+requests\+\_\+mtx}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} -\subsubsection{\texorpdfstring{m\+\_\+read\+\_\+requests\+\_\+mtx}{m\_read\_requests\_mtx}} -{\footnotesize\ttfamily std\+::mutex tacopie\+::tcp\+\_\+client\+::m\+\_\+read\+\_\+requests\+\_\+mtx\hspace{0.3cm}{\ttfamily [private]}} - -read requests thread safety \mbox{\Hypertarget{classtacopie_1_1tcp__client_ad256815911a745fce8f2aed00fb45b21}\label{classtacopie_1_1tcp__client_ad256815911a745fce8f2aed00fb45b21}} -\index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!m\+\_\+socket@{m\+\_\+socket}} -\index{m\+\_\+socket@{m\+\_\+socket}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} -\subsubsection{\texorpdfstring{m\+\_\+socket}{m\_socket}} -{\footnotesize\ttfamily \hyperlink{classtacopie_1_1tcp__socket}{tacopie\+::tcp\+\_\+socket} tacopie\+::tcp\+\_\+client\+::m\+\_\+socket\hspace{0.3cm}{\ttfamily [private]}} - -client socket \mbox{\Hypertarget{classtacopie_1_1tcp__client_aabf49a27ada2707f252b295dcec13969}\label{classtacopie_1_1tcp__client_aabf49a27ada2707f252b295dcec13969}} -\index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!m\+\_\+write\+\_\+requests@{m\+\_\+write\+\_\+requests}} -\index{m\+\_\+write\+\_\+requests@{m\+\_\+write\+\_\+requests}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} -\subsubsection{\texorpdfstring{m\+\_\+write\+\_\+requests}{m\_write\_requests}} -{\footnotesize\ttfamily std\+::queue$<$\hyperlink{structtacopie_1_1tcp__client_1_1write__request}{write\+\_\+request}$>$ tacopie\+::tcp\+\_\+client\+::m\+\_\+write\+\_\+requests\hspace{0.3cm}{\ttfamily [private]}} - -write requests \mbox{\Hypertarget{classtacopie_1_1tcp__client_abc7c664a73d528c0b1c226d35f7bae2f}\label{classtacopie_1_1tcp__client_abc7c664a73d528c0b1c226d35f7bae2f}} -\index{tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}!m\+\_\+write\+\_\+requests\+\_\+mtx@{m\+\_\+write\+\_\+requests\+\_\+mtx}} -\index{m\+\_\+write\+\_\+requests\+\_\+mtx@{m\+\_\+write\+\_\+requests\+\_\+mtx}!tacopie\+::tcp\+\_\+client@{tacopie\+::tcp\+\_\+client}} -\subsubsection{\texorpdfstring{m\+\_\+write\+\_\+requests\+\_\+mtx}{m\_write\_requests\_mtx}} -{\footnotesize\ttfamily std\+::mutex tacopie\+::tcp\+\_\+client\+::m\+\_\+write\+\_\+requests\+\_\+mtx\hspace{0.3cm}{\ttfamily [private]}} - -write requests thread safety - The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize} \item -includes/tacopie/network/\hyperlink{tcp__client_8hpp}{tcp\+\_\+client.\+hpp}\end{DoxyCompactItemize} +includes/tacopie/network/tcp\+\_\+client.\+hpp\end{DoxyCompactItemize} diff --git a/docs/latex/classtacopie_1_1tcp__server.tex b/docs/latex/classtacopie_1_1tcp__server.tex index 183b841..37c95ed 100644 --- a/docs/latex/classtacopie_1_1tcp__server.tex +++ b/docs/latex/classtacopie_1_1tcp__server.tex @@ -12,12 +12,16 @@ \subsection*{Public Types} \subsection*{Public Member Functions} \begin{DoxyCompactItemize} \item +\mbox{\Hypertarget{classtacopie_1_1tcp__server_a4f67a38a0764924768cbcc7cf68527bf}\label{classtacopie_1_1tcp__server_a4f67a38a0764924768cbcc7cf68527bf}} \hyperlink{classtacopie_1_1tcp__server_a4f67a38a0764924768cbcc7cf68527bf}{tcp\+\_\+server} (void) \begin{DoxyCompactList}\small\item\em ctor \end{DoxyCompactList}\item +\mbox{\Hypertarget{classtacopie_1_1tcp__server_a7841dc528e2d3dfc94fbe9b93824da50}\label{classtacopie_1_1tcp__server_a7841dc528e2d3dfc94fbe9b93824da50}} \hyperlink{classtacopie_1_1tcp__server_a7841dc528e2d3dfc94fbe9b93824da50}{$\sim$tcp\+\_\+server} (void) \begin{DoxyCompactList}\small\item\em dtor \end{DoxyCompactList}\item +\mbox{\Hypertarget{classtacopie_1_1tcp__server_a2d9c6a2dea95a3c6a919c655d6e8e0ba}\label{classtacopie_1_1tcp__server_a2d9c6a2dea95a3c6a919c655d6e8e0ba}} \hyperlink{classtacopie_1_1tcp__server_a2d9c6a2dea95a3c6a919c655d6e8e0ba}{tcp\+\_\+server} (const \hyperlink{classtacopie_1_1tcp__server}{tcp\+\_\+server} \&)=delete \begin{DoxyCompactList}\small\item\em copy ctor \end{DoxyCompactList}\item +\mbox{\Hypertarget{classtacopie_1_1tcp__server_a7e7da4352e2e016f8d40d19bf9fee54b}\label{classtacopie_1_1tcp__server_a7e7da4352e2e016f8d40d19bf9fee54b}} \hyperlink{classtacopie_1_1tcp__server}{tcp\+\_\+server} \& \hyperlink{classtacopie_1_1tcp__server_a7e7da4352e2e016f8d40d19bf9fee54b}{operator=} (const \hyperlink{classtacopie_1_1tcp__server}{tcp\+\_\+server} \&)=delete \begin{DoxyCompactList}\small\item\em assignment operator \end{DoxyCompactList}\item bool \hyperlink{classtacopie_1_1tcp__server_ab9b95a27afb405668bb4d5b1a312ceae}{operator==} (const \hyperlink{classtacopie_1_1tcp__server}{tcp\+\_\+server} \&rhs) const @@ -38,28 +42,6 @@ \subsection*{Public Member Functions} \item const std\+::list$<$ std\+::shared\+\_\+ptr$<$ \hyperlink{classtacopie_1_1tcp__client}{tacopie\+::tcp\+\_\+client} $>$ $>$ \& \hyperlink{classtacopie_1_1tcp__server_a0df81b943243ad51102c37d4944be8d7}{get\+\_\+clients} (void) const \end{DoxyCompactItemize} -\subsection*{Private Member Functions} -\begin{DoxyCompactItemize} -\item -void \hyperlink{classtacopie_1_1tcp__server_a62b4b67ab9554b27881be8dbe869cc6e}{on\+\_\+read\+\_\+available} (\hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t} fd) -\item -void \hyperlink{classtacopie_1_1tcp__server_ad98bdefae28be6b16a213bf5bedbf7d9}{on\+\_\+client\+\_\+disconnected} (const std\+::shared\+\_\+ptr$<$ \hyperlink{classtacopie_1_1tcp__client}{tcp\+\_\+client} $>$ \&client) -\end{DoxyCompactItemize} -\subsection*{Private Attributes} -\begin{DoxyCompactItemize} -\item -std\+::shared\+\_\+ptr$<$ \hyperlink{classtacopie_1_1io__service}{io\+\_\+service} $>$ \hyperlink{classtacopie_1_1tcp__server_a91d9aa88e0de045dc0bb54cddf02e786}{m\+\_\+io\+\_\+service} -\item -\hyperlink{classtacopie_1_1tcp__socket}{tacopie\+::tcp\+\_\+socket} \hyperlink{classtacopie_1_1tcp__server_a2838c1b655a8c4f5ccb1e157afc17284}{m\+\_\+socket} -\item -std\+::atomic$<$ bool $>$ \hyperlink{classtacopie_1_1tcp__server_a7b7651a482cbc5bb19145b77fe322ced}{m\+\_\+is\+\_\+running} = A\+T\+O\+M\+I\+C\+\_\+\+V\+A\+R\+\_\+\+I\+N\+IT(false) -\item -std\+::list$<$ std\+::shared\+\_\+ptr$<$ \hyperlink{classtacopie_1_1tcp__client}{tacopie\+::tcp\+\_\+client} $>$ $>$ \hyperlink{classtacopie_1_1tcp__server_ab3e475c59504150c4f3dc68bdb932670}{m\+\_\+clients} -\item -std\+::mutex \hyperlink{classtacopie_1_1tcp__server_ad4ee31fe6e01a38bb2a3b11a0f29ab9a}{m\+\_\+clients\+\_\+mtx} -\item -\hyperlink{classtacopie_1_1tcp__server_a103cb4e6fcab00f88a708aabd38b66ff}{on\+\_\+new\+\_\+connection\+\_\+callback\+\_\+t} \hyperlink{classtacopie_1_1tcp__server_a779d20d286c32e5daff0012548afdfd0}{m\+\_\+on\+\_\+new\+\_\+connection\+\_\+callback} -\end{DoxyCompactItemize} \subsection{Detailed Description} @@ -76,39 +58,6 @@ \subsubsection{\texorpdfstring{on\+\_\+new\+\_\+connection\+\_\+callback\+\_\+t} Takes as parameter a shared pointer to the \hyperlink{classtacopie_1_1tcp__client}{tcp\+\_\+client} that wishes to connect Returning true means connection is handled by \hyperlink{classtacopie_1_1tcp__client}{tcp\+\_\+client} wrapper and nothing will be done by \hyperlink{classtacopie_1_1tcp__server}{tcp\+\_\+server}. Returning false means connection is handled by \hyperlink{classtacopie_1_1tcp__server}{tcp\+\_\+server}, will be stored in an internal list and \hyperlink{classtacopie_1_1tcp__client}{tcp\+\_\+client} disconection\+\_\+handler overriden. -\subsection{Constructor \& Destructor Documentation} -\mbox{\Hypertarget{classtacopie_1_1tcp__server_a4f67a38a0764924768cbcc7cf68527bf}\label{classtacopie_1_1tcp__server_a4f67a38a0764924768cbcc7cf68527bf}} -\index{tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}!tcp\+\_\+server@{tcp\+\_\+server}} -\index{tcp\+\_\+server@{tcp\+\_\+server}!tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}} -\subsubsection{\texorpdfstring{tcp\+\_\+server()}{tcp\_server()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily tacopie\+::tcp\+\_\+server\+::tcp\+\_\+server (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - - - -ctor - -\mbox{\Hypertarget{classtacopie_1_1tcp__server_a7841dc528e2d3dfc94fbe9b93824da50}\label{classtacopie_1_1tcp__server_a7841dc528e2d3dfc94fbe9b93824da50}} -\index{tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}!````~tcp\+\_\+server@{$\sim$tcp\+\_\+server}} -\index{````~tcp\+\_\+server@{$\sim$tcp\+\_\+server}!tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}} -\subsubsection{\texorpdfstring{$\sim$tcp\+\_\+server()}{~tcp\_server()}} -{\footnotesize\ttfamily tacopie\+::tcp\+\_\+server\+::$\sim$tcp\+\_\+server (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - - - -dtor - -\mbox{\Hypertarget{classtacopie_1_1tcp__server_a2d9c6a2dea95a3c6a919c655d6e8e0ba}\label{classtacopie_1_1tcp__server_a2d9c6a2dea95a3c6a919c655d6e8e0ba}} -\index{tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}!tcp\+\_\+server@{tcp\+\_\+server}} -\index{tcp\+\_\+server@{tcp\+\_\+server}!tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}} -\subsubsection{\texorpdfstring{tcp\+\_\+server()}{tcp\_server()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily tacopie\+::tcp\+\_\+server\+::tcp\+\_\+server (\begin{DoxyParamCaption}\item[{const \hyperlink{classtacopie_1_1tcp__server}{tcp\+\_\+server} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [delete]}} - - - -copy ctor - - - \subsection{Member Function Documentation} \mbox{\Hypertarget{classtacopie_1_1tcp__server_a0df81b943243ad51102c37d4944be8d7}\label{classtacopie_1_1tcp__server_a0df81b943243ad51102c37d4944be8d7}} \index{tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}!get\+\_\+clients@{get\+\_\+clients}} @@ -155,32 +104,6 @@ \subsubsection{\texorpdfstring{is\+\_\+running()}{is\_running()}} \begin{DoxyReturn}{Returns} whether the server is currently running or not \end{DoxyReturn} -\mbox{\Hypertarget{classtacopie_1_1tcp__server_ad98bdefae28be6b16a213bf5bedbf7d9}\label{classtacopie_1_1tcp__server_ad98bdefae28be6b16a213bf5bedbf7d9}} -\index{tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}!on\+\_\+client\+\_\+disconnected@{on\+\_\+client\+\_\+disconnected}} -\index{on\+\_\+client\+\_\+disconnected@{on\+\_\+client\+\_\+disconnected}!tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}} -\subsubsection{\texorpdfstring{on\+\_\+client\+\_\+disconnected()}{on\_client\_disconnected()}} -{\footnotesize\ttfamily void tacopie\+::tcp\+\_\+server\+::on\+\_\+client\+\_\+disconnected (\begin{DoxyParamCaption}\item[{const std\+::shared\+\_\+ptr$<$ \hyperlink{classtacopie_1_1tcp__client}{tcp\+\_\+client} $>$ \&}]{client }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} - -client disconnected called whenever a client disconnected from the \hyperlink{classtacopie_1_1tcp__server}{tcp\+\_\+server} - - -\begin{DoxyParams}{Parameters} -{\em client} & disconnected client \\ -\hline -\end{DoxyParams} -\mbox{\Hypertarget{classtacopie_1_1tcp__server_a62b4b67ab9554b27881be8dbe869cc6e}\label{classtacopie_1_1tcp__server_a62b4b67ab9554b27881be8dbe869cc6e}} -\index{tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}!on\+\_\+read\+\_\+available@{on\+\_\+read\+\_\+available}} -\index{on\+\_\+read\+\_\+available@{on\+\_\+read\+\_\+available}!tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}} -\subsubsection{\texorpdfstring{on\+\_\+read\+\_\+available()}{on\_read\_available()}} -{\footnotesize\ttfamily void tacopie\+::tcp\+\_\+server\+::on\+\_\+read\+\_\+available (\begin{DoxyParamCaption}\item[{\hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t}}]{fd }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} - -io service read callback - - -\begin{DoxyParams}{Parameters} -{\em fd} & socket that triggered the read callback \\ -\hline -\end{DoxyParams} \mbox{\Hypertarget{classtacopie_1_1tcp__server_aa45611b77d60b536aeaf626d1724342d}\label{classtacopie_1_1tcp__server_aa45611b77d60b536aeaf626d1724342d}} \index{tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}!operator"!=@{operator"!=}} \index{operator"!=@{operator"!=}!tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}} @@ -192,16 +115,6 @@ \subsubsection{\texorpdfstring{operator"!=()}{operator!=()}} \begin{DoxyReturn}{Returns} true when the underlying sockets are different (different file descriptor or socket type). \end{DoxyReturn} -\mbox{\Hypertarget{classtacopie_1_1tcp__server_a7e7da4352e2e016f8d40d19bf9fee54b}\label{classtacopie_1_1tcp__server_a7e7da4352e2e016f8d40d19bf9fee54b}} -\index{tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}!operator=@{operator=}} -\index{operator=@{operator=}!tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}} -\subsubsection{\texorpdfstring{operator=()}{operator=()}} -{\footnotesize\ttfamily \hyperlink{classtacopie_1_1tcp__server}{tcp\+\_\+server}\& tacopie\+::tcp\+\_\+server\+::operator= (\begin{DoxyParamCaption}\item[{const \hyperlink{classtacopie_1_1tcp__server}{tcp\+\_\+server} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [delete]}} - - - -assignment operator - \mbox{\Hypertarget{classtacopie_1_1tcp__server_ab9b95a27afb405668bb4d5b1a312ceae}\label{classtacopie_1_1tcp__server_ab9b95a27afb405668bb4d5b1a312ceae}} \index{tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}!operator==@{operator==}} \index{operator==@{operator==}!tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}} @@ -247,45 +160,6 @@ \subsubsection{\texorpdfstring{stop()}{stop()}} \end{DoxyParams} -\subsection{Member Data Documentation} -\mbox{\Hypertarget{classtacopie_1_1tcp__server_ab3e475c59504150c4f3dc68bdb932670}\label{classtacopie_1_1tcp__server_ab3e475c59504150c4f3dc68bdb932670}} -\index{tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}!m\+\_\+clients@{m\+\_\+clients}} -\index{m\+\_\+clients@{m\+\_\+clients}!tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}} -\subsubsection{\texorpdfstring{m\+\_\+clients}{m\_clients}} -{\footnotesize\ttfamily std\+::list$<$std\+::shared\+\_\+ptr$<$\hyperlink{classtacopie_1_1tcp__client}{tacopie\+::tcp\+\_\+client}$>$ $>$ tacopie\+::tcp\+\_\+server\+::m\+\_\+clients\hspace{0.3cm}{\ttfamily [private]}} - -clients \mbox{\Hypertarget{classtacopie_1_1tcp__server_ad4ee31fe6e01a38bb2a3b11a0f29ab9a}\label{classtacopie_1_1tcp__server_ad4ee31fe6e01a38bb2a3b11a0f29ab9a}} -\index{tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}!m\+\_\+clients\+\_\+mtx@{m\+\_\+clients\+\_\+mtx}} -\index{m\+\_\+clients\+\_\+mtx@{m\+\_\+clients\+\_\+mtx}!tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}} -\subsubsection{\texorpdfstring{m\+\_\+clients\+\_\+mtx}{m\_clients\_mtx}} -{\footnotesize\ttfamily std\+::mutex tacopie\+::tcp\+\_\+server\+::m\+\_\+clients\+\_\+mtx\hspace{0.3cm}{\ttfamily [private]}} - -clients thread safety \mbox{\Hypertarget{classtacopie_1_1tcp__server_a91d9aa88e0de045dc0bb54cddf02e786}\label{classtacopie_1_1tcp__server_a91d9aa88e0de045dc0bb54cddf02e786}} -\index{tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}!m\+\_\+io\+\_\+service@{m\+\_\+io\+\_\+service}} -\index{m\+\_\+io\+\_\+service@{m\+\_\+io\+\_\+service}!tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}} -\subsubsection{\texorpdfstring{m\+\_\+io\+\_\+service}{m\_io\_service}} -{\footnotesize\ttfamily std\+::shared\+\_\+ptr$<$\hyperlink{classtacopie_1_1io__service}{io\+\_\+service}$>$ tacopie\+::tcp\+\_\+server\+::m\+\_\+io\+\_\+service\hspace{0.3cm}{\ttfamily [private]}} - -store \hyperlink{classtacopie_1_1io__service}{io\+\_\+service} prevent deletion of \hyperlink{classtacopie_1_1io__service}{io\+\_\+service} before the \hyperlink{classtacopie_1_1tcp__server}{tcp\+\_\+server} itself \mbox{\Hypertarget{classtacopie_1_1tcp__server_a7b7651a482cbc5bb19145b77fe322ced}\label{classtacopie_1_1tcp__server_a7b7651a482cbc5bb19145b77fe322ced}} -\index{tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}!m\+\_\+is\+\_\+running@{m\+\_\+is\+\_\+running}} -\index{m\+\_\+is\+\_\+running@{m\+\_\+is\+\_\+running}!tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}} -\subsubsection{\texorpdfstring{m\+\_\+is\+\_\+running}{m\_is\_running}} -{\footnotesize\ttfamily std\+::atomic$<$bool$>$ tacopie\+::tcp\+\_\+server\+::m\+\_\+is\+\_\+running = A\+T\+O\+M\+I\+C\+\_\+\+V\+A\+R\+\_\+\+I\+N\+IT(false)\hspace{0.3cm}{\ttfamily [private]}} - -whether the server is currently running or not \mbox{\Hypertarget{classtacopie_1_1tcp__server_a779d20d286c32e5daff0012548afdfd0}\label{classtacopie_1_1tcp__server_a779d20d286c32e5daff0012548afdfd0}} -\index{tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}!m\+\_\+on\+\_\+new\+\_\+connection\+\_\+callback@{m\+\_\+on\+\_\+new\+\_\+connection\+\_\+callback}} -\index{m\+\_\+on\+\_\+new\+\_\+connection\+\_\+callback@{m\+\_\+on\+\_\+new\+\_\+connection\+\_\+callback}!tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}} -\subsubsection{\texorpdfstring{m\+\_\+on\+\_\+new\+\_\+connection\+\_\+callback}{m\_on\_new\_connection\_callback}} -{\footnotesize\ttfamily \hyperlink{classtacopie_1_1tcp__server_a103cb4e6fcab00f88a708aabd38b66ff}{on\+\_\+new\+\_\+connection\+\_\+callback\+\_\+t} tacopie\+::tcp\+\_\+server\+::m\+\_\+on\+\_\+new\+\_\+connection\+\_\+callback\hspace{0.3cm}{\ttfamily [private]}} - -on new connection callback \mbox{\Hypertarget{classtacopie_1_1tcp__server_a2838c1b655a8c4f5ccb1e157afc17284}\label{classtacopie_1_1tcp__server_a2838c1b655a8c4f5ccb1e157afc17284}} -\index{tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}!m\+\_\+socket@{m\+\_\+socket}} -\index{m\+\_\+socket@{m\+\_\+socket}!tacopie\+::tcp\+\_\+server@{tacopie\+::tcp\+\_\+server}} -\subsubsection{\texorpdfstring{m\+\_\+socket}{m\_socket}} -{\footnotesize\ttfamily \hyperlink{classtacopie_1_1tcp__socket}{tacopie\+::tcp\+\_\+socket} tacopie\+::tcp\+\_\+server\+::m\+\_\+socket\hspace{0.3cm}{\ttfamily [private]}} - -server socket - The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize} \item -includes/tacopie/network/\hyperlink{tcp__server_8hpp}{tcp\+\_\+server.\+hpp}\end{DoxyCompactItemize} +includes/tacopie/network/tcp\+\_\+server.\+hpp\end{DoxyCompactItemize} diff --git a/docs/latex/classtacopie_1_1tcp__socket.tex b/docs/latex/classtacopie_1_1tcp__socket.tex index 13f9615..69cb6ae 100644 --- a/docs/latex/classtacopie_1_1tcp__socket.tex +++ b/docs/latex/classtacopie_1_1tcp__socket.tex @@ -7,24 +7,29 @@ \subsection*{Public Types} \begin{DoxyCompactItemize} \item -enum \hyperlink{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172ab}{type} \{ \hyperlink{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172abaef10c650df47bffd6399e5e78da2a9b1}{type\+::\+C\+L\+I\+E\+NT}, -\hyperlink{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172aba3d27c95bfdbea691b250894d96852844}{type\+::\+S\+E\+R\+V\+ER}, -\hyperlink{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172aba696b031073e74bf2cb98e5ef201d4aa3}{type\+::\+U\+N\+K\+N\+O\+WN} +enum \hyperlink{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172ab}{type} \{ {\bfseries C\+L\+I\+E\+NT}, +{\bfseries S\+E\+R\+V\+ER}, +{\bfseries U\+N\+K\+N\+O\+WN} \} \end{DoxyCompactItemize} \subsection*{Public Member Functions} \begin{DoxyCompactItemize} \item +\mbox{\Hypertarget{classtacopie_1_1tcp__socket_a88ed1cadb0263591c4d31805e0a1a001}\label{classtacopie_1_1tcp__socket_a88ed1cadb0263591c4d31805e0a1a001}} \hyperlink{classtacopie_1_1tcp__socket_a88ed1cadb0263591c4d31805e0a1a001}{tcp\+\_\+socket} (void) \begin{DoxyCompactList}\small\item\em ctor \end{DoxyCompactList}\item +\mbox{\Hypertarget{classtacopie_1_1tcp__socket_a4bd737a76a2a326be03d704f79a35282}\label{classtacopie_1_1tcp__socket_a4bd737a76a2a326be03d704f79a35282}} \hyperlink{classtacopie_1_1tcp__socket_a4bd737a76a2a326be03d704f79a35282}{$\sim$tcp\+\_\+socket} (void)=default \begin{DoxyCompactList}\small\item\em dtor \end{DoxyCompactList}\item -\hyperlink{classtacopie_1_1tcp__socket_a191ffa48e0753ad4ec87d4d3a4a97822}{tcp\+\_\+socket} (\hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t} fd, const std\+::string \&host, std\+::uint32\+\_\+t port, \hyperlink{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172ab}{type} t) +\hyperlink{classtacopie_1_1tcp__socket_a191ffa48e0753ad4ec87d4d3a4a97822}{tcp\+\_\+socket} (fd\+\_\+t fd, const std\+::string \&host, std\+::uint32\+\_\+t port, \hyperlink{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172ab}{type} t) \item +\mbox{\Hypertarget{classtacopie_1_1tcp__socket_a64f69cd1c185b523b543d4ea53cee1a2}\label{classtacopie_1_1tcp__socket_a64f69cd1c185b523b543d4ea53cee1a2}} \hyperlink{classtacopie_1_1tcp__socket_a64f69cd1c185b523b543d4ea53cee1a2}{tcp\+\_\+socket} (\hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&\&) \begin{DoxyCompactList}\small\item\em move ctor \end{DoxyCompactList}\item +\mbox{\Hypertarget{classtacopie_1_1tcp__socket_a5ae1a5b0f9713ef256164afdbeb1c193}\label{classtacopie_1_1tcp__socket_a5ae1a5b0f9713ef256164afdbeb1c193}} \hyperlink{classtacopie_1_1tcp__socket_a5ae1a5b0f9713ef256164afdbeb1c193}{tcp\+\_\+socket} (const \hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&)=delete \begin{DoxyCompactList}\small\item\em copy ctor \end{DoxyCompactList}\item +\mbox{\Hypertarget{classtacopie_1_1tcp__socket_aae3234c92bd36d5a614e44472d42bbf4}\label{classtacopie_1_1tcp__socket_aae3234c92bd36d5a614e44472d42bbf4}} \hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \& \hyperlink{classtacopie_1_1tcp__socket_aae3234c92bd36d5a614e44472d42bbf4}{operator=} (const \hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&)=delete \begin{DoxyCompactList}\small\item\em assignment operator \end{DoxyCompactList}\item bool \hyperlink{classtacopie_1_1tcp__socket_a69fde61058ab72d88ce48f557d8216cf}{operator==} (const \hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&rhs) const @@ -53,25 +58,7 @@ \subsection*{Public Member Functions} \item void \hyperlink{classtacopie_1_1tcp__socket_a89be86ab254eec3fc16eedfba8b16fb2}{set\+\_\+type} (\hyperlink{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172ab}{type} t) \item -\hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t} \hyperlink{classtacopie_1_1tcp__socket_a4fd367a1802ed6ae7fa0e33fc07ed255}{get\+\_\+fd} (void) const -\end{DoxyCompactItemize} -\subsection*{Private Member Functions} -\begin{DoxyCompactItemize} -\item -void \hyperlink{classtacopie_1_1tcp__socket_ac2f77e32211a33e0cf4fd8de33946761}{create\+\_\+socket\+\_\+if\+\_\+necessary} (void) -\item -void \hyperlink{classtacopie_1_1tcp__socket_a53067d6b401c7a7d8c8da3be0713480c}{check\+\_\+or\+\_\+set\+\_\+type} (\hyperlink{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172ab}{type} t) -\end{DoxyCompactItemize} -\subsection*{Private Attributes} -\begin{DoxyCompactItemize} -\item -\hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t} \hyperlink{classtacopie_1_1tcp__socket_a4787aed286af0211f97fd4d1518f7b66}{m\+\_\+fd} -\item -std\+::string \hyperlink{classtacopie_1_1tcp__socket_a739f43e1f58c67ae7551cfebbcc7394a}{m\+\_\+host} -\item -std\+::uint32\+\_\+t \hyperlink{classtacopie_1_1tcp__socket_ade0f7688a535423f1057b680bc131d1b}{m\+\_\+port} -\item -\hyperlink{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172ab}{type} \hyperlink{classtacopie_1_1tcp__socket_a26ee0857e7e640fa4296af1782bfef7f}{m\+\_\+type} +fd\+\_\+t \hyperlink{classtacopie_1_1tcp__socket_a4fd367a1802ed6ae7fa0e33fc07ed255}{get\+\_\+fd} (void) const \end{DoxyCompactItemize} @@ -87,48 +74,14 @@ \subsubsection{\texorpdfstring{type}{type}} possible types of a T\+CP socket, either a client or a server type is used to prevent the used of client specific operations on a server socket (and vice-\/versa) -U\+N\+K\+N\+O\+WN is used when socket type could not be determined for now \begin{DoxyEnumFields}{Enumerator} -\raisebox{\heightof{T}}[0pt][0pt]{\index{C\+L\+I\+E\+NT@{C\+L\+I\+E\+NT}!tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}}\index{tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}!C\+L\+I\+E\+NT@{C\+L\+I\+E\+NT}}}\mbox{\Hypertarget{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172abaef10c650df47bffd6399e5e78da2a9b1}\label{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172abaef10c650df47bffd6399e5e78da2a9b1}} -C\+L\+I\+E\+NT&\\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{S\+E\+R\+V\+ER@{S\+E\+R\+V\+ER}!tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}}\index{tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}!S\+E\+R\+V\+ER@{S\+E\+R\+V\+ER}}}\mbox{\Hypertarget{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172aba3d27c95bfdbea691b250894d96852844}\label{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172aba3d27c95bfdbea691b250894d96852844}} -S\+E\+R\+V\+ER&\\ -\hline - -\raisebox{\heightof{T}}[0pt][0pt]{\index{U\+N\+K\+N\+O\+WN@{U\+N\+K\+N\+O\+WN}!tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}}\index{tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}!U\+N\+K\+N\+O\+WN@{U\+N\+K\+N\+O\+WN}}}\mbox{\Hypertarget{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172aba696b031073e74bf2cb98e5ef201d4aa3}\label{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172aba696b031073e74bf2cb98e5ef201d4aa3}} -U\+N\+K\+N\+O\+WN&\\ -\hline - -\end{DoxyEnumFields} - +U\+N\+K\+N\+O\+WN is used when socket type could not be determined for now \subsection{Constructor \& Destructor Documentation} -\mbox{\Hypertarget{classtacopie_1_1tcp__socket_a88ed1cadb0263591c4d31805e0a1a001}\label{classtacopie_1_1tcp__socket_a88ed1cadb0263591c4d31805e0a1a001}} -\index{tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}!tcp\+\_\+socket@{tcp\+\_\+socket}} -\index{tcp\+\_\+socket@{tcp\+\_\+socket}!tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}} -\subsubsection{\texorpdfstring{tcp\+\_\+socket()}{tcp\_socket()}\hspace{0.1cm}{\footnotesize\ttfamily [1/4]}} -{\footnotesize\ttfamily tacopie\+::tcp\+\_\+socket\+::tcp\+\_\+socket (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - - - -ctor - -\mbox{\Hypertarget{classtacopie_1_1tcp__socket_a4bd737a76a2a326be03d704f79a35282}\label{classtacopie_1_1tcp__socket_a4bd737a76a2a326be03d704f79a35282}} -\index{tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}!````~tcp\+\_\+socket@{$\sim$tcp\+\_\+socket}} -\index{````~tcp\+\_\+socket@{$\sim$tcp\+\_\+socket}!tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}} -\subsubsection{\texorpdfstring{$\sim$tcp\+\_\+socket()}{~tcp\_socket()}} -{\footnotesize\ttfamily tacopie\+::tcp\+\_\+socket\+::$\sim$tcp\+\_\+socket (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [default]}} - - - -dtor - \mbox{\Hypertarget{classtacopie_1_1tcp__socket_a191ffa48e0753ad4ec87d4d3a4a97822}\label{classtacopie_1_1tcp__socket_a191ffa48e0753ad4ec87d4d3a4a97822}} \index{tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}!tcp\+\_\+socket@{tcp\+\_\+socket}} \index{tcp\+\_\+socket@{tcp\+\_\+socket}!tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}} -\subsubsection{\texorpdfstring{tcp\+\_\+socket()}{tcp\_socket()}\hspace{0.1cm}{\footnotesize\ttfamily [2/4]}} -{\footnotesize\ttfamily tacopie\+::tcp\+\_\+socket\+::tcp\+\_\+socket (\begin{DoxyParamCaption}\item[{\hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t}}]{fd, }\item[{const std\+::string \&}]{host, }\item[{std\+::uint32\+\_\+t}]{port, }\item[{\hyperlink{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172ab}{type}}]{t }\end{DoxyParamCaption})} +\subsubsection{\texorpdfstring{tcp\+\_\+socket()}{tcp\_socket()}} +{\footnotesize\ttfamily tacopie\+::tcp\+\_\+socket\+::tcp\+\_\+socket (\begin{DoxyParamCaption}\item[{fd\+\_\+t}]{fd, }\item[{const std\+::string \&}]{host, }\item[{std\+::uint32\+\_\+t}]{port, }\item[{\hyperlink{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172ab}{type}}]{t }\end{DoxyParamCaption})} custom ctor build socket from existing file descriptor @@ -143,26 +96,6 @@ \subsubsection{\texorpdfstring{tcp\+\_\+socket()}{tcp\_socket()}\hspace{0.1cm}{\ {\em t} & type of the socket (client or server) \\ \hline \end{DoxyParams} -\mbox{\Hypertarget{classtacopie_1_1tcp__socket_a64f69cd1c185b523b543d4ea53cee1a2}\label{classtacopie_1_1tcp__socket_a64f69cd1c185b523b543d4ea53cee1a2}} -\index{tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}!tcp\+\_\+socket@{tcp\+\_\+socket}} -\index{tcp\+\_\+socket@{tcp\+\_\+socket}!tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}} -\subsubsection{\texorpdfstring{tcp\+\_\+socket()}{tcp\_socket()}\hspace{0.1cm}{\footnotesize\ttfamily [3/4]}} -{\footnotesize\ttfamily tacopie\+::tcp\+\_\+socket\+::tcp\+\_\+socket (\begin{DoxyParamCaption}\item[{\hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&\&}]{ }\end{DoxyParamCaption})} - - - -move ctor - -\mbox{\Hypertarget{classtacopie_1_1tcp__socket_a5ae1a5b0f9713ef256164afdbeb1c193}\label{classtacopie_1_1tcp__socket_a5ae1a5b0f9713ef256164afdbeb1c193}} -\index{tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}!tcp\+\_\+socket@{tcp\+\_\+socket}} -\index{tcp\+\_\+socket@{tcp\+\_\+socket}!tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}} -\subsubsection{\texorpdfstring{tcp\+\_\+socket()}{tcp\_socket()}\hspace{0.1cm}{\footnotesize\ttfamily [4/4]}} -{\footnotesize\ttfamily tacopie\+::tcp\+\_\+socket\+::tcp\+\_\+socket (\begin{DoxyParamCaption}\item[{const \hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [delete]}} - - - -copy ctor - \subsection{Member Function Documentation} @@ -192,19 +125,6 @@ \subsubsection{\texorpdfstring{bind()}{bind()}} {\em port} & Port to be bind to \\ \hline \end{DoxyParams} -\mbox{\Hypertarget{classtacopie_1_1tcp__socket_a53067d6b401c7a7d8c8da3be0713480c}\label{classtacopie_1_1tcp__socket_a53067d6b401c7a7d8c8da3be0713480c}} -\index{tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}!check\+\_\+or\+\_\+set\+\_\+type@{check\+\_\+or\+\_\+set\+\_\+type}} -\index{check\+\_\+or\+\_\+set\+\_\+type@{check\+\_\+or\+\_\+set\+\_\+type}!tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}} -\subsubsection{\texorpdfstring{check\+\_\+or\+\_\+set\+\_\+type()}{check\_or\_set\_type()}} -{\footnotesize\ttfamily void tacopie\+::tcp\+\_\+socket\+::check\+\_\+or\+\_\+set\+\_\+type (\begin{DoxyParamCaption}\item[{\hyperlink{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172ab}{type}}]{t }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} - -check whether the current socket has an approriate type for that kind of operation if current type is U\+N\+K\+N\+O\+WN, update internal type with given type - - -\begin{DoxyParams}{Parameters} -{\em t} & expected type of our socket to process the operation \\ -\hline -\end{DoxyParams} \mbox{\Hypertarget{classtacopie_1_1tcp__socket_ad5a30b17b1dad9f0ff40305e246a9213}\label{classtacopie_1_1tcp__socket_ad5a30b17b1dad9f0ff40305e246a9213}} \index{tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}!close@{close}} \index{close@{close}!tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}} @@ -228,17 +148,11 @@ \subsubsection{\texorpdfstring{connect()}{connect()}} {\em timeout\+\_\+msecs} & maximum time to connect (will block until connect succeed or timeout expire). 0 will block undefinitely. If timeout expires, connection fails \\ \hline \end{DoxyParams} -\mbox{\Hypertarget{classtacopie_1_1tcp__socket_ac2f77e32211a33e0cf4fd8de33946761}\label{classtacopie_1_1tcp__socket_ac2f77e32211a33e0cf4fd8de33946761}} -\index{tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}!create\+\_\+socket\+\_\+if\+\_\+necessary@{create\+\_\+socket\+\_\+if\+\_\+necessary}} -\index{create\+\_\+socket\+\_\+if\+\_\+necessary@{create\+\_\+socket\+\_\+if\+\_\+necessary}!tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}} -\subsubsection{\texorpdfstring{create\+\_\+socket\+\_\+if\+\_\+necessary()}{create\_socket\_if\_necessary()}} -{\footnotesize\ttfamily void tacopie\+::tcp\+\_\+socket\+::create\+\_\+socket\+\_\+if\+\_\+necessary (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} - -create a new socket if no socket has been initialized yet \mbox{\Hypertarget{classtacopie_1_1tcp__socket_a4fd367a1802ed6ae7fa0e33fc07ed255}\label{classtacopie_1_1tcp__socket_a4fd367a1802ed6ae7fa0e33fc07ed255}} +\mbox{\Hypertarget{classtacopie_1_1tcp__socket_a4fd367a1802ed6ae7fa0e33fc07ed255}\label{classtacopie_1_1tcp__socket_a4fd367a1802ed6ae7fa0e33fc07ed255}} \index{tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}!get\+\_\+fd@{get\+\_\+fd}} \index{get\+\_\+fd@{get\+\_\+fd}!tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}} \subsubsection{\texorpdfstring{get\+\_\+fd()}{get\_fd()}} -{\footnotesize\ttfamily \hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t} tacopie\+::tcp\+\_\+socket\+::get\+\_\+fd (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const} +{\footnotesize\ttfamily fd\+\_\+t tacopie\+::tcp\+\_\+socket\+::get\+\_\+fd (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const} direct access to the underlying fd @@ -296,16 +210,6 @@ \subsubsection{\texorpdfstring{operator"!=()}{operator!=()}} \begin{DoxyReturn}{Returns} true when the underlying sockets are different (different file descriptor or socket type). \end{DoxyReturn} -\mbox{\Hypertarget{classtacopie_1_1tcp__socket_aae3234c92bd36d5a614e44472d42bbf4}\label{classtacopie_1_1tcp__socket_aae3234c92bd36d5a614e44472d42bbf4}} -\index{tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}!operator=@{operator=}} -\index{operator=@{operator=}!tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}} -\subsubsection{\texorpdfstring{operator=()}{operator=()}} -{\footnotesize\ttfamily \hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket}\& tacopie\+::tcp\+\_\+socket\+::operator= (\begin{DoxyParamCaption}\item[{const \hyperlink{classtacopie_1_1tcp__socket}{tcp\+\_\+socket} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [delete]}} - - - -assignment operator - \mbox{\Hypertarget{classtacopie_1_1tcp__socket_a69fde61058ab72d88ce48f557d8216cf}\label{classtacopie_1_1tcp__socket_a69fde61058ab72d88ce48f557d8216cf}} \index{tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}!operator==@{operator==}} \index{operator==@{operator==}!tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}} @@ -366,33 +270,6 @@ \subsubsection{\texorpdfstring{set\+\_\+type()}{set\_type()}} \end{DoxyParams} -\subsection{Member Data Documentation} -\mbox{\Hypertarget{classtacopie_1_1tcp__socket_a4787aed286af0211f97fd4d1518f7b66}\label{classtacopie_1_1tcp__socket_a4787aed286af0211f97fd4d1518f7b66}} -\index{tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}!m\+\_\+fd@{m\+\_\+fd}} -\index{m\+\_\+fd@{m\+\_\+fd}!tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}} -\subsubsection{\texorpdfstring{m\+\_\+fd}{m\_fd}} -{\footnotesize\ttfamily \hyperlink{namespacetacopie_acce7ad26b2d30156b1e6fa353f727026}{fd\+\_\+t} tacopie\+::tcp\+\_\+socket\+::m\+\_\+fd\hspace{0.3cm}{\ttfamily [private]}} - -fd associated to the socket \mbox{\Hypertarget{classtacopie_1_1tcp__socket_a739f43e1f58c67ae7551cfebbcc7394a}\label{classtacopie_1_1tcp__socket_a739f43e1f58c67ae7551cfebbcc7394a}} -\index{tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}!m\+\_\+host@{m\+\_\+host}} -\index{m\+\_\+host@{m\+\_\+host}!tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}} -\subsubsection{\texorpdfstring{m\+\_\+host}{m\_host}} -{\footnotesize\ttfamily std\+::string tacopie\+::tcp\+\_\+socket\+::m\+\_\+host\hspace{0.3cm}{\ttfamily [private]}} - -socket hostname information \mbox{\Hypertarget{classtacopie_1_1tcp__socket_ade0f7688a535423f1057b680bc131d1b}\label{classtacopie_1_1tcp__socket_ade0f7688a535423f1057b680bc131d1b}} -\index{tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}!m\+\_\+port@{m\+\_\+port}} -\index{m\+\_\+port@{m\+\_\+port}!tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}} -\subsubsection{\texorpdfstring{m\+\_\+port}{m\_port}} -{\footnotesize\ttfamily std\+::uint32\+\_\+t tacopie\+::tcp\+\_\+socket\+::m\+\_\+port\hspace{0.3cm}{\ttfamily [private]}} - -socket port information \mbox{\Hypertarget{classtacopie_1_1tcp__socket_a26ee0857e7e640fa4296af1782bfef7f}\label{classtacopie_1_1tcp__socket_a26ee0857e7e640fa4296af1782bfef7f}} -\index{tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}!m\+\_\+type@{m\+\_\+type}} -\index{m\+\_\+type@{m\+\_\+type}!tacopie\+::tcp\+\_\+socket@{tacopie\+::tcp\+\_\+socket}} -\subsubsection{\texorpdfstring{m\+\_\+type}{m\_type}} -{\footnotesize\ttfamily \hyperlink{classtacopie_1_1tcp__socket_ad8376e85df96ab9523f5d079ed7172ab}{type} tacopie\+::tcp\+\_\+socket\+::m\+\_\+type\hspace{0.3cm}{\ttfamily [private]}} - -type of the socket - The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize} \item -includes/tacopie/network/\hyperlink{tcp__socket_8hpp}{tcp\+\_\+socket.\+hpp}\end{DoxyCompactItemize} +includes/tacopie/network/tcp\+\_\+socket.\+hpp\end{DoxyCompactItemize} diff --git a/docs/latex/classtacopie_1_1utils_1_1thread__pool.tex b/docs/latex/classtacopie_1_1utils_1_1thread__pool.tex index 0637387..3bcc788 100644 --- a/docs/latex/classtacopie_1_1utils_1_1thread__pool.tex +++ b/docs/latex/classtacopie_1_1utils_1_1thread__pool.tex @@ -1,9 +1,5 @@ \hypertarget{classtacopie_1_1utils_1_1thread__pool}{}\section{tacopie\+:\+:utils\+:\+:thread\+\_\+pool Class Reference} \label{classtacopie_1_1utils_1_1thread__pool}\index{tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}} - - -{\ttfamily \#include $<$thread\+\_\+pool.\+hpp$>$} - \subsection*{Public Types} \begin{DoxyCompactItemize} \item @@ -14,10 +10,13 @@ \subsection*{Public Member Functions} \item \hyperlink{classtacopie_1_1utils_1_1thread__pool_aa0068f000b8ecb21b2b0a0c50f77877c}{thread\+\_\+pool} (std\+::size\+\_\+t nb\+\_\+threads) \item +\mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_accddfc6fad613b0c6d407028799abfc5}\label{classtacopie_1_1utils_1_1thread__pool_accddfc6fad613b0c6d407028799abfc5}} \hyperlink{classtacopie_1_1utils_1_1thread__pool_accddfc6fad613b0c6d407028799abfc5}{$\sim$thread\+\_\+pool} (void) \begin{DoxyCompactList}\small\item\em dtor \end{DoxyCompactList}\item +\mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_a63a850c39d21058eda9d655bb7eff452}\label{classtacopie_1_1utils_1_1thread__pool_a63a850c39d21058eda9d655bb7eff452}} \hyperlink{classtacopie_1_1utils_1_1thread__pool_a63a850c39d21058eda9d655bb7eff452}{thread\+\_\+pool} (const \hyperlink{classtacopie_1_1utils_1_1thread__pool}{thread\+\_\+pool} \&)=delete \begin{DoxyCompactList}\small\item\em copy ctor \end{DoxyCompactList}\item +\mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_aa0077461da4da6ba3f4dcac029351234}\label{classtacopie_1_1utils_1_1thread__pool_aa0077461da4da6ba3f4dcac029351234}} \hyperlink{classtacopie_1_1utils_1_1thread__pool}{thread\+\_\+pool} \& \hyperlink{classtacopie_1_1utils_1_1thread__pool_aa0077461da4da6ba3f4dcac029351234}{operator=} (const \hyperlink{classtacopie_1_1utils_1_1thread__pool}{thread\+\_\+pool} \&)=delete \begin{DoxyCompactList}\small\item\em assignment operator \end{DoxyCompactList}\item void \hyperlink{classtacopie_1_1utils_1_1thread__pool_a450bee2b7b2cd0aa0bc3935c8adc9ace}{add\+\_\+task} (const \hyperlink{classtacopie_1_1utils_1_1thread__pool_a8ae8886fdeaa8e5c0abad12626a47296}{task\+\_\+t} \&task) @@ -30,30 +29,6 @@ \subsection*{Public Member Functions} \item void \hyperlink{classtacopie_1_1utils_1_1thread__pool_a7c7ae922cedff8fa323828ebb6dea829}{set\+\_\+nb\+\_\+threads} (std\+::size\+\_\+t nb\+\_\+threads) \end{DoxyCompactItemize} -\subsection*{Private Member Functions} -\begin{DoxyCompactItemize} -\item -void \hyperlink{classtacopie_1_1utils_1_1thread__pool_a6e4ae0994faf97d0d260c1f846ff4639}{run} (void) -\item -\hyperlink{classtacopie_1_1utils_1_1thread__pool_a8ae8886fdeaa8e5c0abad12626a47296}{task\+\_\+t} \hyperlink{classtacopie_1_1utils_1_1thread__pool_a182472a7727edc7d37d2309ccbc2dea7}{fetch\+\_\+task} (void) -\item -bool \hyperlink{classtacopie_1_1utils_1_1thread__pool_a7a4dbfe7877e2ce8a4189e6f3d3da3a9}{should\+\_\+stop} (void) const -\end{DoxyCompactItemize} -\subsection*{Private Attributes} -\begin{DoxyCompactItemize} -\item -std\+::vector$<$ std\+::thread $>$ \hyperlink{classtacopie_1_1utils_1_1thread__pool_a5250ed4fbe845c69e3e28cb7edf4d796}{m\+\_\+workers} -\item -std\+::size\+\_\+t \hyperlink{classtacopie_1_1utils_1_1thread__pool_acb37b2e75b5b0ded2b3bc3174c7ba43f}{m\+\_\+nb\+\_\+threads} -\item -std\+::atomic$<$ bool $>$ \hyperlink{classtacopie_1_1utils_1_1thread__pool_a1463eb81724978e4c694b8409528b00a}{m\+\_\+should\+\_\+stop} = A\+T\+O\+M\+I\+C\+\_\+\+V\+A\+R\+\_\+\+I\+N\+IT(false) -\item -std\+::queue$<$ \hyperlink{classtacopie_1_1utils_1_1thread__pool_a8ae8886fdeaa8e5c0abad12626a47296}{task\+\_\+t} $>$ \hyperlink{classtacopie_1_1utils_1_1thread__pool_ad00580e9ab77e128cffaf35d80223291}{m\+\_\+tasks} -\item -std\+::mutex \hyperlink{classtacopie_1_1utils_1_1thread__pool_aeae956282edc4d2171ee2e408cb1189f}{m\+\_\+tasks\+\_\+mtx} -\item -std\+::condition\+\_\+variable \hyperlink{classtacopie_1_1utils_1_1thread__pool_a6f5122cc6ef6429fdb778a6e6c37216b}{m\+\_\+tasks\+\_\+condvar} -\end{DoxyCompactItemize} \subsection{Member Typedef Documentation} @@ -69,7 +44,7 @@ \subsection{Constructor \& Destructor Documentation} \mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_aa0068f000b8ecb21b2b0a0c50f77877c}\label{classtacopie_1_1utils_1_1thread__pool_aa0068f000b8ecb21b2b0a0c50f77877c}} \index{tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}!thread\+\_\+pool@{thread\+\_\+pool}} \index{thread\+\_\+pool@{thread\+\_\+pool}!tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}} -\subsubsection{\texorpdfstring{thread\+\_\+pool()}{thread\_pool()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} +\subsubsection{\texorpdfstring{thread\+\_\+pool()}{thread\_pool()}} {\footnotesize\ttfamily tacopie\+::utils\+::thread\+\_\+pool\+::thread\+\_\+pool (\begin{DoxyParamCaption}\item[{std\+::size\+\_\+t}]{nb\+\_\+threads }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [explicit]}} ctor created the worker thread that start working immediately @@ -79,26 +54,6 @@ \subsubsection{\texorpdfstring{thread\+\_\+pool()}{thread\_pool()}\hspace{0.1cm} {\em nb\+\_\+threads} & number of threads to start the thread pool \\ \hline \end{DoxyParams} -\mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_accddfc6fad613b0c6d407028799abfc5}\label{classtacopie_1_1utils_1_1thread__pool_accddfc6fad613b0c6d407028799abfc5}} -\index{tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}!````~thread\+\_\+pool@{$\sim$thread\+\_\+pool}} -\index{````~thread\+\_\+pool@{$\sim$thread\+\_\+pool}!tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}} -\subsubsection{\texorpdfstring{$\sim$thread\+\_\+pool()}{~thread\_pool()}} -{\footnotesize\ttfamily tacopie\+::utils\+::thread\+\_\+pool\+::$\sim$thread\+\_\+pool (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})} - - - -dtor - -\mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_a63a850c39d21058eda9d655bb7eff452}\label{classtacopie_1_1utils_1_1thread__pool_a63a850c39d21058eda9d655bb7eff452}} -\index{tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}!thread\+\_\+pool@{thread\+\_\+pool}} -\index{thread\+\_\+pool@{thread\+\_\+pool}!tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}} -\subsubsection{\texorpdfstring{thread\+\_\+pool()}{thread\_pool()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily tacopie\+::utils\+::thread\+\_\+pool\+::thread\+\_\+pool (\begin{DoxyParamCaption}\item[{const \hyperlink{classtacopie_1_1utils_1_1thread__pool}{thread\+\_\+pool} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [delete]}} - - - -copy ctor - \subsection{Member Function Documentation} @@ -115,13 +70,7 @@ \subsubsection{\texorpdfstring{add\+\_\+task()}{add\_task()}} {\em task} & task to be executed by the threadpool \\ \hline \end{DoxyParams} -\mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_a182472a7727edc7d37d2309ccbc2dea7}\label{classtacopie_1_1utils_1_1thread__pool_a182472a7727edc7d37d2309ccbc2dea7}} -\index{tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}!fetch\+\_\+task@{fetch\+\_\+task}} -\index{fetch\+\_\+task@{fetch\+\_\+task}!tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}} -\subsubsection{\texorpdfstring{fetch\+\_\+task()}{fetch\_task()}} -{\footnotesize\ttfamily \hyperlink{classtacopie_1_1utils_1_1thread__pool_a8ae8886fdeaa8e5c0abad12626a47296}{task\+\_\+t} tacopie\+::utils\+::thread\+\_\+pool\+::fetch\+\_\+task (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} - -retrieve a new task fetch the first element in the queue, or wait if no task are available may return null if the threadpool is stopped \mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_a77a647a75be188a5c5f83b922c061107}\label{classtacopie_1_1utils_1_1thread__pool_a77a647a75be188a5c5f83b922c061107}} +\mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_a77a647a75be188a5c5f83b922c061107}\label{classtacopie_1_1utils_1_1thread__pool_a77a647a75be188a5c5f83b922c061107}} \index{tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}!is\+\_\+running@{is\+\_\+running}} \index{is\+\_\+running@{is\+\_\+running}!tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}} \subsubsection{\texorpdfstring{is\+\_\+running()}{is\_running()}} @@ -146,23 +95,7 @@ \subsubsection{\texorpdfstring{operator$<$$<$()}{operator<<()}} \begin{DoxyReturn}{Returns} current instance \end{DoxyReturn} -\mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_aa0077461da4da6ba3f4dcac029351234}\label{classtacopie_1_1utils_1_1thread__pool_aa0077461da4da6ba3f4dcac029351234}} -\index{tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}!operator=@{operator=}} -\index{operator=@{operator=}!tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}} -\subsubsection{\texorpdfstring{operator=()}{operator=()}} -{\footnotesize\ttfamily \hyperlink{classtacopie_1_1utils_1_1thread__pool}{thread\+\_\+pool}\& tacopie\+::utils\+::thread\+\_\+pool\+::operator= (\begin{DoxyParamCaption}\item[{const \hyperlink{classtacopie_1_1utils_1_1thread__pool}{thread\+\_\+pool} \&}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [delete]}} - - - -assignment operator - -\mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_a6e4ae0994faf97d0d260c1f846ff4639}\label{classtacopie_1_1utils_1_1thread__pool_a6e4ae0994faf97d0d260c1f846ff4639}} -\index{tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}!run@{run}} -\index{run@{run}!tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}} -\subsubsection{\texorpdfstring{run()}{run()}} -{\footnotesize\ttfamily void tacopie\+::utils\+::thread\+\_\+pool\+::run (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} - -worker main loop \mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_a7c7ae922cedff8fa323828ebb6dea829}\label{classtacopie_1_1utils_1_1thread__pool_a7c7ae922cedff8fa323828ebb6dea829}} +\mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_a7c7ae922cedff8fa323828ebb6dea829}\label{classtacopie_1_1utils_1_1thread__pool_a7c7ae922cedff8fa323828ebb6dea829}} \index{tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}!set\+\_\+nb\+\_\+threads@{set\+\_\+nb\+\_\+threads}} \index{set\+\_\+nb\+\_\+threads@{set\+\_\+nb\+\_\+threads}!tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}} \subsubsection{\texorpdfstring{set\+\_\+nb\+\_\+threads()}{set\_nb\_threads()}} @@ -179,15 +112,6 @@ \subsubsection{\texorpdfstring{set\+\_\+nb\+\_\+threads()}{set\_nb\_threads()}} {\em nb\+\_\+threads} & number of threads \\ \hline \end{DoxyParams} -\mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_a7a4dbfe7877e2ce8a4189e6f3d3da3a9}\label{classtacopie_1_1utils_1_1thread__pool_a7a4dbfe7877e2ce8a4189e6f3d3da3a9}} -\index{tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}!should\+\_\+stop@{should\+\_\+stop}} -\index{should\+\_\+stop@{should\+\_\+stop}!tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}} -\subsubsection{\texorpdfstring{should\+\_\+stop()}{should\_stop()}} -{\footnotesize\ttfamily bool tacopie\+::utils\+::thread\+\_\+pool\+::should\+\_\+stop (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [private]}} - -\begin{DoxyReturn}{Returns} -whether the thread should stop or not -\end{DoxyReturn} \mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_a8874d7040d12fbe446519bc9f2bcff37}\label{classtacopie_1_1utils_1_1thread__pool_a8874d7040d12fbe446519bc9f2bcff37}} \index{tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}!stop@{stop}} \index{stop@{stop}!tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}} @@ -196,45 +120,6 @@ \subsubsection{\texorpdfstring{stop()}{stop()}} stop the thread pool and wait for workers completion if some tasks are pending, they won\textquotesingle{}t be executed -\subsection{Member Data Documentation} -\mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_acb37b2e75b5b0ded2b3bc3174c7ba43f}\label{classtacopie_1_1utils_1_1thread__pool_acb37b2e75b5b0ded2b3bc3174c7ba43f}} -\index{tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}!m\+\_\+nb\+\_\+threads@{m\+\_\+nb\+\_\+threads}} -\index{m\+\_\+nb\+\_\+threads@{m\+\_\+nb\+\_\+threads}!tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}} -\subsubsection{\texorpdfstring{m\+\_\+nb\+\_\+threads}{m\_nb\_threads}} -{\footnotesize\ttfamily std\+::size\+\_\+t tacopie\+::utils\+::thread\+\_\+pool\+::m\+\_\+nb\+\_\+threads\hspace{0.3cm}{\ttfamily [private]}} - -number of threads allowed \mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_a1463eb81724978e4c694b8409528b00a}\label{classtacopie_1_1utils_1_1thread__pool_a1463eb81724978e4c694b8409528b00a}} -\index{tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}!m\+\_\+should\+\_\+stop@{m\+\_\+should\+\_\+stop}} -\index{m\+\_\+should\+\_\+stop@{m\+\_\+should\+\_\+stop}!tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}} -\subsubsection{\texorpdfstring{m\+\_\+should\+\_\+stop}{m\_should\_stop}} -{\footnotesize\ttfamily std\+::atomic$<$bool$>$ tacopie\+::utils\+::thread\+\_\+pool\+::m\+\_\+should\+\_\+stop = A\+T\+O\+M\+I\+C\+\_\+\+V\+A\+R\+\_\+\+I\+N\+IT(false)\hspace{0.3cm}{\ttfamily [private]}} - -whether the \hyperlink{classtacopie_1_1utils_1_1thread__pool}{thread\+\_\+pool} should stop or not \mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_ad00580e9ab77e128cffaf35d80223291}\label{classtacopie_1_1utils_1_1thread__pool_ad00580e9ab77e128cffaf35d80223291}} -\index{tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}!m\+\_\+tasks@{m\+\_\+tasks}} -\index{m\+\_\+tasks@{m\+\_\+tasks}!tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}} -\subsubsection{\texorpdfstring{m\+\_\+tasks}{m\_tasks}} -{\footnotesize\ttfamily std\+::queue$<$\hyperlink{classtacopie_1_1utils_1_1thread__pool_a8ae8886fdeaa8e5c0abad12626a47296}{task\+\_\+t}$>$ tacopie\+::utils\+::thread\+\_\+pool\+::m\+\_\+tasks\hspace{0.3cm}{\ttfamily [private]}} - -tasks \mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_a6f5122cc6ef6429fdb778a6e6c37216b}\label{classtacopie_1_1utils_1_1thread__pool_a6f5122cc6ef6429fdb778a6e6c37216b}} -\index{tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}!m\+\_\+tasks\+\_\+condvar@{m\+\_\+tasks\+\_\+condvar}} -\index{m\+\_\+tasks\+\_\+condvar@{m\+\_\+tasks\+\_\+condvar}!tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}} -\subsubsection{\texorpdfstring{m\+\_\+tasks\+\_\+condvar}{m\_tasks\_condvar}} -{\footnotesize\ttfamily std\+::condition\+\_\+variable tacopie\+::utils\+::thread\+\_\+pool\+::m\+\_\+tasks\+\_\+condvar\hspace{0.3cm}{\ttfamily [private]}} - -task condvar to sync on tasks changes \mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_aeae956282edc4d2171ee2e408cb1189f}\label{classtacopie_1_1utils_1_1thread__pool_aeae956282edc4d2171ee2e408cb1189f}} -\index{tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}!m\+\_\+tasks\+\_\+mtx@{m\+\_\+tasks\+\_\+mtx}} -\index{m\+\_\+tasks\+\_\+mtx@{m\+\_\+tasks\+\_\+mtx}!tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}} -\subsubsection{\texorpdfstring{m\+\_\+tasks\+\_\+mtx}{m\_tasks\_mtx}} -{\footnotesize\ttfamily std\+::mutex tacopie\+::utils\+::thread\+\_\+pool\+::m\+\_\+tasks\+\_\+mtx\hspace{0.3cm}{\ttfamily [private]}} - -tasks thread safety \mbox{\Hypertarget{classtacopie_1_1utils_1_1thread__pool_a5250ed4fbe845c69e3e28cb7edf4d796}\label{classtacopie_1_1utils_1_1thread__pool_a5250ed4fbe845c69e3e28cb7edf4d796}} -\index{tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}!m\+\_\+workers@{m\+\_\+workers}} -\index{m\+\_\+workers@{m\+\_\+workers}!tacopie\+::utils\+::thread\+\_\+pool@{tacopie\+::utils\+::thread\+\_\+pool}} -\subsubsection{\texorpdfstring{m\+\_\+workers}{m\_workers}} -{\footnotesize\ttfamily std\+::vector$<$std\+::thread$>$ tacopie\+::utils\+::thread\+\_\+pool\+::m\+\_\+workers\hspace{0.3cm}{\ttfamily [private]}} - -threads - The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize} \item -includes/tacopie/utils/\hyperlink{thread__pool_8hpp}{thread\+\_\+pool.\+hpp}\end{DoxyCompactItemize} +includes/tacopie/utils/thread\+\_\+pool.\+hpp\end{DoxyCompactItemize} diff --git a/docs/latex/dir_09e761304027c904456130627fd4dcf5.tex b/docs/latex/dir_09e761304027c904456130627fd4dcf5.tex index 343e0fa..e21f53b 100644 --- a/docs/latex/dir_09e761304027c904456130627fd4dcf5.tex +++ b/docs/latex/dir_09e761304027c904456130627fd4dcf5.tex @@ -1,7 +1,2 @@ \hypertarget{dir_09e761304027c904456130627fd4dcf5}{}\section{includes Directory Reference} \label{dir_09e761304027c904456130627fd4dcf5}\index{includes Directory Reference@{includes Directory Reference}} -\subsection*{Directories} -\begin{DoxyCompactItemize} -\item -directory \hyperlink{dir_9a013686e2522dd95763481288c1f90f}{tacopie} -\end{DoxyCompactItemize} diff --git a/docs/latex/dir_1619eefbac1db14eaf18adaf83ce3ccc.tex b/docs/latex/dir_1619eefbac1db14eaf18adaf83ce3ccc.tex index ed52842..8c6ebe2 100644 --- a/docs/latex/dir_1619eefbac1db14eaf18adaf83ce3ccc.tex +++ b/docs/latex/dir_1619eefbac1db14eaf18adaf83ce3ccc.tex @@ -1,15 +1,2 @@ \hypertarget{dir_1619eefbac1db14eaf18adaf83ce3ccc}{}\section{includes/tacopie/network Directory Reference} \label{dir_1619eefbac1db14eaf18adaf83ce3ccc}\index{includes/tacopie/network Directory Reference@{includes/tacopie/network Directory Reference}} -\subsection*{Files} -\begin{DoxyCompactItemize} -\item -file \hyperlink{io__service_8hpp}{io\+\_\+service.\+hpp} -\item -file \hyperlink{self__pipe_8hpp}{self\+\_\+pipe.\+hpp} -\item -file \hyperlink{tcp__client_8hpp}{tcp\+\_\+client.\+hpp} -\item -file \hyperlink{tcp__server_8hpp}{tcp\+\_\+server.\+hpp} -\item -file \hyperlink{tcp__socket_8hpp}{tcp\+\_\+socket.\+hpp} -\end{DoxyCompactItemize} diff --git a/docs/latex/dir_38b559f7600c1df65fbc4b39f02eb3f8.tex b/docs/latex/dir_38b559f7600c1df65fbc4b39f02eb3f8.tex index 1985f03..2f69748 100644 --- a/docs/latex/dir_38b559f7600c1df65fbc4b39f02eb3f8.tex +++ b/docs/latex/dir_38b559f7600c1df65fbc4b39f02eb3f8.tex @@ -1,13 +1,2 @@ \hypertarget{dir_38b559f7600c1df65fbc4b39f02eb3f8}{}\section{includes/tacopie/utils Directory Reference} \label{dir_38b559f7600c1df65fbc4b39f02eb3f8}\index{includes/tacopie/utils Directory Reference@{includes/tacopie/utils Directory Reference}} -\subsection*{Files} -\begin{DoxyCompactItemize} -\item -file \hyperlink{error_8hpp}{error.\+hpp} -\item -file \hyperlink{logger_8hpp}{logger.\+hpp} -\item -file \hyperlink{thread__pool_8hpp}{thread\+\_\+pool.\+hpp} -\item -file \hyperlink{typedefs_8hpp}{typedefs.\+hpp} -\end{DoxyCompactItemize} diff --git a/docs/latex/dir_9a013686e2522dd95763481288c1f90f.tex b/docs/latex/dir_9a013686e2522dd95763481288c1f90f.tex index 4cffab9..c654774 100644 --- a/docs/latex/dir_9a013686e2522dd95763481288c1f90f.tex +++ b/docs/latex/dir_9a013686e2522dd95763481288c1f90f.tex @@ -2,8 +2,4 @@ \label{dir_9a013686e2522dd95763481288c1f90f}\index{includes/tacopie Directory Reference@{includes/tacopie Directory Reference}} \subsection*{Directories} \begin{DoxyCompactItemize} -\item -directory \hyperlink{dir_1619eefbac1db14eaf18adaf83ce3ccc}{network} -\item -directory \hyperlink{dir_38b559f7600c1df65fbc4b39f02eb3f8}{utils} \end{DoxyCompactItemize} diff --git a/docs/latex/hierarchy.tex b/docs/latex/hierarchy.tex index 74ea81a..ec89cdd 100644 --- a/docs/latex/hierarchy.tex +++ b/docs/latex/hierarchy.tex @@ -15,7 +15,6 @@ \section{Class Hierarchy} \item \contentsline{section}{tacopie\+:\+:tcp\+\_\+server}{\pageref{classtacopie_1_1tcp__server}}{} \item \contentsline{section}{tacopie\+:\+:tcp\+\_\+socket}{\pageref{classtacopie_1_1tcp__socket}}{} \item \contentsline{section}{tacopie\+:\+:utils\+:\+:thread\+\_\+pool}{\pageref{classtacopie_1_1utils_1_1thread__pool}}{} -\item \contentsline{section}{tacopie\+:\+:io\+\_\+service\+:\+:tracked\+\_\+socket}{\pageref{structtacopie_1_1io__service_1_1tracked__socket}}{} \item \contentsline{section}{tacopie\+:\+:tcp\+\_\+client\+:\+:write\+\_\+request}{\pageref{structtacopie_1_1tcp__client_1_1write__request}}{} \item \contentsline{section}{tacopie\+:\+:tcp\+\_\+client\+:\+:write\+\_\+result}{\pageref{structtacopie_1_1tcp__client_1_1write__result}}{} \end{DoxyCompactList} diff --git a/docs/latex/refman.tex b/docs/latex/refman.tex index 2143fba..fed1bab 100644 --- a/docs/latex/refman.tex +++ b/docs/latex/refman.tex @@ -138,17 +138,10 @@ \hypersetup{pageanchor=true} %--- Begin generated contents --- -\chapter{Namespace Index} -\input{namespaces} \chapter{Hierarchical Index} \input{hierarchy} \chapter{Class Index} \input{annotated} -\chapter{File Index} -\input{files} -\chapter{Namespace Documentation} -\input{namespacetacopie} -\input{namespacetacopie_1_1utils} \chapter{Class Documentation} \input{classtacopie_1_1io__service} \input{classtacopie_1_1logger} @@ -161,19 +154,8 @@ \chapter{Class Documentation} \input{classtacopie_1_1tcp__server} \input{classtacopie_1_1tcp__socket} \input{classtacopie_1_1utils_1_1thread__pool} -\input{structtacopie_1_1io__service_1_1tracked__socket} \input{structtacopie_1_1tcp__client_1_1write__request} \input{structtacopie_1_1tcp__client_1_1write__result} -\chapter{File Documentation} -\input{io__service_8hpp} -\input{self__pipe_8hpp} -\input{tcp__client_8hpp} -\input{tcp__server_8hpp} -\input{tcp__socket_8hpp} -\input{error_8hpp} -\input{logger_8hpp} -\input{thread__pool_8hpp} -\input{typedefs_8hpp} %--- End generated contents --- % Index diff --git a/docs/latex/structtacopie_1_1tcp__client_1_1read__request.tex b/docs/latex/structtacopie_1_1tcp__client_1_1read__request.tex index 19e27b1..732755c 100644 --- a/docs/latex/structtacopie_1_1tcp__client_1_1read__request.tex +++ b/docs/latex/structtacopie_1_1tcp__client_1_1read__request.tex @@ -7,9 +7,11 @@ \subsection*{Public Attributes} \begin{DoxyCompactItemize} \item -std\+::size\+\_\+t \hyperlink{structtacopie_1_1tcp__client_1_1read__request_ad8b69f61884c60596aface363ca947a3}{size} +\mbox{\Hypertarget{structtacopie_1_1tcp__client_1_1read__request_ad8b69f61884c60596aface363ca947a3}\label{structtacopie_1_1tcp__client_1_1read__request_ad8b69f61884c60596aface363ca947a3}} +std\+::size\+\_\+t {\bfseries size} \item -\hyperlink{classtacopie_1_1tcp__client_acdf9dea8bac6c56f7b04ce38b9432322}{async\+\_\+read\+\_\+callback\+\_\+t} \hyperlink{structtacopie_1_1tcp__client_1_1read__request_a3d495e82e38efebf763f595392b0db46}{async\+\_\+read\+\_\+callback} +\mbox{\Hypertarget{structtacopie_1_1tcp__client_1_1read__request_a3d495e82e38efebf763f595392b0db46}\label{structtacopie_1_1tcp__client_1_1read__request_a3d495e82e38efebf763f595392b0db46}} +\hyperlink{classtacopie_1_1tcp__client_acdf9dea8bac6c56f7b04ce38b9432322}{async\+\_\+read\+\_\+callback\+\_\+t} {\bfseries async\+\_\+read\+\_\+callback} \end{DoxyCompactItemize} @@ -20,21 +22,6 @@ \subsection{Detailed Description} \item async\+\_\+read\+\_\+callback\+: Callback to be called on a read operation completion, even though the operation read less bytes than requested. \end{DoxyItemize} -\subsection{Member Data Documentation} -\mbox{\Hypertarget{structtacopie_1_1tcp__client_1_1read__request_a3d495e82e38efebf763f595392b0db46}\label{structtacopie_1_1tcp__client_1_1read__request_a3d495e82e38efebf763f595392b0db46}} -\index{tacopie\+::tcp\+\_\+client\+::read\+\_\+request@{tacopie\+::tcp\+\_\+client\+::read\+\_\+request}!async\+\_\+read\+\_\+callback@{async\+\_\+read\+\_\+callback}} -\index{async\+\_\+read\+\_\+callback@{async\+\_\+read\+\_\+callback}!tacopie\+::tcp\+\_\+client\+::read\+\_\+request@{tacopie\+::tcp\+\_\+client\+::read\+\_\+request}} -\subsubsection{\texorpdfstring{async\+\_\+read\+\_\+callback}{async\_read\_callback}} -{\footnotesize\ttfamily \hyperlink{classtacopie_1_1tcp__client_acdf9dea8bac6c56f7b04ce38b9432322}{async\+\_\+read\+\_\+callback\+\_\+t} tacopie\+::tcp\+\_\+client\+::read\+\_\+request\+::async\+\_\+read\+\_\+callback} - -\mbox{\Hypertarget{structtacopie_1_1tcp__client_1_1read__request_ad8b69f61884c60596aface363ca947a3}\label{structtacopie_1_1tcp__client_1_1read__request_ad8b69f61884c60596aface363ca947a3}} -\index{tacopie\+::tcp\+\_\+client\+::read\+\_\+request@{tacopie\+::tcp\+\_\+client\+::read\+\_\+request}!size@{size}} -\index{size@{size}!tacopie\+::tcp\+\_\+client\+::read\+\_\+request@{tacopie\+::tcp\+\_\+client\+::read\+\_\+request}} -\subsubsection{\texorpdfstring{size}{size}} -{\footnotesize\ttfamily std\+::size\+\_\+t tacopie\+::tcp\+\_\+client\+::read\+\_\+request\+::size} - - - The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} \item -includes/tacopie/network/\hyperlink{tcp__client_8hpp}{tcp\+\_\+client.\+hpp}\end{DoxyCompactItemize} +includes/tacopie/network/tcp\+\_\+client.\+hpp\end{DoxyCompactItemize} diff --git a/docs/latex/structtacopie_1_1tcp__client_1_1read__result.tex b/docs/latex/structtacopie_1_1tcp__client_1_1read__result.tex index fa602c0..d0921b1 100644 --- a/docs/latex/structtacopie_1_1tcp__client_1_1read__result.tex +++ b/docs/latex/structtacopie_1_1tcp__client_1_1read__result.tex @@ -7,9 +7,11 @@ \subsection*{Public Attributes} \begin{DoxyCompactItemize} \item -bool \hyperlink{structtacopie_1_1tcp__client_1_1read__result_a9bb917b8d210159a95655a6f8da8e96e}{success} +\mbox{\Hypertarget{structtacopie_1_1tcp__client_1_1read__result_a9bb917b8d210159a95655a6f8da8e96e}\label{structtacopie_1_1tcp__client_1_1read__result_a9bb917b8d210159a95655a6f8da8e96e}} +bool {\bfseries success} \item -std\+::vector$<$ char $>$ \hyperlink{structtacopie_1_1tcp__client_1_1read__result_a50d22ea3a43d085d88d54bbf59a357dc}{buffer} +\mbox{\Hypertarget{structtacopie_1_1tcp__client_1_1read__result_a50d22ea3a43d085d88d54bbf59a357dc}\label{structtacopie_1_1tcp__client_1_1read__result_a50d22ea3a43d085d88d54bbf59a357dc}} +std\+::vector$<$ char $>$ {\bfseries buffer} \end{DoxyCompactItemize} @@ -20,21 +22,6 @@ \subsection{Detailed Description} \item buffer\+: Vector containing the read bytes \end{DoxyItemize} -\subsection{Member Data Documentation} -\mbox{\Hypertarget{structtacopie_1_1tcp__client_1_1read__result_a50d22ea3a43d085d88d54bbf59a357dc}\label{structtacopie_1_1tcp__client_1_1read__result_a50d22ea3a43d085d88d54bbf59a357dc}} -\index{tacopie\+::tcp\+\_\+client\+::read\+\_\+result@{tacopie\+::tcp\+\_\+client\+::read\+\_\+result}!buffer@{buffer}} -\index{buffer@{buffer}!tacopie\+::tcp\+\_\+client\+::read\+\_\+result@{tacopie\+::tcp\+\_\+client\+::read\+\_\+result}} -\subsubsection{\texorpdfstring{buffer}{buffer}} -{\footnotesize\ttfamily std\+::vector$<$char$>$ tacopie\+::tcp\+\_\+client\+::read\+\_\+result\+::buffer} - -\mbox{\Hypertarget{structtacopie_1_1tcp__client_1_1read__result_a9bb917b8d210159a95655a6f8da8e96e}\label{structtacopie_1_1tcp__client_1_1read__result_a9bb917b8d210159a95655a6f8da8e96e}} -\index{tacopie\+::tcp\+\_\+client\+::read\+\_\+result@{tacopie\+::tcp\+\_\+client\+::read\+\_\+result}!success@{success}} -\index{success@{success}!tacopie\+::tcp\+\_\+client\+::read\+\_\+result@{tacopie\+::tcp\+\_\+client\+::read\+\_\+result}} -\subsubsection{\texorpdfstring{success}{success}} -{\footnotesize\ttfamily bool tacopie\+::tcp\+\_\+client\+::read\+\_\+result\+::success} - - - The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} \item -includes/tacopie/network/\hyperlink{tcp__client_8hpp}{tcp\+\_\+client.\+hpp}\end{DoxyCompactItemize} +includes/tacopie/network/tcp\+\_\+client.\+hpp\end{DoxyCompactItemize} diff --git a/docs/latex/structtacopie_1_1tcp__client_1_1write__request.tex b/docs/latex/structtacopie_1_1tcp__client_1_1write__request.tex index a670d99..ae41e89 100644 --- a/docs/latex/structtacopie_1_1tcp__client_1_1write__request.tex +++ b/docs/latex/structtacopie_1_1tcp__client_1_1write__request.tex @@ -7,9 +7,11 @@ \subsection*{Public Attributes} \begin{DoxyCompactItemize} \item -std\+::vector$<$ char $>$ \hyperlink{structtacopie_1_1tcp__client_1_1write__request_a4ee0c159b630c14f81d6b6d7d4b4e826}{buffer} +\mbox{\Hypertarget{structtacopie_1_1tcp__client_1_1write__request_a4ee0c159b630c14f81d6b6d7d4b4e826}\label{structtacopie_1_1tcp__client_1_1write__request_a4ee0c159b630c14f81d6b6d7d4b4e826}} +std\+::vector$<$ char $>$ {\bfseries buffer} \item -\hyperlink{classtacopie_1_1tcp__client_ad48b8c8dff8a77490eb2e3e802c82b97}{async\+\_\+write\+\_\+callback\+\_\+t} \hyperlink{structtacopie_1_1tcp__client_1_1write__request_a04fd3e5484ba322d0112024bf8823623}{async\+\_\+write\+\_\+callback} +\mbox{\Hypertarget{structtacopie_1_1tcp__client_1_1write__request_a04fd3e5484ba322d0112024bf8823623}\label{structtacopie_1_1tcp__client_1_1write__request_a04fd3e5484ba322d0112024bf8823623}} +\hyperlink{classtacopie_1_1tcp__client_ad48b8c8dff8a77490eb2e3e802c82b97}{async\+\_\+write\+\_\+callback\+\_\+t} {\bfseries async\+\_\+write\+\_\+callback} \end{DoxyCompactItemize} @@ -20,21 +22,6 @@ \subsection{Detailed Description} \item async\+\_\+write\+\_\+callback\+: Callback to be called on a write operation completion, even though the operation wrote less bytes than requested. \end{DoxyItemize} -\subsection{Member Data Documentation} -\mbox{\Hypertarget{structtacopie_1_1tcp__client_1_1write__request_a04fd3e5484ba322d0112024bf8823623}\label{structtacopie_1_1tcp__client_1_1write__request_a04fd3e5484ba322d0112024bf8823623}} -\index{tacopie\+::tcp\+\_\+client\+::write\+\_\+request@{tacopie\+::tcp\+\_\+client\+::write\+\_\+request}!async\+\_\+write\+\_\+callback@{async\+\_\+write\+\_\+callback}} -\index{async\+\_\+write\+\_\+callback@{async\+\_\+write\+\_\+callback}!tacopie\+::tcp\+\_\+client\+::write\+\_\+request@{tacopie\+::tcp\+\_\+client\+::write\+\_\+request}} -\subsubsection{\texorpdfstring{async\+\_\+write\+\_\+callback}{async\_write\_callback}} -{\footnotesize\ttfamily \hyperlink{classtacopie_1_1tcp__client_ad48b8c8dff8a77490eb2e3e802c82b97}{async\+\_\+write\+\_\+callback\+\_\+t} tacopie\+::tcp\+\_\+client\+::write\+\_\+request\+::async\+\_\+write\+\_\+callback} - -\mbox{\Hypertarget{structtacopie_1_1tcp__client_1_1write__request_a4ee0c159b630c14f81d6b6d7d4b4e826}\label{structtacopie_1_1tcp__client_1_1write__request_a4ee0c159b630c14f81d6b6d7d4b4e826}} -\index{tacopie\+::tcp\+\_\+client\+::write\+\_\+request@{tacopie\+::tcp\+\_\+client\+::write\+\_\+request}!buffer@{buffer}} -\index{buffer@{buffer}!tacopie\+::tcp\+\_\+client\+::write\+\_\+request@{tacopie\+::tcp\+\_\+client\+::write\+\_\+request}} -\subsubsection{\texorpdfstring{buffer}{buffer}} -{\footnotesize\ttfamily std\+::vector$<$char$>$ tacopie\+::tcp\+\_\+client\+::write\+\_\+request\+::buffer} - - - The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} \item -includes/tacopie/network/\hyperlink{tcp__client_8hpp}{tcp\+\_\+client.\+hpp}\end{DoxyCompactItemize} +includes/tacopie/network/tcp\+\_\+client.\+hpp\end{DoxyCompactItemize} diff --git a/docs/latex/structtacopie_1_1tcp__client_1_1write__result.tex b/docs/latex/structtacopie_1_1tcp__client_1_1write__result.tex index 66b7b14..ecfb984 100644 --- a/docs/latex/structtacopie_1_1tcp__client_1_1write__result.tex +++ b/docs/latex/structtacopie_1_1tcp__client_1_1write__result.tex @@ -7,9 +7,11 @@ \subsection*{Public Attributes} \begin{DoxyCompactItemize} \item -bool \hyperlink{structtacopie_1_1tcp__client_1_1write__result_a4a8d5706c83068a97c10e63c6080e6a3}{success} +\mbox{\Hypertarget{structtacopie_1_1tcp__client_1_1write__result_a4a8d5706c83068a97c10e63c6080e6a3}\label{structtacopie_1_1tcp__client_1_1write__result_a4a8d5706c83068a97c10e63c6080e6a3}} +bool {\bfseries success} \item -std\+::size\+\_\+t \hyperlink{structtacopie_1_1tcp__client_1_1write__result_acee9eca954a6f1b6283c6188eead2ab1}{size} +\mbox{\Hypertarget{structtacopie_1_1tcp__client_1_1write__result_acee9eca954a6f1b6283c6188eead2ab1}\label{structtacopie_1_1tcp__client_1_1write__result_acee9eca954a6f1b6283c6188eead2ab1}} +std\+::size\+\_\+t {\bfseries size} \end{DoxyCompactItemize} @@ -20,21 +22,6 @@ \subsection{Detailed Description} \item size\+: Number of bytes written \end{DoxyItemize} -\subsection{Member Data Documentation} -\mbox{\Hypertarget{structtacopie_1_1tcp__client_1_1write__result_acee9eca954a6f1b6283c6188eead2ab1}\label{structtacopie_1_1tcp__client_1_1write__result_acee9eca954a6f1b6283c6188eead2ab1}} -\index{tacopie\+::tcp\+\_\+client\+::write\+\_\+result@{tacopie\+::tcp\+\_\+client\+::write\+\_\+result}!size@{size}} -\index{size@{size}!tacopie\+::tcp\+\_\+client\+::write\+\_\+result@{tacopie\+::tcp\+\_\+client\+::write\+\_\+result}} -\subsubsection{\texorpdfstring{size}{size}} -{\footnotesize\ttfamily std\+::size\+\_\+t tacopie\+::tcp\+\_\+client\+::write\+\_\+result\+::size} - -\mbox{\Hypertarget{structtacopie_1_1tcp__client_1_1write__result_a4a8d5706c83068a97c10e63c6080e6a3}\label{structtacopie_1_1tcp__client_1_1write__result_a4a8d5706c83068a97c10e63c6080e6a3}} -\index{tacopie\+::tcp\+\_\+client\+::write\+\_\+result@{tacopie\+::tcp\+\_\+client\+::write\+\_\+result}!success@{success}} -\index{success@{success}!tacopie\+::tcp\+\_\+client\+::write\+\_\+result@{tacopie\+::tcp\+\_\+client\+::write\+\_\+result}} -\subsubsection{\texorpdfstring{success}{success}} -{\footnotesize\ttfamily bool tacopie\+::tcp\+\_\+client\+::write\+\_\+result\+::success} - - - The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} \item -includes/tacopie/network/\hyperlink{tcp__client_8hpp}{tcp\+\_\+client.\+hpp}\end{DoxyCompactItemize} +includes/tacopie/network/tcp\+\_\+client.\+hpp\end{DoxyCompactItemize}