diff --git a/TLSSession.cpp b/TLSSession.cpp index 54e0a8a..24efdd0 100644 --- a/TLSSession.cpp +++ b/TLSSession.cpp @@ -42,8 +42,8 @@ namespace core { fcntl(getDescriptor(), F_SETFL, fcntl(getDescriptor(), F_GETFL, 0) | O_NONBLOCK); ssl = SSL_new(static_cast(server).ctx); - if(ssl <= 0) - throw std::string("Error creating new TLS socket."); +// if(ssl <= 0) +// throw std::string("Error creating new TLS socket."); SSL_set_info_callback(ssl, handshake_complete); diff --git a/html/CommandList_8h_source.html b/html/CommandList_8h_source.html index 0b045f8..4ed110d 100644 --- a/html/CommandList_8h_source.html +++ b/html/CommandList_8h_source.html @@ -3,7 +3,7 @@ - + My Project: CommandList.h Source File @@ -29,10 +29,10 @@ - + @@ -111,21 +111,19 @@ $(function() {
77 }
78 
79 #endif
- -
core::TCPSession
Definition: TCPSession.h:24
-
core::CommandList::add
void add(Command &command, std::string name="")
Definition: CommandList.cpp:8
-
core::CommandList::processRequest
bool processRequest(coreutils::ZString &request, TCPSession &session)
Definition: CommandList.cpp:14
-
core::CommandList::grabInput
bool grabInput(TCPSession &session, Command &command)
Definition: CommandList.cpp:33
-
core::CommandList::remove
void remove(Command &command)
Definition: CommandList.cpp:12
-
core::Command
Definition: Command.h:22
core::CommandList
Definition: CommandList.h:18
core::CommandList::processCommand
int processCommand(coreutils::ZString &request, TCPSession &session)
Definition: CommandList.cpp:42
+
core::CommandList::grabInput
bool grabInput(TCPSession &session, Command &command)
Definition: CommandList.cpp:33
+
core::CommandList::add
void add(Command &command, std::string name="")
Definition: CommandList.cpp:8
+
core::CommandList::processRequest
bool processRequest(coreutils::ZString &request, TCPSession &session)
Definition: CommandList.cpp:14
+
core::CommandList::remove
void remove(Command &command)
Definition: CommandList.cpp:12
core::CommandList::commands
std::map< std::string, Command * > commands
Definition: CommandList.h:71
+
core::Command
Definition: Command.h:22
+
core::TCPSession
Definition: TCPSession.h:24
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/Command_8h_source.html b/html/Command_8h_source.html index f3002e0..9c0b13e 100644 --- a/html/Command_8h_source.html +++ b/html/Command_8h_source.html @@ -3,7 +3,7 @@ - + My Project: Command.h Source File @@ -29,10 +29,10 @@ - + @@ -95,16 +95,14 @@ $(function() {
49 }
50 
51 #endif
- -
core::Command::processCommand
virtual int processCommand(coreutils::ZString &request, TCPSession &session)
Definition: Command.cpp:7
-
core::TCPSession
Definition: TCPSession.h:24
-
core::Command::output
virtual void output(std::stringstream &out)
Definition: Command.cpp:11
core::Command
Definition: Command.h:22
+
core::Command::processCommand
virtual int processCommand(coreutils::ZString &request, TCPSession &session)
Definition: Command.cpp:7
+
core::Command::output
virtual void output(std::stringstream &out)
Definition: Command.cpp:11
+
core::TCPSession
Definition: TCPSession.h:24
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/ConsoleServer_8h_source.html b/html/ConsoleServer_8h_source.html index 29bef31..bb44490 100644 --- a/html/ConsoleServer_8h_source.html +++ b/html/ConsoleServer_8h_source.html @@ -3,7 +3,7 @@ - + My Project: ConsoleServer.h Source File @@ -29,10 +29,10 @@ - + @@ -103,18 +103,16 @@ $(function() {
39 }
40 
41 #endif
- -
core::TCPSession
Definition: TCPSession.h:24
-
core::IPAddress
Definition: IPAddress.h:9
-
core::EPoll
Definition: EPoll.h:31
core::ConsoleServer
Definition: ConsoleServer.h:19
-
core::TCPServer
Definition: TCPServer.h:25
core::ConsoleServer::getSocketAccept
TCPSession * getSocketAccept(EPoll &ePoll) override
Definition: ConsoleServer.cpp:17
+
core::EPoll
Definition: EPoll.h:31
+
core::IPAddress
Definition: IPAddress.h:9
+
core::TCPServer
Definition: TCPServer.h:25
+
core::TCPSession
Definition: TCPSession.h:24
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/ConsoleSession_8h_source.html b/html/ConsoleSession_8h_source.html index 8661a11..9dfb454 100644 --- a/html/ConsoleSession_8h_source.html +++ b/html/ConsoleSession_8h_source.html @@ -3,7 +3,7 @@ - + My Project: ConsoleSession.h Source File @@ -29,10 +29,10 @@ - + @@ -99,17 +99,15 @@ $(function() {
39 }
40 
41 #endif
- -
core::EPoll
Definition: EPoll.h:31
core::ConsoleSession
Definition: ConsoleSession.h:20
+
core::ConsoleSession::protocol
void protocol(coreutils::ZString &data) override
Definition: ConsoleSession.cpp:11
+
core::EPoll
Definition: EPoll.h:31
core::TCPServer
Definition: TCPServer.h:25
core::TerminalSession
Definition: TerminalSession.h:30
-
core::ConsoleSession::protocol
void protocol(coreutils::ZString &data) override
Definition: ConsoleSession.cpp:11
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/EPoll_8h_source.html b/html/EPoll_8h_source.html index cf6e184..757633f 100644 --- a/html/EPoll_8h_source.html +++ b/html/EPoll_8h_source.html @@ -3,7 +3,7 @@ - + My Project: EPoll.h Source File @@ -29,10 +29,10 @@ - + @@ -109,7 +109,7 @@ $(function() {
98  int maxSockets;
99 
103 
-
104  void eventReceived(struct epoll_event event);
+
104  void eventReceived(struct epoll_event event);
105 
112 
113  int processCommand(coreutils::ZString &request, TCPSession &session) override;
@@ -131,27 +131,25 @@ $(function() {
129 
130 #endif
131 
- -
core::EPoll::isStopping
bool isStopping()
Returns a true if the stop command has been requested.
Definition: EPoll.cpp:65
-
core::EPoll::start
bool start(int numberOfThreads, int maxSockets)
Start the BMAEPoll processing.
Definition: EPoll.cpp:19
-
core::TCPSession
Definition: TCPSession.h:24
-
core::Socket
Definition: Socket.h:34
-
core::EPoll::unregisterSocket
bool unregisterSocket(Socket *socket)
Unregister a BMASocket from monitoring by BMAEPoll.
Definition: EPoll.cpp:74
-
core::EPoll
Definition: EPoll.h:31
-
core::EPoll::stop
bool stop()
Stop and shut down the BMAEPoll processing.
Definition: EPoll.cpp:45
-
core::EPoll::maxSockets
int maxSockets
The maximum number of socket allowed.
Definition: EPoll.h:98
core::Command
Definition: Command.h:22
+
core::EPoll
Definition: EPoll.h:31
+
core::EPoll::stop
bool stop()
Stop and shut down the BMAEPoll processing.
Definition: EPoll.cpp:46
+
core::EPoll::getDescriptor
int getDescriptor()
Return the descriptor for the ePoll socket.
Definition: EPoll.cpp:80
+
core::EPoll::processCommand
int processCommand(coreutils::ZString &request, TCPSession &session) override
Output the threads array to the console.
Definition: EPoll.cpp:84
+
core::EPoll::EPoll
EPoll()
Definition: EPoll.cpp:9
+
core::EPoll::isStopping
bool isStopping()
Returns a true if the stop command has been requested.
Definition: EPoll.cpp:66
core::EPoll::eventReceived
void eventReceived(struct epoll_event event)
Dispatch event to appropriate socket.
-
core::EPoll::getDescriptor
int getDescriptor()
Return the descriptor for the ePoll socket.
Definition: EPoll.cpp:79
-
core::EPoll::~EPoll
~EPoll()
Definition: EPoll.cpp:17
-
core::EPoll::EPoll
EPoll()
Definition: EPoll.cpp:8
-
core::EPoll::registerSocket
bool registerSocket(Socket *socket)
Register a BMASocket for monitoring by BMAEPoll.
Definition: EPoll.cpp:69
-
core::EPoll::processCommand
int processCommand(coreutils::ZString &request, TCPSession &session) override
Output the threads array to the console.
Definition: EPoll.cpp:83
+
core::EPoll::registerSocket
bool registerSocket(Socket *socket)
Register a BMASocket for monitoring by BMAEPoll.
Definition: EPoll.cpp:70
+
core::EPoll::unregisterSocket
bool unregisterSocket(Socket *socket)
Unregister a BMASocket from monitoring by BMAEPoll.
Definition: EPoll.cpp:75
+
core::EPoll::~EPoll
~EPoll()
Definition: EPoll.cpp:18
+
core::EPoll::start
bool start(int numberOfThreads, int maxSockets)
Start the BMAEPoll processing.
Definition: EPoll.cpp:20
+
core::EPoll::maxSockets
int maxSockets
The maximum number of socket allowed.
Definition: EPoll.h:98
+
core::Socket
Definition: Socket.h:34
+
core::TCPSession
Definition: TCPSession.h:24
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/INotify_8h_source.html b/html/INotify_8h_source.html index 1e3f6b4..1f79a59 100644 --- a/html/INotify_8h_source.html +++ b/html/INotify_8h_source.html @@ -3,7 +3,7 @@ - + My Project: INotify.h Source File @@ -29,10 +29,10 @@ - + @@ -102,15 +102,13 @@ $(function() {
35 }
36 
37 #endif
- -
core::Socket
Definition: Socket.h:34
core::EPoll
Definition: EPoll.h:31
core::INotify
Definition: INotify.h:9
+
core::Socket
Definition: Socket.h:34
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/IPAddressList_8h_source.html b/html/IPAddressList_8h_source.html index a3efba1..09eb44b 100644 --- a/html/IPAddressList_8h_source.html +++ b/html/IPAddressList_8h_source.html @@ -3,7 +3,7 @@ - + My Project: IPAddressList.h Source File @@ -29,10 +29,10 @@ - + @@ -91,14 +91,12 @@ $(function() {
24 }
25 
26 #endif
- -
core::IPAddress
Definition: IPAddress.h:9
core::IPAddressList
Definition: IPAddressList.h:9
+
core::IPAddress
Definition: IPAddress.h:9
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/IPAddress_8h_source.html b/html/IPAddress_8h_source.html index 81f1f45..376e6e9 100644 --- a/html/IPAddress_8h_source.html +++ b/html/IPAddress_8h_source.html @@ -3,7 +3,7 @@ - + My Project: IPAddress.h Source File @@ -29,10 +29,10 @@ - + @@ -94,17 +94,15 @@ $(function() {
27 }
28 
29 #endif
- -
core::IPAddress::getClientAddress
std::string getClientAddress()
Get the client network address as xxx.xxx.xxx.xxx.
Definition: IPAddress.cpp:35
core::IPAddress
Definition: IPAddress.h:9
core::IPAddress::getClientPort
int getClientPort()
Get the client network port number.
Definition: IPAddress.cpp:47
-
core::Object
Definition: Object.h:8
core::IPAddress::getClientAddressAndPort
std::string getClientAddressAndPort()
Get the client network address and port as xxx.xxx.xxx.xxx:ppppp.
Definition: IPAddress.cpp:40
+
core::IPAddress::getClientAddress
std::string getClientAddress()
Get the client network address as xxx.xxx.xxx.xxx.
Definition: IPAddress.cpp:35
+
core::Object
Definition: Object.h:8
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/Object_8h_source.html b/html/Object_8h_source.html index bc6526b..fa76d45 100644 --- a/html/Object_8h_source.html +++ b/html/Object_8h_source.html @@ -3,7 +3,7 @@ - + My Project: Object.h Source File @@ -29,10 +29,10 @@ - + @@ -84,13 +84,11 @@ $(function() {
17 }
18 
19 #endif
-
core::Object
Definition: Object.h:8
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/SessionFilter_8h_source.html b/html/SessionFilter_8h_source.html index f2d0690..8c67946 100644 --- a/html/SessionFilter_8h_source.html +++ b/html/SessionFilter_8h_source.html @@ -3,7 +3,7 @@ - + My Project: SessionFilter.h Source File @@ -29,10 +29,10 @@ - + @@ -86,15 +86,13 @@ $(function() {
19 }
20 
21 #endif
- +
core::Object
Definition: Object.h:8
core::SessionFilter
Definition: SessionFilter.h:10
core::TCPSession
Definition: TCPSession.h:24
-
core::Object
Definition: Object.h:8
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/Socket_8h_source.html b/html/Socket_8h_source.html index b298065..1be47c5 100644 --- a/html/Socket_8h_source.html +++ b/html/Socket_8h_source.html @@ -3,7 +3,7 @@ - + My Project: Socket.h Source File @@ -29,10 +29,10 @@ - + @@ -146,10 +146,10 @@ $(function() {
167 
168  std::string text;
169  int descriptor = -1;
-
170  std::mutex lock;
+
170 // std::mutex lock;
171  std::mutex outlock;
172  bool readHangup = false;
-
173 
+
173  bool inHandler = false;
174 // struct epoll_event event; // Event selection construction structure.
175 
176  //-------------------------------------------------------------------------------------
@@ -181,26 +181,24 @@ $(function() {
202 
203 #endif
204 
- -
core::Socket
Definition: Socket.h:34
-
core::Socket::write
int write(std::string data)
Definition: Socket.cpp:149
core::EPoll
Definition: EPoll.h:31
-
core::Socket::onRegistered
virtual void onRegistered()
Called after the socket has been registered with epoll processing.
Definition: Socket.cpp:57
-
core::Socket::receiveData
virtual void receiveData(coreutils::ZString &buffer)
Definition: Socket.cpp:98
-
core::Socket::onDataReceived
virtual void onDataReceived(std::string data)
Called when data is received from the socket.
Definition: Socket.cpp:90
-
core::Socket::Socket
Socket(EPoll &ePoll, std::string text="")
Definition: Socket.cpp:9
-
core::Socket::shutdown
void shutdown(std::string text="unknown")
Definition: Socket.cpp:165
-
core::Socket::onRegister
virtual void onRegister()
Called before the socket has registered with the epoll processing.
Definition: Socket.cpp:55
-
core::Socket::eventReceived
bool eventReceived(struct epoll_event event)
Parse epoll event and call specified callbacks.
Definition: Socket.cpp:63
-
core::Socket::onUnregistered
virtual void onUnregistered()
Called when the socket has finished unregistering for the epoll processing.
Definition: Socket.cpp:61
+
core::Socket
Definition: Socket.h:34
core::Socket::getDescriptor
int getDescriptor()
Get the descriptor for the socket.
Definition: Socket.cpp:41
-
core::Socket::~Socket
virtual ~Socket()
Definition: Socket.cpp:15
-
core::Socket::setDescriptor
void setDescriptor(int descriptor)
Set the descriptor for the socket.
Definition: Socket.cpp:25
+
core::Socket::write
int write(std::string data)
Definition: Socket.cpp:138
+
core::Socket::onRegistered
virtual void onRegistered()
Called after the socket has been registered with epoll processing.
Definition: Socket.cpp:57
+
core::Socket::receiveData
virtual void receiveData(coreutils::ZString &buffer)
Definition: Socket.cpp:91
+
core::Socket::Socket
Socket(EPoll &ePoll, std::string text="")
Definition: Socket.cpp:11
+
core::Socket::eventReceived
bool eventReceived(struct epoll_event event)
Parse epoll event and call specified callbacks.
Definition: Socket.cpp:63
+
core::Socket::onRegister
virtual void onRegister()
Called before the socket has registered with the epoll processing.
Definition: Socket.cpp:55
+
core::Socket::~Socket
virtual ~Socket()
Definition: Socket.cpp:17
+
core::Socket::setDescriptor
void setDescriptor(int descriptor)
Set the descriptor for the socket.
Definition: Socket.cpp:27
+
core::Socket::onDataReceived
virtual void onDataReceived(std::string data)
Called when data is received from the socket.
Definition: Socket.cpp:83
+
core::Socket::onUnregistered
virtual void onUnregistered()
Called when the socket has finished unregistering for the epoll processing.
Definition: Socket.cpp:61
+
core::Socket::shutdown
void shutdown(std::string text="unknown")
Definition: Socket.cpp:155
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/SubscriptionManager_8h_source.html b/html/SubscriptionManager_8h_source.html index baaaf08..d947d5e 100644 --- a/html/SubscriptionManager_8h_source.html +++ b/html/SubscriptionManager_8h_source.html @@ -3,7 +3,7 @@ - + My Project: SubscriptionManager.h Source File @@ -29,10 +29,10 @@ - + @@ -90,22 +90,21 @@ $(function() {
23 
24  private:
25  std::map<std::string, Subscription *> subscriptions;
-
26 
-
27  };
-
28 }
-
29 
-
30 #endif
- -
core::TCPSession
Definition: TCPSession.h:24
-
core::SubscriptionManager
Definition: SubscriptionManager.h:13
-
core::Subscription
Definition: Subscription.h:12
-
core::SubscriptionManager::processCommand
int processCommand(coreutils::ZString &request, TCPSession &session) override
Definition: SubscriptionManager.cpp:40
+
26  std::mutex lock;
+
27 
+
28  };
+
29 }
+
30 
+
31 #endif
core::Command
Definition: Command.h:22
+
core::SubscriptionManager
Definition: SubscriptionManager.h:13
+
core::SubscriptionManager::processCommand
int processCommand(coreutils::ZString &request, TCPSession &session) override
Definition: SubscriptionManager.cpp:44
+
core::Subscription
Definition: Subscription.h:14
+
core::TCPSession
Definition: TCPSession.h:24
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/Subscription_8h_source.html b/html/Subscription_8h_source.html index 92a284c..76584a9 100644 --- a/html/Subscription_8h_source.html +++ b/html/Subscription_8h_source.html @@ -3,7 +3,7 @@ - + My Project: Subscription.h Source File @@ -29,10 +29,10 @@ - + @@ -72,47 +72,47 @@ $(function() {
5 #include <vector>
6 #include <string>
7 
-
8 namespace core {
-
9 
-
10  class TCPSession;
-
11 
-
12  class Subscription {
-
13 
-
14  public:
-
15  Subscription(std::string id, std::string mode = "*AUTHOR");
-
16  Subscription(std::string id, TCPSession &session, std::string mode = "*AUTHOR");
-
17  virtual ~Subscription();
-
18 
-
19  int subscribe(TCPSession &session);
-
20  int unsubscribe(TCPSession &session);
-
21 
-
22  virtual int process(coreutils::ZString &request, std::stringstream &out);
-
23  virtual int onSubscribe(TCPSession &session);
-
24 
-
25  int event(std::stringstream &out);
-
26 
-
27  bool ifSubscriber(TCPSession &session);
-
28 
-
29  // int processCommand(coreutils::ZString &request, TCPSession &session) override;
-
30 
-
31  std::string id;
-
32  std::string mode;
-
33  TCPSession *owner;
-
34 
-
35  std::vector<TCPSession *> subscribers;
-
36 
-
37  };
-
38 }
-
39 
-
40 #endif
- +
8 namespace core
+
9 {
+
10 
+
11  class TCPSession;
+
12 
+
13  class Subscription
+
14  {
+
15 
+
16  public:
+
17  Subscription(std::string id, std::string mode = "*AUTHOR");
+
18  Subscription(std::string id, TCPSession &session, std::string mode = "*AUTHOR");
+
19  virtual ~Subscription();
+
20 
+
21  int subscribe(TCPSession &session);
+
22  int unsubscribe(TCPSession &session);
+
23 
+
24  virtual int process(coreutils::ZString &request, std::stringstream &out, TCPSession &session);
+
25 
+
26  virtual int onSubscribe(TCPSession &session);
+
27 
+
28  int event(std::stringstream &out);
+
29 
+
30  bool ifSubscriber(TCPSession &session);
+
31 
+
32  // int processCommand(coreutils::ZString &request, TCPSession &session) override;
+
33 
+
34  std::string id;
+
35  std::string mode;
+
36  TCPSession *owner;
+
37 
+
38  std::vector<TCPSession *> subscribers;
+
39  };
+
40 }
+
41 
+
42 #endif
+
core::Subscription
Definition: Subscription.h:14
core::TCPSession
Definition: TCPSession.h:24
-
core::Subscription
Definition: Subscription.h:12
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/TCPServer_8h_source.html b/html/TCPServer_8h_source.html index 0e6cda3..35128ae 100644 --- a/html/TCPServer_8h_source.html +++ b/html/TCPServer_8h_source.html @@ -3,7 +3,7 @@ - + My Project: TCPServer.h Source File @@ -29,10 +29,10 @@ - + @@ -139,33 +139,31 @@ $(function() {
148 }
149 
150 #endif
- -
core::TCPServer::subscriptions
SubscriptionManager subscriptions
Definition: TCPServer.h:116
-
core::SessionFilter
Definition: SessionFilter.h:10
-
core::TCPServer::blackList
IPAddressList * blackList
Definition: TCPServer.h:77
-
core::TCPSession
Definition: TCPSession.h:24
-
core::IPAddress
Definition: IPAddress.h:9
-
core::TCPServer::sessions
std::vector< TCPSession * > sessions
Definition: TCPServer.h:62
-
core::TCPServer::onDataReceived
void onDataReceived(std::string data) override
Definition: TCPServer.cpp:36
-
core::EPoll
Definition: EPoll.h:31
-
core::SubscriptionManager
Definition: SubscriptionManager.h:13
-
core::TCPServer::processCommand
int processCommand(coreutils::ZString &request, TCPSession &session) override
Definition: TCPServer.cpp:90
-
core::TCPServer::TCPServer
TCPServer(EPoll &ePoll, IPAddress address, std::string delimiter=" ", int depth=10, std::string text="")
Definition: TCPServer.cpp:9
-
core::Command
Definition: Command.h:22
-
core::TCPSocket
Definition: TCPSocket.h:20
-
core::TCPServer::whiteList
IPAddressList * whiteList
Definition: TCPServer.h:85
core::CommandList
Definition: CommandList.h:18
+
core::Command
Definition: Command.h:22
+
core::EPoll
Definition: EPoll.h:31
core::IPAddressList
Definition: IPAddressList.h:9
-
core::TCPServer::~TCPServer
virtual ~TCPServer()
Definition: TCPServer.cpp:31
+
core::IPAddress
Definition: IPAddress.h:9
+
core::SessionFilter
Definition: SessionFilter.h:10
+
core::SubscriptionManager
Definition: SubscriptionManager.h:13
core::TCPServer
Definition: TCPServer.h:25
+
core::TCPServer::onDataReceived
void onDataReceived(std::string data) override
Definition: TCPServer.cpp:36
+
core::TCPServer::subscriptions
SubscriptionManager subscriptions
Definition: TCPServer.h:116
+
core::TCPServer::output
void output(std::stringstream &out)
Output the consoles array to the console.
Definition: TCPServer.cpp:90
+
core::TCPServer::processCommand
int processCommand(coreutils::ZString &request, TCPSession &session) override
Definition: TCPServer.cpp:94
+
core::TCPServer::~TCPServer
virtual ~TCPServer()
Definition: TCPServer.cpp:31
+
core::TCPServer::blackList
IPAddressList * blackList
Definition: TCPServer.h:77
+
core::TCPServer::getSocketAccept
virtual TCPSession * getSocketAccept(EPoll &epoll)
Definition: TCPServer.cpp:86
+
core::TCPServer::whiteList
IPAddressList * whiteList
Definition: TCPServer.h:85
+
core::TCPServer::TCPServer
TCPServer(EPoll &ePoll, IPAddress address, std::string delimiter=" ", int depth=10, std::string text="")
Definition: TCPServer.cpp:9
+
core::TCPServer::sessions
std::vector< TCPSession * > sessions
Definition: TCPServer.h:62
core::TCPServer::commands
CommandList commands
Definition: TCPServer.h:69
-
core::TCPServer::output
void output(std::stringstream &out)
Output the consoles array to the console.
Definition: TCPServer.cpp:86
-
core::TCPServer::getSocketAccept
virtual TCPSession * getSocketAccept(EPoll &epoll)
Definition: TCPServer.cpp:82
+
core::TCPSession
Definition: TCPSession.h:24
+
core::TCPSocket
Definition: TCPSocket.h:20
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/TCPSession_8h_source.html b/html/TCPSession_8h_source.html index 07e8ad1..cac4bce 100644 --- a/html/TCPSession_8h_source.html +++ b/html/TCPSession_8h_source.html @@ -3,7 +3,7 @@ - + My Project: TCPSession.h Source File @@ -29,10 +29,10 @@ - + @@ -139,28 +139,26 @@ $(function() {
141 }
142 
143 #endif
- -
core::TCPSession::onBlockReceived
virtual void onBlockReceived(coreutils::ZString &block)
Definition: TCPSession.cpp:81
-
core::TCPSession::protocol
virtual void protocol(coreutils::ZString &data)
Definition: TCPSession.cpp:19
-
core::TCPSession::send
void send()
Definition: TCPSession.cpp:87
-
core::TCPSession
Definition: TCPSession.h:24
-
core::EPoll
Definition: EPoll.h:31
-
core::TCPSession::onDataReceived
virtual void onDataReceived(coreutils::ZString &data) override
Definition: TCPSession.cpp:38
-
core::TCPSession::out
std::stringstream out
Definition: TCPSession.h:67
-
core::TCPSession::terminate
void terminate()
Definition: TCPSession.cpp:93
-
core::TCPSession::onRegistered
virtual void onRegistered() override
Called after the socket has been registered with epoll processing.
Definition: TCPSession.cpp:27
-
core::TCPSession::onLineReceived
virtual void onLineReceived(coreutils::ZString &line)
Definition: TCPSession.cpp:74
-
core::TCPSession::setBlockSize
void setBlockSize(int size=0)
Definition: TCPSession.cpp:70
core::Command
Definition: Command.h:22
-
core::TCPSocket
Definition: TCPSocket.h:20
-
core::TCPSession::output
virtual void output(std::stringstream &data)
Definition: TCPSession.cpp:15
-
core::TCPSession::onConnected
virtual void onConnected()
Definition: TCPSession.cpp:36
+
core::EPoll
Definition: EPoll.h:31
core::TCPServer
Definition: TCPServer.h:25
+
core::TCPSession
Definition: TCPSession.h:24
+
core::TCPSession::send
void send()
Definition: TCPSession.cpp:87
+
core::TCPSession::terminate
void terminate()
Definition: TCPSession.cpp:93
+
core::TCPSession::onLineReceived
virtual void onLineReceived(coreutils::ZString &line)
Definition: TCPSession.cpp:74
+
core::TCPSession::output
virtual void output(std::stringstream &data)
Definition: TCPSession.cpp:15
+
core::TCPSession::setBlockSize
void setBlockSize(int size=0)
Definition: TCPSession.cpp:70
+
core::TCPSession::onConnected
virtual void onConnected()
Definition: TCPSession.cpp:36
+
core::TCPSession::protocol
virtual void protocol(coreutils::ZString &data)
Definition: TCPSession.cpp:19
+
core::TCPSession::onBlockReceived
virtual void onBlockReceived(coreutils::ZString &block)
Definition: TCPSession.cpp:81
+
core::TCPSession::out
std::stringstream out
Definition: TCPSession.h:67
+
core::TCPSession::onRegistered
virtual void onRegistered() override
Called after the socket has been registered with epoll processing.
Definition: TCPSession.cpp:27
+
core::TCPSession::onDataReceived
virtual void onDataReceived(coreutils::ZString &data) override
Definition: TCPSession.cpp:38
+
core::TCPSocket
Definition: TCPSocket.h:20
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/TCPSocket_8h_source.html b/html/TCPSocket_8h_source.html index 62bbc7c..d57da81 100644 --- a/html/TCPSocket_8h_source.html +++ b/html/TCPSocket_8h_source.html @@ -3,7 +3,7 @@ - + My Project: TCPSocket.h Source File @@ -29,10 +29,10 @@ - + @@ -95,17 +95,15 @@ $(function() {
43 }
44 
45 #endif
- +
core::EPoll
Definition: EPoll.h:31
core::IPAddress
Definition: IPAddress.h:9
core::Socket
Definition: Socket.h:34
-
core::EPoll
Definition: EPoll.h:31
core::TCPSocket
Definition: TCPSocket.h:20
core::TCPSocket::output
virtual void output(std::stringstream &out)
Definition: TCPSocket.cpp:20
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/TLSServer_8h_source.html b/html/TLSServer_8h_source.html index 91b426b..1023699 100644 --- a/html/TLSServer_8h_source.html +++ b/html/TLSServer_8h_source.html @@ -3,7 +3,7 @@ - + My Project: TLSServer.h Source File @@ -29,10 +29,10 @@ - + @@ -102,19 +102,17 @@ $(function() {
52 }
53 
54 #endif
- -
core::TCPSession
Definition: TCPSession.h:24
-
core::IPAddress
Definition: IPAddress.h:9
core::EPoll
Definition: EPoll.h:31
+
core::IPAddress
Definition: IPAddress.h:9
+
core::TCPServer
Definition: TCPServer.h:25
+
core::TCPSession
Definition: TCPSession.h:24
core::TLSServer
Definition: TLSServer.h:19
core::TLSServer::TLSServer
TLSServer(EPoll &ePoll, IPAddress address)
Definition: TLSServer.cpp:22
core::TLSServer::~TLSServer
~TLSServer()
Definition: TLSServer.cpp:58
-
core::TCPServer
Definition: TCPServer.h:25
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/TLSSession_8h_source.html b/html/TLSSession_8h_source.html index 2808d63..c60ab5a 100644 --- a/html/TLSSession_8h_source.html +++ b/html/TLSSession_8h_source.html @@ -3,7 +3,7 @@ - + My Project: TLSSession.h Source File @@ -29,10 +29,10 @@ - + @@ -103,22 +103,20 @@ $(function() {
51 }
52 
53 #endif
- -
core::TLSSession::output
virtual void output(std::stringstream &out)
Definition: TLSSession.cpp:118
-
core::TCPSession
Definition: TCPSession.h:24
-
core::TLSSession::onRegistered
void onRegistered()
Called after the socket has been registered with epoll processing.
Definition: TLSSession.cpp:58
core::EPoll
Definition: EPoll.h:31
-
core::TLSSession::protocol
virtual void protocol(coreutils::ZString &data) override
Definition: TLSSession.cpp:83
-
core::TLSSession::receiveData
void receiveData(coreutils::ZString &buffer) override
Definition: TLSSession.cpp:85
+
core::TCPServer
Definition: TCPServer.h:25
+
core::TCPSession
Definition: TCPSession.h:24
core::TCPSession::out
std::stringstream out
Definition: TCPSession.h:67
core::TLSSession
Definition: TLSSession.h:23
-
core::TCPServer
Definition: TCPServer.h:25
+
core::TLSSession::protocol
virtual void protocol(coreutils::ZString &data) override
Definition: TLSSession.cpp:83
core::TLSSession::onRegister
void onRegister()
Called before the socket has registered with the epoll processing.
Definition: TLSSession.cpp:36
+
core::TLSSession::receiveData
void receiveData(coreutils::ZString &buffer) override
Definition: TLSSession.cpp:85
+
core::TLSSession::onRegistered
void onRegistered()
Called after the socket has been registered with epoll processing.
Definition: TLSSession.cpp:58
+
core::TLSSession::output
virtual void output(std::stringstream &out)
Definition: TLSSession.cpp:118
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/TerminalSession_8h_source.html b/html/TerminalSession_8h_source.html index 805ca80..faf72d8 100644 --- a/html/TerminalSession_8h_source.html +++ b/html/TerminalSession_8h_source.html @@ -3,7 +3,7 @@ - + My Project: TerminalSession.h Source File @@ -29,10 +29,10 @@ - + @@ -123,19 +123,17 @@ $(function() {
65 }
66 
67 #endif
- -
core::TerminalSession::clearEOL
void clearEOL()
Definition: TerminalSession.cpp:21
-
core::TCPSession
Definition: TCPSession.h:24
-
core::TerminalSession::setCursorLocation
void setCursorLocation(int x, int y)
Definition: TerminalSession.cpp:25
-
core::TerminalSession::clear
void clear()
Definition: TerminalSession.cpp:17
core::EPoll
Definition: EPoll.h:31
core::TCPServer
Definition: TCPServer.h:25
+
core::TCPSession
Definition: TCPSession.h:24
core::TerminalSession
Definition: TerminalSession.h:30
+
core::TerminalSession::clear
void clear()
Definition: TerminalSession.cpp:17
+
core::TerminalSession::clearEOL
void clearEOL()
Definition: TerminalSession.cpp:21
+
core::TerminalSession::setCursorLocation
void setCursorLocation(int x, int y)
Definition: TerminalSession.cpp:25
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/ThreadScope_8h_source.html b/html/ThreadScope_8h_source.html index 72db809..8f65dab 100644 --- a/html/ThreadScope_8h_source.html +++ b/html/ThreadScope_8h_source.html @@ -3,7 +3,7 @@ - + My Project: ThreadScope.h Source File @@ -29,10 +29,10 @@ - + @@ -80,13 +80,11 @@ $(function() {
13 }
14 
15 #endif
-
core::ThreadScope
Definition: ThreadScope.h:6
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/Thread_8h_source.html b/html/Thread_8h_source.html index 5f7942a..d86ed8a 100644 --- a/html/Thread_8h_source.html +++ b/html/Thread_8h_source.html @@ -3,7 +3,7 @@ - + My Project: Thread.h Source File @@ -29,10 +29,10 @@ - + @@ -109,17 +109,15 @@ $(function() {
52 }
53 
54 #endif
-
core::EPoll
Definition: EPoll.h:31
-
core::ThreadScope
Definition: ThreadScope.h:6
core::Object
Definition: Object.h:8
-
core::Thread::start
void start()
Definition: Thread.cpp:11
+
core::ThreadScope
Definition: ThreadScope.h:6
core::Thread
Definition: Thread.h:22
+
core::Thread::start
void start()
Definition: Thread.cpp:11
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/Timer_8h_source.html b/html/Timer_8h_source.html index e28eb3a..61217eb 100644 --- a/html/Timer_8h_source.html +++ b/html/Timer_8h_source.html @@ -3,7 +3,7 @@ - + My Project: Timer.h Source File @@ -29,10 +29,10 @@ - + @@ -95,7 +95,7 @@ $(function() {
50  protected:
51 
55 
-
56  virtual void onTimeout() = 0;
+
56  virtual void onTimeout() = 0;
57 
58  private:
59  void onDataReceived(std::string data) override;
@@ -106,19 +106,17 @@ $(function() {
64 }
65 
66 #endif
- -
core::Socket
Definition: Socket.h:34
core::EPoll
Definition: EPoll.h:31
-
core::Timer::getElapsed
double getElapsed()
Definition: Timer.cpp:47
+
core::Socket
Definition: Socket.h:34
core::Timer
Definition: Timer.h:18
-
core::Timer::clearTimer
void clearTimer()
Definition: Timer.cpp:34
+
core::Timer::getElapsed
double getElapsed()
Definition: Timer.cpp:46
+
core::Timer::clearTimer
void clearTimer()
Definition: Timer.cpp:33
+
core::Timer::setTimer
void setTimer(double delay)
Definition: Timer.cpp:13
core::Timer::onTimeout
virtual void onTimeout()=0
-
core::Timer::setTimer
void setTimer(double delay)
Definition: Timer.cpp:14
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/UDPServerSocket_8h_source.html b/html/UDPServerSocket_8h_source.html index bb5b4d5..a817630 100644 --- a/html/UDPServerSocket_8h_source.html +++ b/html/UDPServerSocket_8h_source.html @@ -3,7 +3,7 @@ - + My Project: UDPServerSocket.h Source File @@ -29,10 +29,10 @@ - + @@ -107,17 +107,15 @@ $(function() {
46 }
47 
48 #endif
- -
core::UDPSocket
Definition: UDPSocket.h:8
-
core::EPoll
Definition: EPoll.h:31
-
core::UDPServerSocket::onDataReceived
void onDataReceived(std::string data) override
Called when data is received from the socket.
Definition: UDPServerSocket.cpp:35
core::Command
Definition: Command.h:22
+
core::EPoll
Definition: EPoll.h:31
core::UDPServerSocket
Definition: UDPServerSocket.h:17
+
core::UDPServerSocket::onDataReceived
void onDataReceived(std::string data) override
Called when data is received from the socket.
Definition: UDPServerSocket.cpp:35
+
core::UDPSocket
Definition: UDPSocket.h:8
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/UDPSocket_8h_source.html b/html/UDPSocket_8h_source.html index 8051b7d..f94e980 100644 --- a/html/UDPSocket_8h_source.html +++ b/html/UDPSocket_8h_source.html @@ -3,7 +3,7 @@ - + My Project: UDPSocket.h Source File @@ -29,10 +29,10 @@ - + @@ -86,15 +86,13 @@ $(function() {
19 }
20 
21 #endif
- -
core::UDPSocket
Definition: UDPSocket.h:8
-
core::Socket
Definition: Socket.h:34
core::EPoll
Definition: EPoll.h:31
+
core::Socket
Definition: Socket.h:34
+
core::UDPSocket
Definition: UDPSocket.h:8
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/annotated.html b/html/annotated.html index 5031810..90567c4 100644 --- a/html/annotated.html +++ b/html/annotated.html @@ -3,7 +3,7 @@ - + My Project: Class List @@ -29,10 +29,10 @@ - + @@ -97,9 +97,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1Command-members.html b/html/classcore_1_1Command-members.html index 835cfd7..8f96c6d 100644 --- a/html/classcore_1_1Command-members.html +++ b/html/classcore_1_1Command-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@ - + @@ -77,9 +77,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1Command.html b/html/classcore_1_1Command.html index ee7b01b..c2e23e2 100644 --- a/html/classcore_1_1Command.html +++ b/html/classcore_1_1Command.html @@ -3,7 +3,7 @@ - + My Project: core::Command Class Reference @@ -29,10 +29,10 @@ - + @@ -77,8 +77,8 @@ $(function() {
Inheritance diagram for core::Command:
-
Inheritance graph
- +
Inheritance graph
+ @@ -179,7 +179,7 @@ Public Member Functions
Returns
Returns 0 if execution of the command was successful. Otherwise returns a non-zero value indicating an error condition.
-

Reimplemented in core::TCPServer, core::EPoll, core::SubscriptionManager, and core::CommandList.

+

Reimplemented in core::TCPServer, core::SubscriptionManager, core::EPoll, and core::CommandList.

@@ -190,9 +190,7 @@ Public Member Functions
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1CommandList-members.html b/html/classcore_1_1CommandList-members.html index 0f5dc78..3d4fd38 100644 --- a/html/classcore_1_1CommandList-members.html +++ b/html/classcore_1_1CommandList-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@ - + @@ -86,9 +86,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1CommandList.html b/html/classcore_1_1CommandList.html index 2279dcd..5044d61 100644 --- a/html/classcore_1_1CommandList.html +++ b/html/classcore_1_1CommandList.html @@ -3,7 +3,7 @@ - + My Project: core::CommandList Class Reference @@ -29,10 +29,10 @@ - + @@ -78,8 +78,8 @@ $(function() {
Inheritance diagram for core::CommandList:
-
Inheritance graph
- +
Inheritance graph
+ @@ -87,8 +87,8 @@ Inheritance diagram for core::CommandList:
Collaboration diagram for core::CommandList:
-
Collaboration graph
- +
Collaboration graph
+ @@ -315,9 +315,7 @@ int depth
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1ConsoleServer-members.html b/html/classcore_1_1ConsoleServer-members.html index d1a894b..f676448 100644 --- a/html/classcore_1_1ConsoleServer-members.html +++ b/html/classcore_1_1ConsoleServer-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@ - + @@ -102,8 +102,8 @@ $(function() { sessionscore::TCPServer setBufferSize(int length) (defined in core::Socket)core::Socketprotected setDescriptor(int descriptor)core::Socket - shutdown(std::string text="unknown")core::Socket - shutDown (defined in core::Socket)core::Socketprotected + shutDown (defined in core::Socket)core::Socketprotected + shutdown(std::string text="unknown")core::Socket Socket(EPoll &ePoll, std::string text="")core::Socket subscriptionscore::TCPServer TCPServer(EPoll &ePoll, IPAddress address, std::string delimiter=" ", int depth=10, std::string text="")core::TCPServer @@ -118,9 +118,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1ConsoleServer.html b/html/classcore_1_1ConsoleServer.html index 33a2e11..cd703ab 100644 --- a/html/classcore_1_1ConsoleServer.html +++ b/html/classcore_1_1ConsoleServer.html @@ -3,7 +3,7 @@ - + My Project: core::ConsoleServer Class Reference @@ -29,10 +29,10 @@ - + @@ -75,8 +75,8 @@ $(function() {
Inheritance diagram for core::ConsoleServer:
-
Inheritance graph
- +
Inheritance graph
+ @@ -88,10 +88,10 @@ Inheritance diagram for core::ConsoleServer:
Collaboration diagram for core::ConsoleServer:
-
Collaboration graph
- - - +
Collaboration graph
+ + + @@ -101,7 +101,7 @@ Collaboration diagram for core::ConsoleServer:
- +
[legend]
@@ -273,9 +273,7 @@ bool 
shutDown = false<
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1ConsoleServer__coll__graph.map b/html/classcore_1_1ConsoleServer__coll__graph.map index a965c5c..edaa951 100644 --- a/html/classcore_1_1ConsoleServer__coll__graph.map +++ b/html/classcore_1_1ConsoleServer__coll__graph.map @@ -1,6 +1,6 @@ - - + + @@ -10,5 +10,5 @@ - + diff --git a/html/classcore_1_1ConsoleServer__coll__graph.md5 b/html/classcore_1_1ConsoleServer__coll__graph.md5 index bd56fc3..514cff2 100644 --- a/html/classcore_1_1ConsoleServer__coll__graph.md5 +++ b/html/classcore_1_1ConsoleServer__coll__graph.md5 @@ -1 +1 @@ -a4b24d2616622614bb85091ba80d44a3 \ No newline at end of file +6a4748f0b8ae572775a1285efc642c81 \ No newline at end of file diff --git a/html/classcore_1_1ConsoleServer__coll__graph.png b/html/classcore_1_1ConsoleServer__coll__graph.png index 314df25..57379a1 100644 Binary files a/html/classcore_1_1ConsoleServer__coll__graph.png and b/html/classcore_1_1ConsoleServer__coll__graph.png differ diff --git a/html/classcore_1_1ConsoleSession-members.html b/html/classcore_1_1ConsoleSession-members.html index eb2dbd0..fae9b38 100644 --- a/html/classcore_1_1ConsoleSession-members.html +++ b/html/classcore_1_1ConsoleSession-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@
- + @@ -111,8 +111,8 @@ $(function() { setColor(int color) (defined in core::TerminalSession)core::TerminalSession setCursorLocation(int x, int y)core::TerminalSession setDescriptor(int descriptor)core::Socket - shutdown(std::string text="unknown")core::Socket - shutDown (defined in core::Socket)core::Socketprotected + shutDown (defined in core::Socket)core::Socketprotected + shutdown(std::string text="unknown")core::Socket Socket(EPoll &ePoll, std::string text="")core::Socket TCPSession(EPoll &ePoll, TCPServer &server, std::string text="") (defined in core::TCPSession)core::TCPSession TCPSocket(EPoll &ePoll) (defined in core::TCPSocket)core::TCPSocket @@ -130,9 +130,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1ConsoleSession.html b/html/classcore_1_1ConsoleSession.html index da7ecbb..1bee875 100644 --- a/html/classcore_1_1ConsoleSession.html +++ b/html/classcore_1_1ConsoleSession.html @@ -3,7 +3,7 @@ - + My Project: core::ConsoleSession Class Reference @@ -29,10 +29,10 @@ - + @@ -78,8 +78,8 @@ $(function() {
Inheritance diagram for core::ConsoleSession:
-
Inheritance graph
- +
Inheritance graph
+ @@ -90,13 +90,13 @@ Inheritance diagram for core::ConsoleSession:
Collaboration diagram for core::ConsoleSession:
-
Collaboration graph
- - - - +
Collaboration graph
+ + + + - + @@ -309,9 +309,7 @@ bool shutDown = false<
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1ConsoleSession__coll__graph.map b/html/classcore_1_1ConsoleSession__coll__graph.map index 5962547..87103ee 100644 --- a/html/classcore_1_1ConsoleSession__coll__graph.map +++ b/html/classcore_1_1ConsoleSession__coll__graph.map @@ -1,9 +1,9 @@ - - - + + + - + diff --git a/html/classcore_1_1ConsoleSession__coll__graph.md5 b/html/classcore_1_1ConsoleSession__coll__graph.md5 index 00dccdf..fe959c2 100644 --- a/html/classcore_1_1ConsoleSession__coll__graph.md5 +++ b/html/classcore_1_1ConsoleSession__coll__graph.md5 @@ -1 +1 @@ -3ea3680f8904b0eaeeddcde70e179cd7 \ No newline at end of file +b1c8856a756096c0c77e4d4b902370cf \ No newline at end of file diff --git a/html/classcore_1_1ConsoleSession__coll__graph.png b/html/classcore_1_1ConsoleSession__coll__graph.png index 9f7f6c9..771dce8 100644 Binary files a/html/classcore_1_1ConsoleSession__coll__graph.png and b/html/classcore_1_1ConsoleSession__coll__graph.png differ diff --git a/html/classcore_1_1EPoll-members.html b/html/classcore_1_1EPoll-members.html index 0e1ef6c..4d5d273 100644 --- a/html/classcore_1_1EPoll-members.html +++ b/html/classcore_1_1EPoll-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@ - + @@ -88,9 +88,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1EPoll.html b/html/classcore_1_1EPoll.html index 1f25f73..d869591 100644 --- a/html/classcore_1_1EPoll.html +++ b/html/classcore_1_1EPoll.html @@ -3,7 +3,7 @@ - + My Project: core::EPoll Class Reference @@ -29,10 +29,10 @@ - + @@ -78,8 +78,8 @@ $(function() {
Inheritance diagram for core::EPoll:
-
Inheritance graph
- +
Inheritance graph
+ @@ -87,8 +87,8 @@ Inheritance diagram for core::EPoll:
Collaboration diagram for core::EPoll:
-
Collaboration graph
- +
Collaboration graph
+ @@ -423,9 +423,7 @@ Public Attributes
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1INotify-members.html b/html/classcore_1_1INotify-members.html index 798c18d..e8e6746 100644 --- a/html/classcore_1_1INotify-members.html +++ b/html/classcore_1_1INotify-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@ - + @@ -93,9 +93,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1INotify.html b/html/classcore_1_1INotify.html index 1a8c9d4..48503d5 100644 --- a/html/classcore_1_1INotify.html +++ b/html/classcore_1_1INotify.html @@ -3,7 +3,7 @@ - + My Project: core::INotify Class Reference @@ -29,10 +29,10 @@ - + @@ -75,8 +75,8 @@ $(function() {
Inheritance diagram for core::INotify:
-
Inheritance graph
- +
Inheritance graph
+ @@ -84,8 +84,8 @@ Inheritance diagram for core::INotify:
Collaboration diagram for core::INotify:
-
Collaboration graph
- +
Collaboration graph
+ @@ -151,9 +151,7 @@ virtual void inOpen (s
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1IPAddress-members.html b/html/classcore_1_1IPAddress-members.html index d7627c8..6748819 100644 --- a/html/classcore_1_1IPAddress-members.html +++ b/html/classcore_1_1IPAddress-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@ - + @@ -87,9 +87,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1IPAddress.html b/html/classcore_1_1IPAddress.html index 2462a42..bd38e33 100644 --- a/html/classcore_1_1IPAddress.html +++ b/html/classcore_1_1IPAddress.html @@ -3,7 +3,7 @@ - + My Project: core::IPAddress Class Reference @@ -29,10 +29,10 @@ - + @@ -76,8 +76,8 @@ $(function() {
Inheritance diagram for core::IPAddress:
-
Inheritance graph
- +
Inheritance graph
+ @@ -85,8 +85,8 @@ Inheritance diagram for core::IPAddress:
Collaboration diagram for core::IPAddress:
-
Collaboration graph
- +
Collaboration graph
+ @@ -139,9 +139,7 @@ std::string tag
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1IPAddressList-members.html b/html/classcore_1_1IPAddressList-members.html index 8d59b01..f8713a5 100644 --- a/html/classcore_1_1IPAddressList-members.html +++ b/html/classcore_1_1IPAddressList-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@
- + @@ -80,9 +80,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1IPAddressList.html b/html/classcore_1_1IPAddressList.html index 1b49e33..ffef6e9 100644 --- a/html/classcore_1_1IPAddressList.html +++ b/html/classcore_1_1IPAddressList.html @@ -3,7 +3,7 @@ - + My Project: core::IPAddressList Class Reference @@ -29,10 +29,10 @@ - + @@ -95,9 +95,7 @@ bool contains (std::st
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1Object-members.html b/html/classcore_1_1Object-members.html index 3c02168..657efbb 100644 --- a/html/classcore_1_1Object-members.html +++ b/html/classcore_1_1Object-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@ - + @@ -77,9 +77,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1Object.html b/html/classcore_1_1Object.html index 5b5af45..366996b 100644 --- a/html/classcore_1_1Object.html +++ b/html/classcore_1_1Object.html @@ -3,7 +3,7 @@ - + My Project: core::Object Class Reference @@ -29,10 +29,10 @@ - + @@ -75,8 +75,8 @@ $(function() {
Inheritance diagram for core::Object:
-
Inheritance graph
- +
Inheritance graph
+ @@ -99,9 +99,7 @@ std::string tag
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1SessionFilter-members.html b/html/classcore_1_1SessionFilter-members.html index b1defab..b29edc6 100644 --- a/html/classcore_1_1SessionFilter-members.html +++ b/html/classcore_1_1SessionFilter-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@
- + @@ -78,9 +78,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1SessionFilter.html b/html/classcore_1_1SessionFilter.html index 499cc97..69d958e 100644 --- a/html/classcore_1_1SessionFilter.html +++ b/html/classcore_1_1SessionFilter.html @@ -3,7 +3,7 @@ - + My Project: core::SessionFilter Class Reference @@ -29,10 +29,10 @@ - + @@ -75,8 +75,8 @@ $(function() {
Inheritance diagram for core::SessionFilter:
-
Inheritance graph
- +
Inheritance graph
+ @@ -84,8 +84,8 @@ Inheritance diagram for core::SessionFilter:
Collaboration diagram for core::SessionFilter:
-
Collaboration graph
- +
Collaboration graph
+ @@ -113,9 +113,7 @@ std::string tag
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1Socket-members.html b/html/classcore_1_1Socket-members.html index 3e0486b..cc1fa27 100644 --- a/html/classcore_1_1Socket-members.html +++ b/html/classcore_1_1Socket-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@
- + @@ -97,9 +97,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1Socket.html b/html/classcore_1_1Socket.html index 39840bd..5227104 100644 --- a/html/classcore_1_1Socket.html +++ b/html/classcore_1_1Socket.html @@ -3,7 +3,7 @@ - + My Project: core::Socket Class Reference @@ -29,10 +29,10 @@ - + @@ -80,28 +80,28 @@ $(function() {
Inheritance diagram for core::Socket:
-
Inheritance graph
- - - - - - - - +
Inheritance graph
+ + + + + + + + - - - - + + + +
[legend]
Collaboration diagram for core::Socket:
-
Collaboration graph
- +
Collaboration graph
+ @@ -311,7 +311,7 @@ bool shutDown = false< -

Reimplemented in core::TCPServer, and core::UDPServerSocket.

+

Reimplemented in core::UDPServerSocket, and core::TCPServer.

@@ -468,9 +468,7 @@ bool shutDown = false<
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1Socket__inherit__graph.map b/html/classcore_1_1Socket__inherit__graph.map index dcda273..100c456 100644 --- a/html/classcore_1_1Socket__inherit__graph.map +++ b/html/classcore_1_1Socket__inherit__graph.map @@ -1,15 +1,15 @@ - - - - - - - + + + + + + + - - - - + + + + diff --git a/html/classcore_1_1Socket__inherit__graph.md5 b/html/classcore_1_1Socket__inherit__graph.md5 index 3962575..17374d0 100644 --- a/html/classcore_1_1Socket__inherit__graph.md5 +++ b/html/classcore_1_1Socket__inherit__graph.md5 @@ -1 +1 @@ -185d6387a6977d88fc83ef4a6b08a0ac \ No newline at end of file +973318a6709306b209b8a85aac82b311 \ No newline at end of file diff --git a/html/classcore_1_1Socket__inherit__graph.png b/html/classcore_1_1Socket__inherit__graph.png index cb84ae6..fecc24d 100644 Binary files a/html/classcore_1_1Socket__inherit__graph.png and b/html/classcore_1_1Socket__inherit__graph.png differ diff --git a/html/classcore_1_1Subscription-members.html b/html/classcore_1_1Subscription-members.html index 01d51a7..bf4d3db 100644 --- a/html/classcore_1_1Subscription-members.html +++ b/html/classcore_1_1Subscription-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@ - + @@ -78,7 +78,7 @@ $(function() { mode (defined in core::Subscription)core::Subscription onSubscribe(TCPSession &session) (defined in core::Subscription)core::Subscriptionvirtual owner (defined in core::Subscription)core::Subscription - process(coreutils::ZString &request, std::stringstream &out) (defined in core::Subscription)core::Subscriptionvirtual + process(coreutils::ZString &request, std::stringstream &out, TCPSession &session) (defined in core::Subscription)core::Subscriptionvirtual subscribe(TCPSession &session) (defined in core::Subscription)core::Subscription subscribers (defined in core::Subscription)core::Subscription Subscription(std::string id, std::string mode="*AUTHOR") (defined in core::Subscription)core::Subscription @@ -88,9 +88,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1Subscription.html b/html/classcore_1_1Subscription.html index dcd816c..4bd1830 100644 --- a/html/classcore_1_1Subscription.html +++ b/html/classcore_1_1Subscription.html @@ -3,7 +3,7 @@ - + My Project: core::Subscription Class Reference @@ -29,10 +29,10 @@ - + @@ -76,12 +76,12 @@ $(function() {
Collaboration diagram for core::Subscription:
-
Collaboration graph
- - - +
Collaboration graph
+ + + - + @@ -107,9 +107,9 @@ int subscribe ( int unsubscribe (TCPSession &session)   - -virtual int process (coreutils::ZString &request, std::stringstream &out) -  + +virtual int process (coreutils::ZString &request, std::stringstream &out, TCPSession &session) +  virtual int onSubscribe (TCPSession &session)   @@ -142,9 +142,7 @@ std::vector< TCPSession
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1SubscriptionManager-members.html b/html/classcore_1_1SubscriptionManager-members.html index a9a836f..98308d3 100644 --- a/html/classcore_1_1SubscriptionManager-members.html +++ b/html/classcore_1_1SubscriptionManager-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@ - + @@ -80,9 +80,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1SubscriptionManager.html b/html/classcore_1_1SubscriptionManager.html index 80f004b..558182a 100644 --- a/html/classcore_1_1SubscriptionManager.html +++ b/html/classcore_1_1SubscriptionManager.html @@ -3,7 +3,7 @@ - + My Project: core::SubscriptionManager Class Reference @@ -29,10 +29,10 @@ - + @@ -75,8 +75,8 @@ $(function() {
Inheritance diagram for core::SubscriptionManager:
-
Inheritance graph
- +
Inheritance graph
+ @@ -84,8 +84,8 @@ Inheritance diagram for core::SubscriptionManager:
Collaboration diagram for core::SubscriptionManager:
-
Collaboration graph
- +
Collaboration graph
+ @@ -160,9 +160,7 @@ int removeSessionSubscript
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1Subscription__coll__graph.map b/html/classcore_1_1Subscription__coll__graph.map index 1077d59..284eb43 100644 --- a/html/classcore_1_1Subscription__coll__graph.map +++ b/html/classcore_1_1Subscription__coll__graph.map @@ -1,8 +1,8 @@ - - + + - + diff --git a/html/classcore_1_1Subscription__coll__graph.md5 b/html/classcore_1_1Subscription__coll__graph.md5 index cb19770..d8c5317 100644 --- a/html/classcore_1_1Subscription__coll__graph.md5 +++ b/html/classcore_1_1Subscription__coll__graph.md5 @@ -1 +1 @@ -f46787e7174c526c000fac584b36e377 \ No newline at end of file +3f390c0fbcf254a8f2dec14ce3855745 \ No newline at end of file diff --git a/html/classcore_1_1Subscription__coll__graph.png b/html/classcore_1_1Subscription__coll__graph.png index aa7f1ca..37c2930 100644 Binary files a/html/classcore_1_1Subscription__coll__graph.png and b/html/classcore_1_1Subscription__coll__graph.png differ diff --git a/html/classcore_1_1TCPServer-members.html b/html/classcore_1_1TCPServer-members.html index 6de9583..f0ea3d8 100644 --- a/html/classcore_1_1TCPServer-members.html +++ b/html/classcore_1_1TCPServer-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@ - + @@ -100,8 +100,8 @@ $(function() { sessionscore::TCPServer setBufferSize(int length) (defined in core::Socket)core::Socketprotected setDescriptor(int descriptor)core::Socket - shutdown(std::string text="unknown")core::Socket - shutDown (defined in core::Socket)core::Socketprotected + shutDown (defined in core::Socket)core::Socketprotected + shutdown(std::string text="unknown")core::Socket Socket(EPoll &ePoll, std::string text="")core::Socket subscriptionscore::TCPServer TCPServer(EPoll &ePoll, IPAddress address, std::string delimiter=" ", int depth=10, std::string text="")core::TCPServer @@ -116,9 +116,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1TCPServer.html b/html/classcore_1_1TCPServer.html index aac2a02..fd3add4 100644 --- a/html/classcore_1_1TCPServer.html +++ b/html/classcore_1_1TCPServer.html @@ -3,7 +3,7 @@ - + My Project: core::TCPServer Class Reference @@ -29,10 +29,10 @@ - + @@ -79,8 +79,8 @@ $(function() {
Inheritance diagram for core::TCPServer:
-
Inheritance graph
- +
Inheritance graph
+ @@ -92,9 +92,9 @@ Inheritance diagram for core::TCPServer:
Collaboration diagram for core::TCPServer:
-
Collaboration graph
- - +
Collaboration graph
+ + @@ -581,9 +581,7 @@ bool shutDown = false<
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1TCPServer__coll__graph.map b/html/classcore_1_1TCPServer__coll__graph.map index f93eb15..d436c64 100644 --- a/html/classcore_1_1TCPServer__coll__graph.map +++ b/html/classcore_1_1TCPServer__coll__graph.map @@ -1,5 +1,5 @@ - + diff --git a/html/classcore_1_1TCPServer__coll__graph.md5 b/html/classcore_1_1TCPServer__coll__graph.md5 index b51a249..aa1fee4 100644 --- a/html/classcore_1_1TCPServer__coll__graph.md5 +++ b/html/classcore_1_1TCPServer__coll__graph.md5 @@ -1 +1 @@ -59c54a3073d61eb2d5c2494d0d4f3693 \ No newline at end of file +5639fb4f18abd97029a84f66b9653ec4 \ No newline at end of file diff --git a/html/classcore_1_1TCPServer__coll__graph.png b/html/classcore_1_1TCPServer__coll__graph.png index 1f1a120..54b413e 100644 Binary files a/html/classcore_1_1TCPServer__coll__graph.png and b/html/classcore_1_1TCPServer__coll__graph.png differ diff --git a/html/classcore_1_1TCPSession-members.html b/html/classcore_1_1TCPSession-members.html index d749e42..87a7975 100644 --- a/html/classcore_1_1TCPSession-members.html +++ b/html/classcore_1_1TCPSession-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@ - + @@ -99,8 +99,8 @@ $(function() { setBlockSize(int size=0)core::TCPSessionprotected setBufferSize(int length) (defined in core::Socket)core::Socketprotected setDescriptor(int descriptor)core::Socket - shutDown (defined in core::Socket)core::Socketprotected - shutdown(std::string text="unknown")core::Socket + shutdown(std::string text="unknown")core::Socket + shutDown (defined in core::Socket)core::Socketprotected Socket(EPoll &ePoll, std::string text="")core::Socket TCPSession(EPoll &ePoll, TCPServer &server, std::string text="") (defined in core::TCPSession)core::TCPSession TCPSocket(EPoll &ePoll) (defined in core::TCPSocket)core::TCPSocket @@ -114,9 +114,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1TCPSession.html b/html/classcore_1_1TCPSession.html index e86d808..d8ec44f 100644 --- a/html/classcore_1_1TCPSession.html +++ b/html/classcore_1_1TCPSession.html @@ -3,7 +3,7 @@ - + My Project: core::TCPSession Class Reference @@ -29,10 +29,10 @@ - + @@ -79,24 +79,24 @@ $(function() {
Inheritance diagram for core::TCPSession:
-
Inheritance graph
- - - - - - - +
Inheritance graph
+ + + + + + +
[legend]
Collaboration diagram for core::TCPSession:
-
Collaboration graph
- - +
Collaboration graph
+ + - + @@ -488,9 +488,7 @@ bool shutDown = false<
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1TCPSession__coll__graph.map b/html/classcore_1_1TCPSession__coll__graph.map index dd1c07a..95ab801 100644 --- a/html/classcore_1_1TCPSession__coll__graph.map +++ b/html/classcore_1_1TCPSession__coll__graph.map @@ -1,7 +1,7 @@ - + - + diff --git a/html/classcore_1_1TCPSession__coll__graph.md5 b/html/classcore_1_1TCPSession__coll__graph.md5 index 6e90595..65a5f32 100644 --- a/html/classcore_1_1TCPSession__coll__graph.md5 +++ b/html/classcore_1_1TCPSession__coll__graph.md5 @@ -1 +1 @@ -aa17541238793b20f5d52674df1cf143 \ No newline at end of file +f4b2ea20b43a4c6fce9b1fc6f65cd817 \ No newline at end of file diff --git a/html/classcore_1_1TCPSession__coll__graph.png b/html/classcore_1_1TCPSession__coll__graph.png index 41c272a..9900017 100644 Binary files a/html/classcore_1_1TCPSession__coll__graph.png and b/html/classcore_1_1TCPSession__coll__graph.png differ diff --git a/html/classcore_1_1TCPSession__inherit__graph.map b/html/classcore_1_1TCPSession__inherit__graph.map index 68ef12d..90087bd 100644 --- a/html/classcore_1_1TCPSession__inherit__graph.map +++ b/html/classcore_1_1TCPSession__inherit__graph.map @@ -1,8 +1,8 @@ - - - - - - + + + + + + diff --git a/html/classcore_1_1TCPSession__inherit__graph.md5 b/html/classcore_1_1TCPSession__inherit__graph.md5 index 46de59c..96bbb72 100644 --- a/html/classcore_1_1TCPSession__inherit__graph.md5 +++ b/html/classcore_1_1TCPSession__inherit__graph.md5 @@ -1 +1 @@ -6b06cb3f74d796a7c36b9f95ec14a5a3 \ No newline at end of file +39b44b8ff3d3a261df40d4e8e510c5ac \ No newline at end of file diff --git a/html/classcore_1_1TCPSession__inherit__graph.png b/html/classcore_1_1TCPSession__inherit__graph.png index d76d109..1615f7b 100644 Binary files a/html/classcore_1_1TCPSession__inherit__graph.png and b/html/classcore_1_1TCPSession__inherit__graph.png differ diff --git a/html/classcore_1_1TCPSocket-members.html b/html/classcore_1_1TCPSocket-members.html index 0503221..da1757c 100644 --- a/html/classcore_1_1TCPSocket-members.html +++ b/html/classcore_1_1TCPSocket-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@ - + @@ -90,8 +90,8 @@ $(function() { reset (defined in core::Socket)core::Socket setBufferSize(int length) (defined in core::Socket)core::Socketprotected setDescriptor(int descriptor)core::Socket - shutDown (defined in core::Socket)core::Socketprotected - shutdown(std::string text="unknown")core::Socket + shutdown(std::string text="unknown")core::Socket + shutDown (defined in core::Socket)core::Socketprotected Socket(EPoll &ePoll, std::string text="")core::Socket TCPSocket(EPoll &ePoll) (defined in core::TCPSocket)core::TCPSocket TCPSocket(EPoll &ePoll, std::string text) (defined in core::TCPSocket)core::TCPSocket @@ -102,9 +102,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1TCPSocket.html b/html/classcore_1_1TCPSocket.html index 4d1d3f7..e4e8c64 100644 --- a/html/classcore_1_1TCPSocket.html +++ b/html/classcore_1_1TCPSocket.html @@ -3,7 +3,7 @@ - + My Project: core::TCPSocket Class Reference @@ -29,10 +29,10 @@ - + @@ -78,24 +78,24 @@ $(function() {
Inheritance diagram for core::TCPSocket:
-
Inheritance graph
- - - - - +
Inheritance graph
+ + + + + - - - + + +
[legend]
Collaboration diagram for core::TCPSocket:
-
Collaboration graph
- +
Collaboration graph
+ @@ -226,7 +226,7 @@ bool shutDown = false<

The output method is called by a socket session (TCPSession) and will output the detail information for the client socket. When extending BMATCPSocket or BMASession you can override the method to add attributes to the list.

-

Reimplemented in core::TCPServer, core::TLSSession, and core::TCPSession.

+

Reimplemented in core::TLSSession, core::TCPServer, and core::TCPSession.

@@ -237,9 +237,7 @@ bool shutDown = false<
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1TCPSocket__inherit__graph.map b/html/classcore_1_1TCPSocket__inherit__graph.map index 5f54070..2ccc234 100644 --- a/html/classcore_1_1TCPSocket__inherit__graph.map +++ b/html/classcore_1_1TCPSocket__inherit__graph.map @@ -1,11 +1,11 @@ - - - - + + + + - - - + + + diff --git a/html/classcore_1_1TCPSocket__inherit__graph.md5 b/html/classcore_1_1TCPSocket__inherit__graph.md5 index 89ea7c9..9dc21e2 100644 --- a/html/classcore_1_1TCPSocket__inherit__graph.md5 +++ b/html/classcore_1_1TCPSocket__inherit__graph.md5 @@ -1 +1 @@ -da0b2a65b80abe6856bfb7c62b6a4713 \ No newline at end of file +b00eaaaf3a0f062e6988b61f3e846f66 \ No newline at end of file diff --git a/html/classcore_1_1TCPSocket__inherit__graph.png b/html/classcore_1_1TCPSocket__inherit__graph.png index 95c05f3..b777731 100644 Binary files a/html/classcore_1_1TCPSocket__inherit__graph.png and b/html/classcore_1_1TCPSocket__inherit__graph.png differ diff --git a/html/classcore_1_1TLSServer-members.html b/html/classcore_1_1TLSServer-members.html index ffdfc4e..1c78c24 100644 --- a/html/classcore_1_1TLSServer-members.html +++ b/html/classcore_1_1TLSServer-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@ - + @@ -120,9 +120,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1TLSServer.html b/html/classcore_1_1TLSServer.html index ad9a60a..a80c7a4 100644 --- a/html/classcore_1_1TLSServer.html +++ b/html/classcore_1_1TLSServer.html @@ -3,7 +3,7 @@ - + My Project: core::TLSServer Class Reference @@ -29,10 +29,10 @@ - + @@ -78,8 +78,8 @@ $(function() {
Inheritance diagram for core::TLSServer:
-
Inheritance graph
- +
Inheritance graph
+ @@ -90,10 +90,10 @@ Inheritance diagram for core::TLSServer:
Collaboration diagram for core::TLSServer:
-
Collaboration graph
- - - +
Collaboration graph
+ + + @@ -312,9 +312,7 @@ bool shutDown = false<
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1TLSServer__coll__graph.map b/html/classcore_1_1TLSServer__coll__graph.map index 0420b4f..bba46f4 100644 --- a/html/classcore_1_1TLSServer__coll__graph.map +++ b/html/classcore_1_1TLSServer__coll__graph.map @@ -1,6 +1,6 @@ - - + + diff --git a/html/classcore_1_1TLSServer__coll__graph.md5 b/html/classcore_1_1TLSServer__coll__graph.md5 index e0a1ef7..ea77a29 100644 --- a/html/classcore_1_1TLSServer__coll__graph.md5 +++ b/html/classcore_1_1TLSServer__coll__graph.md5 @@ -1 +1 @@ -76896c7990b148e807da466a9407f6ec \ No newline at end of file +3e243acdb497b9bc4cdc223ddc77fef7 \ No newline at end of file diff --git a/html/classcore_1_1TLSServer__coll__graph.png b/html/classcore_1_1TLSServer__coll__graph.png index 0850798..ff424d9 100644 Binary files a/html/classcore_1_1TLSServer__coll__graph.png and b/html/classcore_1_1TLSServer__coll__graph.png differ diff --git a/html/classcore_1_1TLSSession-members.html b/html/classcore_1_1TLSSession-members.html index 3060d82..ebc3f2b 100644 --- a/html/classcore_1_1TLSSession-members.html +++ b/html/classcore_1_1TLSSession-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@ - + @@ -99,8 +99,8 @@ $(function() { setBlockSize(int size=0)core::TCPSessionprotected setBufferSize(int length) (defined in core::Socket)core::Socketprotected setDescriptor(int descriptor)core::Socket - shutdown(std::string text="unknown")core::Socket - shutDown (defined in core::Socket)core::Socketprotected + shutDown (defined in core::Socket)core::Socketprotected + shutdown(std::string text="unknown")core::Socket Socket(EPoll &ePoll, std::string text="")core::Socket TCPSession(EPoll &ePoll, TCPServer &server, std::string text="") (defined in core::TCPSession)core::TCPSession TCPSocket(EPoll &ePoll) (defined in core::TCPSocket)core::TCPSocket @@ -116,9 +116,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1TLSSession.html b/html/classcore_1_1TLSSession.html index 6a9a870..c46993c 100644 --- a/html/classcore_1_1TLSSession.html +++ b/html/classcore_1_1TLSSession.html @@ -3,7 +3,7 @@ - + My Project: core::TLSSession Class Reference @@ -29,10 +29,10 @@ - + @@ -78,8 +78,8 @@ $(function() {
Inheritance diagram for core::TLSSession:
-
Inheritance graph
- +
Inheritance graph
+ @@ -89,12 +89,12 @@ Inheritance diagram for core::TLSSession:
Collaboration diagram for core::TLSSession:
-
Collaboration graph
- - - +
Collaboration graph
+ + + - + @@ -359,9 +359,7 @@ bool shutDown = false<
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1TLSSession__coll__graph.map b/html/classcore_1_1TLSSession__coll__graph.map index 793117f..5dda010 100644 --- a/html/classcore_1_1TLSSession__coll__graph.map +++ b/html/classcore_1_1TLSSession__coll__graph.map @@ -1,8 +1,8 @@ - - + + - + diff --git a/html/classcore_1_1TLSSession__coll__graph.md5 b/html/classcore_1_1TLSSession__coll__graph.md5 index 504d5f7..a3bdf25 100644 --- a/html/classcore_1_1TLSSession__coll__graph.md5 +++ b/html/classcore_1_1TLSSession__coll__graph.md5 @@ -1 +1 @@ -4ea50dd94a1cee6dcc0c5ddfb4a41dba \ No newline at end of file +33ffca78cfc0d61f74c28ece7bc4061e \ No newline at end of file diff --git a/html/classcore_1_1TLSSession__coll__graph.png b/html/classcore_1_1TLSSession__coll__graph.png index 3054536..8befdc3 100644 Binary files a/html/classcore_1_1TLSSession__coll__graph.png and b/html/classcore_1_1TLSSession__coll__graph.png differ diff --git a/html/classcore_1_1TerminalSession-members.html b/html/classcore_1_1TerminalSession-members.html index 3cca8c1..f74e7f2 100644 --- a/html/classcore_1_1TerminalSession-members.html +++ b/html/classcore_1_1TerminalSession-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@ - + @@ -110,8 +110,8 @@ $(function() { setColor(int color) (defined in core::TerminalSession)core::TerminalSession setCursorLocation(int x, int y)core::TerminalSession setDescriptor(int descriptor)core::Socket - shutdown(std::string text="unknown")core::Socket - shutDown (defined in core::Socket)core::Socketprotected + shutDown (defined in core::Socket)core::Socketprotected + shutdown(std::string text="unknown")core::Socket Socket(EPoll &ePoll, std::string text="")core::Socket TCPSession(EPoll &ePoll, TCPServer &server, std::string text="") (defined in core::TCPSession)core::TCPSession TCPSocket(EPoll &ePoll) (defined in core::TCPSocket)core::TCPSocket @@ -127,9 +127,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1TerminalSession.html b/html/classcore_1_1TerminalSession.html index 25c8a3c..f9760f0 100644 --- a/html/classcore_1_1TerminalSession.html +++ b/html/classcore_1_1TerminalSession.html @@ -3,7 +3,7 @@ - + My Project: core::TerminalSession Class Reference @@ -29,10 +29,10 @@ - + @@ -75,8 +75,8 @@ $(function() {
Inheritance diagram for core::TerminalSession:
-
Inheritance graph
- +
Inheritance graph
+ @@ -87,12 +87,12 @@ Inheritance diagram for core::TerminalSession:
Collaboration diagram for core::TerminalSession:
-
Collaboration graph
- - - +
Collaboration graph
+ + + - + @@ -327,9 +327,7 @@ bool shutDown = false<
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1TerminalSession__coll__graph.map b/html/classcore_1_1TerminalSession__coll__graph.map index 52a0a43..236f734 100644 --- a/html/classcore_1_1TerminalSession__coll__graph.map +++ b/html/classcore_1_1TerminalSession__coll__graph.map @@ -1,8 +1,8 @@ - - + + - + diff --git a/html/classcore_1_1TerminalSession__coll__graph.md5 b/html/classcore_1_1TerminalSession__coll__graph.md5 index ed8d082..2f3b54a 100644 --- a/html/classcore_1_1TerminalSession__coll__graph.md5 +++ b/html/classcore_1_1TerminalSession__coll__graph.md5 @@ -1 +1 @@ -99b4e713e1e13e94520e8119076aaba2 \ No newline at end of file +3c71f5c80db15ac7249ac999b7570c91 \ No newline at end of file diff --git a/html/classcore_1_1TerminalSession__coll__graph.png b/html/classcore_1_1TerminalSession__coll__graph.png index e87c87c..7557e67 100644 Binary files a/html/classcore_1_1TerminalSession__coll__graph.png and b/html/classcore_1_1TerminalSession__coll__graph.png differ diff --git a/html/classcore_1_1Thread-members.html b/html/classcore_1_1Thread-members.html index 15fd539..8fb9c0b 100644 --- a/html/classcore_1_1Thread-members.html +++ b/html/classcore_1_1Thread-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@ - + @@ -86,9 +86,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1Thread.html b/html/classcore_1_1Thread.html index a1fcd8a..9dff38a 100644 --- a/html/classcore_1_1Thread.html +++ b/html/classcore_1_1Thread.html @@ -3,7 +3,7 @@ - + My Project: core::Thread Class Reference @@ -29,10 +29,10 @@ - + @@ -77,8 +77,8 @@ $(function() {
Inheritance diagram for core::Thread:
-
Inheritance graph
- +
Inheritance graph
+ @@ -86,8 +86,8 @@ Inheritance diagram for core::Thread:
Collaboration diagram for core::Thread:
-
Collaboration graph
- +
Collaboration graph
+ @@ -158,9 +158,7 @@ std::string tag
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1ThreadScope-members.html b/html/classcore_1_1ThreadScope-members.html index a53e37a..2bb2fb6 100644 --- a/html/classcore_1_1ThreadScope-members.html +++ b/html/classcore_1_1ThreadScope-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@
- + @@ -76,9 +76,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1ThreadScope.html b/html/classcore_1_1ThreadScope.html index 600d596..1304ea1 100644 --- a/html/classcore_1_1ThreadScope.html +++ b/html/classcore_1_1ThreadScope.html @@ -3,7 +3,7 @@ - + My Project: core::ThreadScope Class Reference @@ -29,10 +29,10 @@ - + @@ -77,9 +77,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1Timer-members.html b/html/classcore_1_1Timer-members.html index d24d3bf..d71eb6d 100644 --- a/html/classcore_1_1Timer-members.html +++ b/html/classcore_1_1Timer-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@ - + @@ -84,9 +84,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1Timer.html b/html/classcore_1_1Timer.html index 2f5a4b1..37e1526 100644 --- a/html/classcore_1_1Timer.html +++ b/html/classcore_1_1Timer.html @@ -3,7 +3,7 @@ - + My Project: core::Timer Class Reference @@ -29,10 +29,10 @@ - + @@ -78,8 +78,8 @@ $(function() {
Inheritance diagram for core::Timer:
-
Inheritance graph
- +
Inheritance graph
+ @@ -87,8 +87,8 @@ Inheritance diagram for core::Timer:
Collaboration diagram for core::Timer:
-
Collaboration graph
- +
Collaboration graph
+ @@ -218,9 +218,7 @@ Protected Member Functions
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1UDPServerSocket-members.html b/html/classcore_1_1UDPServerSocket-members.html index e9fce45..8640d42 100644 --- a/html/classcore_1_1UDPServerSocket-members.html +++ b/html/classcore_1_1UDPServerSocket-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@ - + @@ -92,8 +92,8 @@ $(function() { sessions (defined in core::UDPServerSocket)core::UDPServerSocketprotected setBufferSize(int length) (defined in core::Socket)core::Socketprotected setDescriptor(int descriptor)core::Socket - shutdown(std::string text="unknown")core::Socket - shutDown (defined in core::Socket)core::Socketprotected + shutDown (defined in core::Socket)core::Socketprotected + shutdown(std::string text="unknown")core::Socket Socket(EPoll &ePoll, std::string text="")core::Socket UDPServerSocket(EPoll &ePoll, std::string url, short int port, std::string commandName) (defined in core::UDPServerSocket)core::UDPServerSocket UDPSocket(EPoll &ePoll) (defined in core::UDPSocket)core::UDPSocket @@ -105,9 +105,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1UDPServerSocket.html b/html/classcore_1_1UDPServerSocket.html index 56bf9ca..e4c9b08 100644 --- a/html/classcore_1_1UDPServerSocket.html +++ b/html/classcore_1_1UDPServerSocket.html @@ -3,7 +3,7 @@ - + My Project: core::UDPServerSocket Class Reference @@ -29,10 +29,10 @@ - + @@ -79,8 +79,8 @@ $(function() {
Inheritance diagram for core::UDPServerSocket:
-
Inheritance graph
- +
Inheritance graph
+ @@ -90,8 +90,8 @@ Inheritance diagram for core::UDPServerSocket:
Collaboration diagram for core::UDPServerSocket:
-
Collaboration graph
- +
Collaboration graph
+ @@ -246,9 +246,7 @@ bool reset = false
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1UDPSocket-members.html b/html/classcore_1_1UDPSocket-members.html index ac5353f..dd7aa19 100644 --- a/html/classcore_1_1UDPSocket-members.html +++ b/html/classcore_1_1UDPSocket-members.html @@ -3,7 +3,7 @@ - + My Project: Member List @@ -29,10 +29,10 @@
- + @@ -99,9 +99,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classcore_1_1UDPSocket.html b/html/classcore_1_1UDPSocket.html index c7cb661..a0ab9aa 100644 --- a/html/classcore_1_1UDPSocket.html +++ b/html/classcore_1_1UDPSocket.html @@ -3,7 +3,7 @@ - + My Project: core::UDPSocket Class Reference @@ -29,10 +29,10 @@ - + @@ -75,8 +75,8 @@ $(function() {
Inheritance diagram for core::UDPSocket:
-
Inheritance graph
- +
Inheritance graph
+ @@ -85,8 +85,8 @@ Inheritance diagram for core::UDPSocket:
Collaboration diagram for core::UDPSocket:
-
Collaboration graph
- +
Collaboration graph
+ @@ -178,9 +178,7 @@ bool shutDown = false<
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/classes.html b/html/classes.html index 9b4709b..4a8d4b0 100644 --- a/html/classes.html +++ b/html/classes.html @@ -3,7 +3,7 @@ - + My Project: Class Index @@ -29,10 +29,10 @@ - + @@ -65,64 +65,34 @@ $(function() {
Class Index
-
c | e | i | o | s | t | u
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  c  
-
  i  
-
  s  
-		TCPSession (core)   
  u  
-
TCPSocket (core)   
Command (core)   INotify (core)   SessionFilter (core)   TerminalSession (core)   UDPServerSocket (core)   
CommandList (core)   IPAddress (core)   Socket (core)   Thread (core)   UDPSocket (core)   
ConsoleServer (core)   IPAddressList (core)   Subscription (core)   ThreadScope (core)   
ConsoleSession (core)   
  o  
-		SubscriptionManager (core)   Timer (core)   
  e  
-
  t  
-		TLSServer (core)   
Object (core)   TLSSession (core)   
EPoll (core)   TCPServer (core)   
-
c | e | i | o | s | t | u
+
C | E | I | O | S | T | U
+
+
+
C
+
Command (core)
CommandList (core)
ConsoleServer (core)
ConsoleSession (core)
+
+
E
+
EPoll (core)
+
+
I
+
INotify (core)
IPAddress (core)
IPAddressList (core)
+
+
O
+
Object (core)
+
+
S
+
SessionFilter (core)
Socket (core)
Subscription (core)
SubscriptionManager (core)
+
+
T
+
TCPServer (core)
TCPSession (core)
TCPSocket (core)
TerminalSession (core)
Thread (core)
ThreadScope (core)
Timer (core)
TLSServer (core)
TLSSession (core)
+
+
U
+
UDPServerSocket (core)
UDPSocket (core)
+
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/doxygen.css b/html/doxygen.css index 73ecbb2..ffbff02 100644 --- a/html/doxygen.css +++ b/html/doxygen.css @@ -1,4 +1,4 @@ -/* The standard CSS for doxygen 1.8.17 */ +/* The standard CSS for doxygen 1.9.1 */ body, table, div, p, dl { font: 400 14px/22px Roboto,sans-serif; @@ -66,7 +66,7 @@ p.startli, p.startdd { margin-top: 2px; } -th p.starttd, p.intertd, p.endtd { +th p.starttd, th p.intertd, th p.endtd { font-size: 100%; font-weight: 700; } @@ -103,30 +103,96 @@ caption { } span.legend { - font-size: 70%; - text-align: center; -} - -h3.version { - font-size: 90%; - text-align: center; -} - -div.qindex, div.navtab{ - background-color: #EBEFF6; - border: 1px solid #A3B4D7; + font-size: 70%; text-align: center; } -div.qindex, div.navpath { - width: 100%; - line-height: 140%; +h3.version { + font-size: 90%; + text-align: center; } div.navtab { - margin-right: 15px; + border-right: 1px solid #A3B4D7; + padding-right: 15px; + text-align: right; + line-height: 110%; } +div.navtab table { + border-spacing: 0; +} + +td.navtab { + padding-right: 6px; + padding-left: 6px; +} +td.navtabHL { + background-image: url('tab_a.png'); + background-repeat:repeat-x; + padding-right: 6px; + padding-left: 6px; +} + +td.navtabHL a, td.navtabHL a:visited { + color: #fff; + text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); +} + +a.navtab { + font-weight: bold; +} + +div.qindex{ + text-align: center; + width: 100%; + line-height: 140%; + font-size: 130%; + color: #A0A0A0; +} + +dt.alphachar{ + font-size: 180%; + font-weight: bold; +} + +.alphachar a{ + color: black; +} + +.alphachar a:hover, .alphachar a:visited{ + text-decoration: none; +} + +.classindex dl { + padding: 25px; + column-count:1 +} + +.classindex dd { + display:inline-block; + margin-left: 50px; + width: 90%; + line-height: 1.15em; +} + +.classindex dl.odd { + background-color: #F8F9FC; +} + +@media(min-width: 1120px) { + .classindex dl { + column-count:2 + } +} + +@media(min-width: 1320px) { + .classindex dl { + column-count:3 + } +} + + /* @group Link Styling */ a { @@ -143,17 +209,6 @@ a:hover { text-decoration: underline; } -a.qindex { - font-weight: bold; -} - -a.qindexHL { - font-weight: bold; - background-color: #9CAFD4; - color: #FFFFFF; - border: 1px double #869DCA; -} - .contents a.qindexHL:visited { color: #FFFFFF; } @@ -1358,10 +1413,12 @@ dl.citelist dt { font-weight:bold; margin-right:10px; padding:5px; + text-align:right; + width:52px; } dl.citelist dd { - margin:2px 0; + margin:2px 0 2px 72px; padding:5px 0; } @@ -1424,6 +1481,12 @@ div.toc li.level4 { margin-left: 45px; } +span.emoji { + /* font family used at the site: https://unicode.org/emoji/charts/full-emoji-list.html + * font-family: "Noto Color Emoji", "Apple Color Emoji", "Segoe UI Emoji", Times, Symbola, Aegyptus, Code2000, Code2001, Code2002, Musica, serif, LastResort; + */ +} + .PageDocRTL-title div.toc li.level1 { margin-left: 0 !important; margin-right: 0; @@ -1661,47 +1724,6 @@ tr.heading h2 { /* @group Markdown */ -/* -table.markdownTable { - border-collapse:collapse; - margin-top: 4px; - margin-bottom: 4px; -} - -table.markdownTable td, table.markdownTable th { - border: 1px solid #2D4068; - padding: 3px 7px 2px; -} - -table.markdownTableHead tr { -} - -table.markdownTableBodyLeft td, table.markdownTable th { - border: 1px solid #2D4068; - padding: 3px 7px 2px; -} - -th.markdownTableHeadLeft th.markdownTableHeadRight th.markdownTableHeadCenter th.markdownTableHeadNone { - background-color: #374F7F; - color: #FFFFFF; - font-size: 110%; - padding-bottom: 4px; - padding-top: 5px; -} - -th.markdownTableHeadLeft { - text-align: left -} - -th.markdownTableHeadRight { - text-align: right -} - -th.markdownTableHeadCenter { - text-align: center -} -*/ - table.markdownTable { border-collapse:collapse; margin-top: 4px; diff --git a/html/doxygen.svg b/html/doxygen.svg new file mode 100644 index 0000000..d42dad5 --- /dev/null +++ b/html/doxygen.svg @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/html/dynsections.js b/html/dynsections.js index ea0a7b3..3174bd7 100644 --- a/html/dynsections.js +++ b/html/dynsections.js @@ -1,25 +1,26 @@ /* - @licstart The following is the entire license notice for the - JavaScript code in this file. + @licstart The following is the entire license notice for the JavaScript code in this file. - Copyright (C) 1997-2017 by Dimitri van Heesch + The MIT License (MIT) - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. + Copyright (C) 1997-2020 by Dimitri van Heesch - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: - You should have received a copy of the GNU General Public License along - with this program; if not, write to the Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. - @licend The above is the entire license notice - for the JavaScript code in this file + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file */ function toggleVisibility(linkObj) { diff --git a/html/files.html b/html/files.html index 09a7307..0ac0d77 100644 --- a/html/files.html +++ b/html/files.html @@ -3,7 +3,7 @@ - + My Project: File List @@ -29,10 +29,10 @@ - + @@ -96,9 +96,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/functions.html b/html/functions.html index a5b711c..3817e37 100644 --- a/html/functions.html +++ b/html/functions.html @@ -3,7 +3,7 @@ - + My Project: Class Members @@ -29,10 +29,10 @@ - + @@ -311,9 +311,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/functions_func.html b/html/functions_func.html index e1f36a6..ff8d96c 100644 --- a/html/functions_func.html +++ b/html/functions_func.html @@ -3,7 +3,7 @@ - + My Project: Class Members - Functions @@ -29,10 +29,10 @@ - + @@ -281,9 +281,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/functions_vars.html b/html/functions_vars.html index 3bd681c..5ebf48c 100644 --- a/html/functions_vars.html +++ b/html/functions_vars.html @@ -3,7 +3,7 @@ - + My Project: Class Members - Variables @@ -29,10 +29,10 @@ - + @@ -88,9 +88,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/graph_legend.html b/html/graph_legend.html index 7042904..4150f7a 100644 --- a/html/graph_legend.html +++ b/html/graph_legend.html @@ -3,7 +3,7 @@ - + My Project: Graph Legend @@ -29,10 +29,10 @@ - + @@ -128,9 +128,7 @@ A yellow dashed arrow denotes a relation between a template instance and the tem
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/hierarchy.html b/html/hierarchy.html index c6ff059..b68e9f6 100644 --- a/html/hierarchy.html +++ b/html/hierarchy.html @@ -3,7 +3,7 @@ - + My Project: Class Hierarchy @@ -29,10 +29,10 @@ - + @@ -78,7 +78,7 @@ This inheritance list is sorted roughly, but not completely, alphabetically: Ccore::TLSServer  Ccore::UDPServerSocket  Ccore::IPAddressList - ▼CLogListener + ▼Ccoreutils::LogListener  Ccore::ConsoleServer  ▼Ccore::Object  Ccore::IPAddress @@ -89,9 +89,9 @@ This inheritance list is sorted roughly, but not completely, alphabetically: ▼Ccore::TCPSocket  Ccore::TCPServer  ▼Ccore::TCPSession - ▼Ccore::TerminalSession - Ccore::ConsoleSession - Ccore::TLSSession + Ccore::TLSSession + ▼Ccore::TerminalSession + Ccore::ConsoleSession  Ccore::Timer  ▼Ccore::UDPSocket  Ccore::UDPServerSocket @@ -102,9 +102,7 @@ This inheritance list is sorted roughly, but not completely, alphabetically:
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/index.html b/html/index.html index 6473b4e..3b71ffc 100644 --- a/html/index.html +++ b/html/index.html @@ -3,7 +3,7 @@ - + My Project: Main Page @@ -29,10 +29,10 @@ - + @@ -68,9 +68,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/inherit_graph_0.map b/html/inherit_graph_0.map index edcb801..3650bdf 100644 --- a/html/inherit_graph_0.map +++ b/html/inherit_graph_0.map @@ -1,3 +1,20 @@ - + + + + + + + + + + + + + + + + + + diff --git a/html/inherit_graph_0.md5 b/html/inherit_graph_0.md5 index d70011b..d56a1b1 100644 --- a/html/inherit_graph_0.md5 +++ b/html/inherit_graph_0.md5 @@ -1 +1 @@ -d019270962bf71fea9f33cb5799a0ff7 \ No newline at end of file +f2b3d43ad4cf00974b8ca278ded9a452 \ No newline at end of file diff --git a/html/inherit_graph_0.png b/html/inherit_graph_0.png index 8d04063..3d82137 100644 Binary files a/html/inherit_graph_0.png and b/html/inherit_graph_0.png differ diff --git a/html/inherit_graph_1.map b/html/inherit_graph_1.map index 372f02b..edcb801 100644 --- a/html/inherit_graph_1.map +++ b/html/inherit_graph_1.map @@ -1,6 +1,3 @@ - - - - + diff --git a/html/inherit_graph_1.md5 b/html/inherit_graph_1.md5 index 281e267..d70011b 100644 --- a/html/inherit_graph_1.md5 +++ b/html/inherit_graph_1.md5 @@ -1 +1 @@ -f01cc99cf9042d3e6f8a4717869b8981 \ No newline at end of file +d019270962bf71fea9f33cb5799a0ff7 \ No newline at end of file diff --git a/html/inherit_graph_1.png b/html/inherit_graph_1.png index be7e7c5..8d04063 100644 Binary files a/html/inherit_graph_1.png and b/html/inherit_graph_1.png differ diff --git a/html/inherit_graph_2.map b/html/inherit_graph_2.map index d26afca..372f02b 100644 --- a/html/inherit_graph_2.map +++ b/html/inherit_graph_2.map @@ -1,20 +1,6 @@ - - - - - - - - - - - - - - - - - - + + + + diff --git a/html/inherit_graph_2.md5 b/html/inherit_graph_2.md5 index 03380b1..281e267 100644 --- a/html/inherit_graph_2.md5 +++ b/html/inherit_graph_2.md5 @@ -1 +1 @@ -72d8da93114b1a51a17037d9b0e624ab \ No newline at end of file +f01cc99cf9042d3e6f8a4717869b8981 \ No newline at end of file diff --git a/html/inherit_graph_2.png b/html/inherit_graph_2.png index 1468f46..14eb4bb 100644 Binary files a/html/inherit_graph_2.png and b/html/inherit_graph_2.png differ diff --git a/html/inherits.html b/html/inherits.html index fc697d6..ab9ea35 100644 --- a/html/inherits.html +++ b/html/inherits.html @@ -3,7 +3,7 @@ - + My Project: Class Hierarchy @@ -29,10 +29,10 @@ - + @@ -68,21 +68,8 @@ $(function() {

Go to the textual class hierarchy

- - - - + + - @@ -117,9 +117,7 @@ $(function() {
-Generated by   -doxygen - 1.8.17 +Generated by doxygen 1.9.1
diff --git a/html/menu.js b/html/menu.js index 433c15b..2fe2214 100644 --- a/html/menu.js +++ b/html/menu.js @@ -1,25 +1,26 @@ /* - @licstart The following is the entire license notice for the - JavaScript code in this file. + @licstart The following is the entire license notice for the JavaScript code in this file. - Copyright (C) 1997-2017 by Dimitri van Heesch + The MIT License (MIT) - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. + Copyright (C) 1997-2020 by Dimitri van Heesch - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: - You should have received a copy of the GNU General Public License along - with this program; if not, write to the Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. - @licend The above is the entire license notice - for the JavaScript code in this file + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file */ function initMenu(relPath,searchEnabled,serverSide,searchPage,search) { function makeTree(data,relPath) { @@ -40,9 +41,9 @@ function initMenu(relPath,searchEnabled,serverSide,searchPage,search) { $('#main-nav').children(':first').addClass('sm sm-dox').attr('id','main-menu'); if (searchEnabled) { if (serverSide) { - $('#main-menu').append('
    • '); + $('#main-menu').append('
    • '); } else { - $('#main-menu').append('
    • '); + $('#main-menu').append('
    • '); } } $('#main-menu').smartmenus(); diff --git a/html/menudata.js b/html/menudata.js index 10d214b..0b7b348 100644 --- a/html/menudata.js +++ b/html/menudata.js @@ -1,24 +1,26 @@ /* -@licstart The following is the entire license notice for the -JavaScript code in this file. + @licstart The following is the entire license notice for the JavaScript code in this file. -Copyright (C) 1997-2019 by Dimitri van Heesch + The MIT License (MIT) -This program is free software; you can redistribute it and/or modify -it under the terms of version 2 of the GNU General Public License as published by -the Free Software Foundation + Copyright (C) 1997-2020 by Dimitri van Heesch -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: -You should have received a copy of the GNU General Public License along -with this program; if not, write to the Free Software Foundation, Inc., -51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. -@licend The above is the entire license notice -for the JavaScript code in this file + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file */ var menudata={children:[ {text:"Main Page",url:"index.html"}, diff --git a/html/search/all_0.html b/html/search/all_0.html index 26dd244..1ec5b2d 100644 --- a/html/search/all_0.html +++ b/html/search/all_0.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/all_1.html b/html/search/all_1.html index 8eb215b..9f80e90 100644 --- a/html/search/all_1.html +++ b/html/search/all_1.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/all_2.html b/html/search/all_2.html index b26d916..02cfffc 100644 --- a/html/search/all_2.html +++ b/html/search/all_2.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/all_3.html b/html/search/all_3.html index b61b96f..39767b8 100644 --- a/html/search/all_3.html +++ b/html/search/all_3.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/all_4.html b/html/search/all_4.html index 06de155..fc40463 100644 --- a/html/search/all_4.html +++ b/html/search/all_4.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/all_5.html b/html/search/all_5.html index 2544c4e..9dd9344 100644 --- a/html/search/all_5.html +++ b/html/search/all_5.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/all_6.html b/html/search/all_6.html index 43f14ea..f1e516d 100644 --- a/html/search/all_6.html +++ b/html/search/all_6.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/all_7.html b/html/search/all_7.html index af52f82..8ddbf6c 100644 --- a/html/search/all_7.html +++ b/html/search/all_7.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/all_7.js b/html/search/all_7.js index 0bb7a07..3348d4d 100644 --- a/html/search/all_7.js +++ b/html/search/all_7.js @@ -6,7 +6,7 @@ var searchData= ['ondatareceived_27',['onDataReceived',['../classcore_1_1Socket.html#ac8d6a2c54696eb6fc2024cf6bcf6b4e5',1,'core::Socket::onDataReceived()'],['../classcore_1_1TCPServer.html#a276ccbc8cb9b4380ebd78807b97f0159',1,'core::TCPServer::onDataReceived()'],['../classcore_1_1TCPSession.html#afc2d2a92bc65e1e5122a93d120253a1d',1,'core::TCPSession::onDataReceived()'],['../classcore_1_1UDPServerSocket.html#a41933ca153c854a800e3d047ab18313e',1,'core::UDPServerSocket::onDataReceived()']]], ['onlinereceived_28',['onLineReceived',['../classcore_1_1TCPSession.html#a3d9e0f14e7d24357fd1950b3f9b4eaff',1,'core::TCPSession']]], ['onregister_29',['onRegister',['../classcore_1_1Socket.html#a81e5ee3e17834166d97c6e8b7dfe0da0',1,'core::Socket::onRegister()'],['../classcore_1_1TLSSession.html#a76cec7cf4851eb27abe77a2339344c6d',1,'core::TLSSession::onRegister()']]], - ['onregistered_30',['onRegistered',['../classcore_1_1Socket.html#a23b9824653bbe4652a716acb828665b1',1,'core::Socket::onRegistered()'],['../classcore_1_1TCPSession.html#aed4ed499b978bcea57a8efefe929fc98',1,'core::TCPSession::onRegistered()'],['../classcore_1_1TLSSession.html#a8e26fdc9e8a6c573b5a504a1f1b137a9',1,'core::TLSSession::onRegistered()']]], + ['onregistered_30',['onRegistered',['../classcore_1_1Socket.html#a23b9824653bbe4652a716acb828665b1',1,'core::Socket::onRegistered()'],['../classcore_1_1TLSSession.html#a8e26fdc9e8a6c573b5a504a1f1b137a9',1,'core::TLSSession::onRegistered()'],['../classcore_1_1TCPSession.html#aed4ed499b978bcea57a8efefe929fc98',1,'core::TCPSession::onRegistered()']]], ['ontimeout_31',['onTimeout',['../classcore_1_1Timer.html#ae51704ff08d985bbc30e3ff4c9b3c6ca',1,'core::Timer']]], ['onunregistered_32',['onUnregistered',['../classcore_1_1Socket.html#ae9be59697c2b2e5efb19aaae3ba943d2',1,'core::Socket']]], ['out_33',['out',['../classcore_1_1TCPSession.html#abb302bbb3d7e7bc75490c736364f0d4d',1,'core::TCPSession']]], diff --git a/html/search/all_8.html b/html/search/all_8.html index cf2b5df..83c55ae 100644 --- a/html/search/all_8.html +++ b/html/search/all_8.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/all_9.html b/html/search/all_9.html index 690785a..1e263c1 100644 --- a/html/search/all_9.html +++ b/html/search/all_9.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/all_a.html b/html/search/all_a.html index f2f3d3a..3a6cac1 100644 --- a/html/search/all_a.html +++ b/html/search/all_a.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/all_b.html b/html/search/all_b.html index 14f3403..130deb4 100644 --- a/html/search/all_b.html +++ b/html/search/all_b.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/all_c.html b/html/search/all_c.html index da60ab8..3dd5af0 100644 --- a/html/search/all_c.html +++ b/html/search/all_c.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/all_d.html b/html/search/all_d.html index bc376fe..af7f2f0 100644 --- a/html/search/all_d.html +++ b/html/search/all_d.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/all_e.html b/html/search/all_e.html index 2e3c74d..e25df42 100644 --- a/html/search/all_e.html +++ b/html/search/all_e.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/classes_0.html b/html/search/classes_0.html index f7e4c14..af8159e 100644 --- a/html/search/classes_0.html +++ b/html/search/classes_0.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/classes_1.html b/html/search/classes_1.html index c7ff4b3..576e916 100644 --- a/html/search/classes_1.html +++ b/html/search/classes_1.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/classes_2.html b/html/search/classes_2.html index 0d1e8a0..956405e 100644 --- a/html/search/classes_2.html +++ b/html/search/classes_2.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/classes_3.html b/html/search/classes_3.html index 2102545..d33343b 100644 --- a/html/search/classes_3.html +++ b/html/search/classes_3.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/classes_4.html b/html/search/classes_4.html index 095ab59..8430b07 100644 --- a/html/search/classes_4.html +++ b/html/search/classes_4.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/classes_5.html b/html/search/classes_5.html index fc9cdc9..c2f1b76 100644 --- a/html/search/classes_5.html +++ b/html/search/classes_5.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/classes_6.html b/html/search/classes_6.html index 1ecfddd..e39847c 100644 --- a/html/search/classes_6.html +++ b/html/search/classes_6.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/close.svg b/html/search/close.svg new file mode 100644 index 0000000..a933eea --- /dev/null +++ b/html/search/close.svg @@ -0,0 +1,31 @@ + + + + + + image/svg+xml + + + + + + + + diff --git a/html/search/functions_0.html b/html/search/functions_0.html index e17c711..eb4c501 100644 --- a/html/search/functions_0.html +++ b/html/search/functions_0.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/functions_1.html b/html/search/functions_1.html index 0ddac0a..ef4088b 100644 --- a/html/search/functions_1.html +++ b/html/search/functions_1.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/functions_2.html b/html/search/functions_2.html index 2737c5a..ca5aa10 100644 --- a/html/search/functions_2.html +++ b/html/search/functions_2.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/functions_3.html b/html/search/functions_3.html index 6da86e7..d79f55b 100644 --- a/html/search/functions_3.html +++ b/html/search/functions_3.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/functions_4.html b/html/search/functions_4.html index 911304e..1657cad 100644 --- a/html/search/functions_4.html +++ b/html/search/functions_4.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/functions_5.html b/html/search/functions_5.html index 61b920d..9301d6b 100644 --- a/html/search/functions_5.html +++ b/html/search/functions_5.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/functions_5.js b/html/search/functions_5.js index 2795c62..54497f9 100644 --- a/html/search/functions_5.js +++ b/html/search/functions_5.js @@ -5,7 +5,7 @@ var searchData= ['ondatareceived_115',['onDataReceived',['../classcore_1_1Socket.html#ac8d6a2c54696eb6fc2024cf6bcf6b4e5',1,'core::Socket::onDataReceived()'],['../classcore_1_1TCPServer.html#a276ccbc8cb9b4380ebd78807b97f0159',1,'core::TCPServer::onDataReceived()'],['../classcore_1_1TCPSession.html#afc2d2a92bc65e1e5122a93d120253a1d',1,'core::TCPSession::onDataReceived()'],['../classcore_1_1UDPServerSocket.html#a41933ca153c854a800e3d047ab18313e',1,'core::UDPServerSocket::onDataReceived()']]], ['onlinereceived_116',['onLineReceived',['../classcore_1_1TCPSession.html#a3d9e0f14e7d24357fd1950b3f9b4eaff',1,'core::TCPSession']]], ['onregister_117',['onRegister',['../classcore_1_1Socket.html#a81e5ee3e17834166d97c6e8b7dfe0da0',1,'core::Socket::onRegister()'],['../classcore_1_1TLSSession.html#a76cec7cf4851eb27abe77a2339344c6d',1,'core::TLSSession::onRegister()']]], - ['onregistered_118',['onRegistered',['../classcore_1_1Socket.html#a23b9824653bbe4652a716acb828665b1',1,'core::Socket::onRegistered()'],['../classcore_1_1TCPSession.html#aed4ed499b978bcea57a8efefe929fc98',1,'core::TCPSession::onRegistered()'],['../classcore_1_1TLSSession.html#a8e26fdc9e8a6c573b5a504a1f1b137a9',1,'core::TLSSession::onRegistered()']]], + ['onregistered_118',['onRegistered',['../classcore_1_1Socket.html#a23b9824653bbe4652a716acb828665b1',1,'core::Socket::onRegistered()'],['../classcore_1_1TLSSession.html#a8e26fdc9e8a6c573b5a504a1f1b137a9',1,'core::TLSSession::onRegistered()'],['../classcore_1_1TCPSession.html#aed4ed499b978bcea57a8efefe929fc98',1,'core::TCPSession::onRegistered()']]], ['ontimeout_119',['onTimeout',['../classcore_1_1Timer.html#ae51704ff08d985bbc30e3ff4c9b3c6ca',1,'core::Timer']]], ['onunregistered_120',['onUnregistered',['../classcore_1_1Socket.html#ae9be59697c2b2e5efb19aaae3ba943d2',1,'core::Socket']]], ['output_121',['output',['../classcore_1_1Command.html#ab6352ce5650e70a5c76c3d6e4eefd292',1,'core::Command::output()'],['../classcore_1_1TCPServer.html#a49e3ead1bf4e7830685780e73c4db5db',1,'core::TCPServer::output()'],['../classcore_1_1TCPSession.html#a50037cbfc515650e04054e5481785981',1,'core::TCPSession::output()'],['../classcore_1_1TCPSocket.html#afacf7528ff3c9ac077d7b5a49e2116fd',1,'core::TCPSocket::output()'],['../classcore_1_1TLSSession.html#ae55de8a035d1ddc560cf619b2030af43',1,'core::TLSSession::output()']]] diff --git a/html/search/functions_6.html b/html/search/functions_6.html index dc70a4a..9c4f5fc 100644 --- a/html/search/functions_6.html +++ b/html/search/functions_6.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/functions_7.html b/html/search/functions_7.html index 7de3106..46b5c0f 100644 --- a/html/search/functions_7.html +++ b/html/search/functions_7.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/functions_8.html b/html/search/functions_8.html index 7422be2..31a1d95 100644 --- a/html/search/functions_8.html +++ b/html/search/functions_8.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/functions_9.html b/html/search/functions_9.html index befd4fa..9a8e429 100644 --- a/html/search/functions_9.html +++ b/html/search/functions_9.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/functions_a.html b/html/search/functions_a.html index a81e963..5ecc152 100644 --- a/html/search/functions_a.html +++ b/html/search/functions_a.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/functions_b.html b/html/search/functions_b.html index 345265d..e301fed 100644 --- a/html/search/functions_b.html +++ b/html/search/functions_b.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/functions_c.html b/html/search/functions_c.html index 858bfd6..c4f3268 100644 --- a/html/search/functions_c.html +++ b/html/search/functions_c.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/mag_sel.svg b/html/search/mag_sel.svg new file mode 100644 index 0000000..03626f6 --- /dev/null +++ b/html/search/mag_sel.svg @@ -0,0 +1,74 @@ + + + + + + + + image/svg+xml + + + + + + + + + + + diff --git a/html/search/nomatches.html b/html/search/nomatches.html index 4377320..2b9360b 100644 --- a/html/search/nomatches.html +++ b/html/search/nomatches.html @@ -1,5 +1,6 @@ - + + diff --git a/html/search/search.css b/html/search/search.css index 3cf9df9..9074198 100644 --- a/html/search/search.css +++ b/html/search/search.css @@ -1,98 +1,82 @@ /*---------------- Search Box */ -#FSearchBox { - float: left; -} - #MSearchBox { white-space : nowrap; - float: none; - margin-top: 8px; - right: 0px; - width: 170px; - height: 24px; + background: white; + border-radius: 0.65em; + box-shadow: inset 0.5px 0.5px 3px 0px #555; z-index: 102; } -#MSearchBox .left -{ - display:block; - position:absolute; - left:10px; - width:20px; - height:19px; - background:url('search_l.png') no-repeat; - background-position:right; +#MSearchBox .left { + display: inline-block; + vertical-align: middle; + height: 1.4em; } #MSearchSelect { - display:block; - position:absolute; - width:20px; - height:19px; -} - -.left #MSearchSelect { - left:4px; -} - -.right #MSearchSelect { - right:5px; + display: inline-block; + vertical-align: middle; + height: 1.4em; + padding: 0 0 0 0.3em; + margin: 0; } #MSearchField { - display:block; - position:absolute; - height:19px; - background:url('search_m.png') repeat-x; + display: inline-block; + vertical-align: middle; + width: 7.5em; + height: 1.1em; + margin: 0 0.15em; + padding: 0; + line-height: 1em; border:none; - width:115px; - margin-left:20px; - padding-left:4px; color: #909090; outline: none; - font: 9pt Arial, Verdana, sans-serif; + font-family: Arial, Verdana, sans-serif; -webkit-border-radius: 0px; + border-radius: 0px; + background: none; } -#FSearchBox #MSearchField { - margin-left:15px; -} #MSearchBox .right { - display:block; - position:absolute; - right:10px; - top:8px; - width:20px; - height:19px; - background:url('search_r.png') no-repeat; - background-position:left; + display: inline-block; + vertical-align: middle; + width: 1.4em; + height: 1.4em; } #MSearchClose { display: none; - position: absolute; - top: 4px; + font-size: inherit; background : none; border: none; - margin: 0px 4px 0px 0px; - padding: 0px 0px; + margin: 0; + padding: 0; outline: none; + } -.left #MSearchClose { - left: 6px; -} - -.right #MSearchClose { - right: 2px; +#MSearchCloseImg { + height: 1.4em; + padding: 0.3em; + margin: 0; } .MSearchBoxActive #MSearchField { color: #000000; } +#main-menu > li:last-child { + /* This
  • object is the parent of the search bar */ + display: flex; + justify-content: center; + align-items: center; + height: 36px; + margin-right: 1em; +} + /*---------------- Search filter selection */ #MSearchSelectWindow { @@ -220,19 +204,21 @@ a.SRScope:focus, a.SRScope:active { span.SRScope { padding-left: 4px; + font-family: Arial, Verdana, sans-serif; } .SRPage .SRStatus { padding: 2px 5px; font-size: 8pt; font-style: italic; + font-family: Arial, Verdana, sans-serif; } .SRResult { display: none; } -DIV.searchresults { +div.searchresults { margin-left: 10px; margin-right: 10px; } diff --git a/html/search/search.js b/html/search/search.js index a554ab9..fb226f7 100644 --- a/html/search/search.js +++ b/html/search/search.js @@ -1,25 +1,26 @@ /* - @licstart The following is the entire license notice for the - JavaScript code in this file. + @licstart The following is the entire license notice for the JavaScript code in this file. - Copyright (C) 1997-2017 by Dimitri van Heesch + The MIT License (MIT) - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. + Copyright (C) 1997-2020 by Dimitri van Heesch - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: - You should have received a copy of the GNU General Public License along - with this program; if not, write to the Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. - @licend The above is the entire license notice - for the JavaScript code in this file + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file */ function convertToId(search) { @@ -79,9 +80,10 @@ function getYPos(item) storing this instance. Is needed to be able to set timeouts. resultPath - path to use for external files */ -function SearchBox(name, resultsPath, inFrame, label) +function SearchBox(name, resultsPath, inFrame, label, extension) { if (!name || !resultsPath) { alert("Missing parameters to SearchBox."); } + if (!extension || extension == "") { extension = ".html"; } // ---------- Instance variables this.name = name; @@ -96,6 +98,7 @@ function SearchBox(name, resultsPath, inFrame, label) this.searchActive = false; this.insideFrame = inFrame; this.searchLabel = label; + this.extension = extension; // ----------- DOM Elements @@ -200,10 +203,9 @@ function SearchBox(name, resultsPath, inFrame, label) } return; } - else if (window.frames.MSearchResults.searchResults) + else { - var elem = window.frames.MSearchResults.searchResults.NavNext(0); - if (elem) elem.focus(); + window.frames.MSearchResults.postMessage("take_focus", "*"); } } else if (e.keyCode==27) // Escape out of the search field @@ -347,13 +349,13 @@ function SearchBox(name, resultsPath, inFrame, label) if (idx!=-1) { var hexCode=idx.toString(16); - resultsPage = this.resultsPath + '/' + indexSectionNames[this.searchIndex] + '_' + hexCode + '.html'; + resultsPage = this.resultsPath + '/' + indexSectionNames[this.searchIndex] + '_' + hexCode + this.extension; resultsPageWithSearch = resultsPage+'?'+escape(searchValue); hasResultsPage = true; } else // nothing available for this search term { - resultsPage = this.resultsPath + '/nomatches.html'; + resultsPage = this.resultsPath + '/nomatches' + this.extension; resultsPageWithSearch = resultsPage; hasResultsPage = false; } @@ -364,7 +366,7 @@ function SearchBox(name, resultsPath, inFrame, label) if (domPopupSearchResultsWindow.style.display!='block') { var domSearchBox = this.DOMSearchBox(); - this.DOMSearchClose().style.display = 'inline'; + this.DOMSearchClose().style.display = 'inline-block'; if (this.insideFrame) { var domPopupSearchResults = this.DOMPopupSearchResults(); @@ -439,12 +441,12 @@ function SearchResults(name) while (element && element!=parentElement) { - if (element.nodeName == 'DIV' && element.className == 'SRChildren') + if (element.nodeName.toLowerCase() == 'div' && element.className == 'SRChildren') { return element; } - if (element.nodeName == 'DIV' && element.hasChildNodes()) + if (element.nodeName.toLowerCase() == 'div' && element.hasChildNodes()) { element = element.firstChild; } diff --git a/html/search/variables_0.html b/html/search/variables_0.html index bf3eba5..1e477c0 100644 --- a/html/search/variables_0.html +++ b/html/search/variables_0.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/variables_1.html b/html/search/variables_1.html index 49fe59a..ea73d9a 100644 --- a/html/search/variables_1.html +++ b/html/search/variables_1.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/variables_2.html b/html/search/variables_2.html index 0c8a18c..0580462 100644 --- a/html/search/variables_2.html +++ b/html/search/variables_2.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/variables_3.html b/html/search/variables_3.html index 19a31fc..0d69e76 100644 --- a/html/search/variables_3.html +++ b/html/search/variables_3.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/variables_4.html b/html/search/variables_4.html index bdc37be..a4b6506 100644 --- a/html/search/variables_4.html +++ b/html/search/variables_4.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/html/search/variables_5.html b/html/search/variables_5.html index 6aa2249..7e345d1 100644 --- a/html/search/variables_5.html +++ b/html/search/variables_5.html @@ -1,7 +1,8 @@ - + + - + @@ -10,21 +11,27 @@
    Loading...
    - +
    Searching...
    No Matches
    - +
    diff --git a/latex/annotated.tex b/latex/annotated.tex index 0139fff..d02ed23 100644 --- a/latex/annotated.tex +++ b/latex/annotated.tex @@ -4,24 +4,24 @@ Here are the classes, structs, unions and interfaces with brief descriptions\+:\ \item\contentsline{section}{\mbox{\hyperlink{classcore_1_1CommandList}{core\+::\+Command\+List}} }{\pageref{classcore_1_1CommandList}}{} \item\contentsline{section}{\mbox{\hyperlink{classcore_1_1ConsoleServer}{core\+::\+Console\+Server}} }{\pageref{classcore_1_1ConsoleServer}}{} \item\contentsline{section}{\mbox{\hyperlink{classcore_1_1ConsoleSession}{core\+::\+Console\+Session}} }{\pageref{classcore_1_1ConsoleSession}}{} -\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1EPoll}{core\+::\+E\+Poll}} }{\pageref{classcore_1_1EPoll}}{} -\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1INotify}{core\+::\+I\+Notify}} }{\pageref{classcore_1_1INotify}}{} -\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1IPAddress}{core\+::\+I\+P\+Address}} }{\pageref{classcore_1_1IPAddress}}{} -\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1IPAddressList}{core\+::\+I\+P\+Address\+List}} }{\pageref{classcore_1_1IPAddressList}}{} +\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1EPoll}{core\+::\+EPoll}} }{\pageref{classcore_1_1EPoll}}{} +\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1INotify}{core\+::\+INotify}} }{\pageref{classcore_1_1INotify}}{} +\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1IPAddress}{core\+::\+IPAddress}} }{\pageref{classcore_1_1IPAddress}}{} +\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1IPAddressList}{core\+::\+IPAddress\+List}} }{\pageref{classcore_1_1IPAddressList}}{} \item\contentsline{section}{\mbox{\hyperlink{classcore_1_1Object}{core\+::\+Object}} }{\pageref{classcore_1_1Object}}{} \item\contentsline{section}{\mbox{\hyperlink{classcore_1_1SessionFilter}{core\+::\+Session\+Filter}} }{\pageref{classcore_1_1SessionFilter}}{} \item\contentsline{section}{\mbox{\hyperlink{classcore_1_1Socket}{core\+::\+Socket}} }{\pageref{classcore_1_1Socket}}{} \item\contentsline{section}{\mbox{\hyperlink{classcore_1_1Subscription}{core\+::\+Subscription}} }{\pageref{classcore_1_1Subscription}}{} \item\contentsline{section}{\mbox{\hyperlink{classcore_1_1SubscriptionManager}{core\+::\+Subscription\+Manager}} }{\pageref{classcore_1_1SubscriptionManager}}{} -\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TCPServer}{core\+::\+T\+C\+P\+Server}} }{\pageref{classcore_1_1TCPServer}}{} -\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TCPSession}{core\+::\+T\+C\+P\+Session}} }{\pageref{classcore_1_1TCPSession}}{} -\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TCPSocket}{core\+::\+T\+C\+P\+Socket}} }{\pageref{classcore_1_1TCPSocket}}{} +\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TCPServer}{core\+::\+TCPServer}} }{\pageref{classcore_1_1TCPServer}}{} +\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TCPSession}{core\+::\+TCPSession}} }{\pageref{classcore_1_1TCPSession}}{} +\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TCPSocket}{core\+::\+TCPSocket}} }{\pageref{classcore_1_1TCPSocket}}{} \item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TerminalSession}{core\+::\+Terminal\+Session}} }{\pageref{classcore_1_1TerminalSession}}{} \item\contentsline{section}{\mbox{\hyperlink{classcore_1_1Thread}{core\+::\+Thread}} }{\pageref{classcore_1_1Thread}}{} \item\contentsline{section}{\mbox{\hyperlink{classcore_1_1ThreadScope}{core\+::\+Thread\+Scope}} }{\pageref{classcore_1_1ThreadScope}}{} \item\contentsline{section}{\mbox{\hyperlink{classcore_1_1Timer}{core\+::\+Timer}} }{\pageref{classcore_1_1Timer}}{} -\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TLSServer}{core\+::\+T\+L\+S\+Server}} }{\pageref{classcore_1_1TLSServer}}{} -\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TLSSession}{core\+::\+T\+L\+S\+Session}} }{\pageref{classcore_1_1TLSSession}}{} -\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1UDPServerSocket}{core\+::\+U\+D\+P\+Server\+Socket}} }{\pageref{classcore_1_1UDPServerSocket}}{} -\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1UDPSocket}{core\+::\+U\+D\+P\+Socket}} }{\pageref{classcore_1_1UDPSocket}}{} +\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TLSServer}{core\+::\+TLSServer}} }{\pageref{classcore_1_1TLSServer}}{} +\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TLSSession}{core\+::\+TLSSession}} }{\pageref{classcore_1_1TLSSession}}{} +\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1UDPServerSocket}{core\+::\+UDPServer\+Socket}} }{\pageref{classcore_1_1UDPServerSocket}}{} +\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1UDPSocket}{core\+::\+UDPSocket}} }{\pageref{classcore_1_1UDPSocket}}{} \end{DoxyCompactList} diff --git a/latex/classcore_1_1Command.tex b/latex/classcore_1_1Command.tex index 097e319..13d8555 100644 --- a/latex/classcore_1_1Command.tex +++ b/latex/classcore_1_1Command.tex @@ -16,7 +16,7 @@ Inheritance diagram for core\+::Command\+:\nopagebreak \doxysubsection*{Public Member Functions} \begin{DoxyCompactItemize} \item -virtual int \mbox{\hyperlink{classcore_1_1Command_a95176f2532c38ee14e3fee40ee28b1bd}{process\+Command}} (coreutils\+::\+Z\+String \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session) +virtual int \mbox{\hyperlink{classcore_1_1Command_a95176f2532c38ee14e3fee40ee28b1bd}{process\+Command}} (coreutils\+::\+ZString \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session) \item virtual void \mbox{\hyperlink{classcore_1_1Command_ab6352ce5650e70a5c76c3d6e4eefd292}{output}} (std\+::stringstream \&out) \end{DoxyCompactItemize} @@ -43,13 +43,13 @@ Specify the output that will occur to the specified session. \end{DoxyParams} -Reimplemented in \mbox{\hyperlink{classcore_1_1TCPServer_a49e3ead1bf4e7830685780e73c4db5db}{core\+::\+T\+C\+P\+Server}}. +Reimplemented in \mbox{\hyperlink{classcore_1_1TCPServer_a49e3ead1bf4e7830685780e73c4db5db}{core\+::\+TCPServer}}. \mbox{\Hypertarget{classcore_1_1Command_a95176f2532c38ee14e3fee40ee28b1bd}\label{classcore_1_1Command_a95176f2532c38ee14e3fee40ee28b1bd}} \index{core::Command@{core::Command}!processCommand@{processCommand}} \index{processCommand@{processCommand}!core::Command@{core::Command}} \doxysubsubsection{\texorpdfstring{processCommand()}{processCommand()}} -{\footnotesize\ttfamily int core\+::\+Command\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&}]{session }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} +{\footnotesize\ttfamily int core\+::\+Command\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&}]{session }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} This method is used to implement the functionality of the requested command. This pure virtual function must be implemented in your inheriting object. @@ -65,7 +65,7 @@ Returns 0 if execution of the command was successful. Otherwise returns a non-\/ \end{DoxyReturn} -Reimplemented in \mbox{\hyperlink{classcore_1_1TCPServer_a6b7a7e1ac4132942fcaf418ed41c1437}{core\+::\+T\+C\+P\+Server}}, \mbox{\hyperlink{classcore_1_1EPoll_a22b5f1545aff3162040844be043abcce}{core\+::\+E\+Poll}}, \mbox{\hyperlink{classcore_1_1SubscriptionManager_aaa30bf772ad72b3f319a790662e4f8ae}{core\+::\+Subscription\+Manager}}, and \mbox{\hyperlink{classcore_1_1CommandList_a1819e1cb377b5d8e5e00b4777e2b4aba}{core\+::\+Command\+List}}. +Reimplemented in \mbox{\hyperlink{classcore_1_1TCPServer_a6b7a7e1ac4132942fcaf418ed41c1437}{core\+::\+TCPServer}}, \mbox{\hyperlink{classcore_1_1SubscriptionManager_aaa30bf772ad72b3f319a790662e4f8ae}{core\+::\+Subscription\+Manager}}, \mbox{\hyperlink{classcore_1_1EPoll_a22b5f1545aff3162040844be043abcce}{core\+::\+EPoll}}, and \mbox{\hyperlink{classcore_1_1CommandList_a1819e1cb377b5d8e5e00b4777e2b4aba}{core\+::\+Command\+List}}. diff --git a/latex/classcore_1_1CommandList.tex b/latex/classcore_1_1CommandList.tex index c08ee83..02aeab7 100644 --- a/latex/classcore_1_1CommandList.tex +++ b/latex/classcore_1_1CommandList.tex @@ -32,14 +32,14 @@ void \mbox{\hyperlink{classcore_1_1CommandList_a7a45e75e3d21a25fd3f7e887acf395e9 \item void \mbox{\hyperlink{classcore_1_1CommandList_aaac684effb9ecf5238d23ca60d3fffaa}{remove}} (\mbox{\hyperlink{classcore_1_1Command}{Command}} \&command) \item -bool \mbox{\hyperlink{classcore_1_1CommandList_aa9b789df8eed15dc037bd98d596fe6e0}{process\+Request}} (coreutils\+::\+Z\+String \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session) +bool \mbox{\hyperlink{classcore_1_1CommandList_aa9b789df8eed15dc037bd98d596fe6e0}{process\+Request}} (coreutils\+::\+ZString \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session) \item -bool \mbox{\hyperlink{classcore_1_1CommandList_a72aea93a650f148c639ba25a724da243}{grab\+Input}} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session, \mbox{\hyperlink{classcore_1_1Command}{Command}} \&command) +bool \mbox{\hyperlink{classcore_1_1CommandList_a72aea93a650f148c639ba25a724da243}{grab\+Input}} (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session, \mbox{\hyperlink{classcore_1_1Command}{Command}} \&command) \item \mbox{\Hypertarget{classcore_1_1CommandList_a9214dc76dbcde1520277d044c00cc1fc}\label{classcore_1_1CommandList_a9214dc76dbcde1520277d044c00cc1fc}} -void {\bfseries clear\+Grab} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session) +void {\bfseries clear\+Grab} (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session) \item -int \mbox{\hyperlink{classcore_1_1CommandList_a1819e1cb377b5d8e5e00b4777e2b4aba}{process\+Command}} (coreutils\+::\+Z\+String \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session) +int \mbox{\hyperlink{classcore_1_1CommandList_a1819e1cb377b5d8e5e00b4777e2b4aba}{process\+Command}} (coreutils\+::\+ZString \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session) \end{DoxyCompactItemize} \doxysubsection*{Protected Attributes} \begin{DoxyCompactItemize} @@ -70,13 +70,13 @@ Add a new command to the command list and assign a default search value. \mbox{\ \index{core::CommandList@{core::CommandList}!grabInput@{grabInput}} \index{grabInput@{grabInput}!core::CommandList@{core::CommandList}} \doxysubsubsection{\texorpdfstring{grabInput()}{grabInput()}} -{\footnotesize\ttfamily bool core\+::\+Command\+List\+::grab\+Input (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&}]{session, }\item[{\mbox{\hyperlink{classcore_1_1Command}{Command}} \&}]{command }\end{DoxyParamCaption})} +{\footnotesize\ttfamily bool core\+::\+Command\+List\+::grab\+Input (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&}]{session, }\item[{\mbox{\hyperlink{classcore_1_1Command}{Command}} \&}]{command }\end{DoxyParamCaption})} Use \mbox{\hyperlink{classcore_1_1CommandList_a72aea93a650f148c639ba25a724da243}{grab\+Input()}} within a \mbox{\hyperlink{classcore_1_1Command}{Command}} object to force the requesting handler to receive all further input from the socket. Use release\+Grab() method to release the session back to normal command processing. \mbox{\Hypertarget{classcore_1_1CommandList_a1819e1cb377b5d8e5e00b4777e2b4aba}\label{classcore_1_1CommandList_a1819e1cb377b5d8e5e00b4777e2b4aba}} \index{core::CommandList@{core::CommandList}!processCommand@{processCommand}} \index{processCommand@{processCommand}!core::CommandList@{core::CommandList}} \doxysubsubsection{\texorpdfstring{processCommand()}{processCommand()}} -{\footnotesize\ttfamily int core\+::\+Command\+List\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&}]{session }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} +{\footnotesize\ttfamily int core\+::\+Command\+List\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&}]{session }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} This method is used to implement the functionality of the requested command. This pure virtual function must be implemented in your inheriting object. @@ -98,9 +98,9 @@ Reimplemented from \mbox{\hyperlink{classcore_1_1Command_a95176f2532c38ee14e3fee \index{core::CommandList@{core::CommandList}!processRequest@{processRequest}} \index{processRequest@{processRequest}!core::CommandList@{core::CommandList}} \doxysubsubsection{\texorpdfstring{processRequest()}{processRequest()}} -{\footnotesize\ttfamily bool core\+::\+Command\+List\+::process\+Request (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&}]{session }\end{DoxyParamCaption})} +{\footnotesize\ttfamily bool core\+::\+Command\+List\+::process\+Request (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&}]{session }\end{DoxyParamCaption})} -Use this method to apply a parsed Z\+String to the command set and execute the matching parameter. The selected command will return a true on a call to check(). If there is a handler that has a grab on the process handler then control is given to the process handler holding the grab on the input. \mbox{\Hypertarget{classcore_1_1CommandList_aaac684effb9ecf5238d23ca60d3fffaa}\label{classcore_1_1CommandList_aaac684effb9ecf5238d23ca60d3fffaa}} +Use this method to apply a parsed ZString to the command set and execute the matching parameter. The selected command will return a true on a call to check(). If there is a handler that has a grab on the process handler then control is given to the process handler holding the grab on the input. \mbox{\Hypertarget{classcore_1_1CommandList_aaac684effb9ecf5238d23ca60d3fffaa}\label{classcore_1_1CommandList_aaac684effb9ecf5238d23ca60d3fffaa}} \index{core::CommandList@{core::CommandList}!remove@{remove}} \index{remove@{remove}!core::CommandList@{core::CommandList}} \doxysubsubsection{\texorpdfstring{remove()}{remove()}} diff --git a/latex/classcore_1_1ConsoleServer.tex b/latex/classcore_1_1ConsoleServer.tex index 11f99d6..fc93b2c 100644 --- a/latex/classcore_1_1ConsoleServer.tex +++ b/latex/classcore_1_1ConsoleServer.tex @@ -11,7 +11,8 @@ Inheritance diagram for core\+::Console\+Server\+:\nopagebreak \end{figure} -Collaboration diagram for core\+::Console\+Server\+:\nopagebreak +Collaboration diagram for core\+::Console\+Server\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -22,12 +23,12 @@ Collaboration diagram for core\+::Console\+Server\+:\nopagebreak \begin{DoxyCompactItemize} \item \mbox{\Hypertarget{classcore_1_1ConsoleServer_a938c93207ced5bfa3e15e9f4a1cbf3f0}\label{classcore_1_1ConsoleServer_a938c93207ced5bfa3e15e9f4a1cbf3f0}} -{\bfseries Console\+Server} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}} address) +{\bfseries Console\+Server} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}} address) \item \mbox{\Hypertarget{classcore_1_1ConsoleServer_ace482706881fd6cbec4e01534c091391}\label{classcore_1_1ConsoleServer_ace482706881fd6cbec4e01534c091391}} void {\bfseries log\+Send} (std\+::string out) override \item -\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$ \mbox{\hyperlink{classcore_1_1ConsoleServer_a80d9ea7f3fc5e07c50d5b9e0d4943ca8}{get\+Socket\+Accept}} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll) override +\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$ \mbox{\hyperlink{classcore_1_1ConsoleServer_a80d9ea7f3fc5e07c50d5b9e0d4943ca8}{get\+Socket\+Accept}} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll) override \end{DoxyCompactItemize} \doxysubsection*{Additional Inherited Members} @@ -37,11 +38,11 @@ void {\bfseries log\+Send} (std\+::string out) override \index{core::ConsoleServer@{core::ConsoleServer}!getSocketAccept@{getSocketAccept}} \index{getSocketAccept@{getSocketAccept}!core::ConsoleServer@{core::ConsoleServer}} \doxysubsubsection{\texorpdfstring{getSocketAccept()}{getSocketAccept()}} -{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$ core\+::\+Console\+Server\+::get\+Socket\+Accept (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&}]{epoll }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}} +{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$ core\+::\+Console\+Server\+::get\+Socket\+Accept (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&}]{epoll }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}} get\+Socket\+Accept is designed to allow a polymorphic extension of this object to return a type of object that extends the definition of the server socket. Returning the appropriate session object that extends from Session provides the mechanism where the server can select the protocol dialog for the desired service. -Reimplemented from \mbox{\hyperlink{classcore_1_1TCPServer_a841f02799ad8529aad7cea132f4de8a9}{core\+::\+T\+C\+P\+Server}}. +Reimplemented from \mbox{\hyperlink{classcore_1_1TCPServer_a841f02799ad8529aad7cea132f4de8a9}{core\+::\+TCPServer}}. diff --git a/latex/classcore_1_1ConsoleServer__coll__graph.md5 b/latex/classcore_1_1ConsoleServer__coll__graph.md5 index 7638d40..e9e1edc 100644 --- a/latex/classcore_1_1ConsoleServer__coll__graph.md5 +++ b/latex/classcore_1_1ConsoleServer__coll__graph.md5 @@ -1 +1 @@ -71124607dbe320f41db9015995c9dd1e \ No newline at end of file +a4ebc47440f704b1f6db6bf83abbc128 \ No newline at end of file diff --git a/latex/classcore_1_1ConsoleServer__coll__graph.pdf b/latex/classcore_1_1ConsoleServer__coll__graph.pdf index 49d8a34..f04265a 100644 Binary files a/latex/classcore_1_1ConsoleServer__coll__graph.pdf and b/latex/classcore_1_1ConsoleServer__coll__graph.pdf differ diff --git a/latex/classcore_1_1ConsoleSession.tex b/latex/classcore_1_1ConsoleSession.tex index 4e7f904..600db3e 100644 --- a/latex/classcore_1_1ConsoleSession.tex +++ b/latex/classcore_1_1ConsoleSession.tex @@ -15,7 +15,8 @@ Inheritance diagram for core\+::Console\+Session\+:\nopagebreak \end{figure} -Collaboration diagram for core\+::Console\+Session\+:\nopagebreak +Collaboration diagram for core\+::Console\+Session\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -26,7 +27,7 @@ Collaboration diagram for core\+::Console\+Session\+:\nopagebreak \begin{DoxyCompactItemize} \item \mbox{\Hypertarget{classcore_1_1ConsoleSession_ae735e9739fb4cfd2ef983cc56f9982c7}\label{classcore_1_1ConsoleSession_ae735e9739fb4cfd2ef983cc56f9982c7}} -{\bfseries Console\+Session} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1TCPServer}{T\+C\+P\+Server}} \&server) +{\bfseries Console\+Session} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1TCPServer}{TCPServer}} \&server) \item \mbox{\Hypertarget{classcore_1_1ConsoleSession_a6e6b56503966f1cae5bdff8b3814e2b9}\label{classcore_1_1ConsoleSession_a6e6b56503966f1cae5bdff8b3814e2b9}} void {\bfseries write\+Log} (std\+::string data) @@ -34,7 +35,7 @@ void {\bfseries write\+Log} (std\+::string data) \doxysubsection*{Protected Member Functions} \begin{DoxyCompactItemize} \item -void \mbox{\hyperlink{classcore_1_1ConsoleSession_aa1818efcd33a4152d2089aa545f08833}{protocol}} (coreutils\+::\+Z\+String \&data) override +void \mbox{\hyperlink{classcore_1_1ConsoleSession_aa1818efcd33a4152d2089aa545f08833}{protocol}} (coreutils\+::\+ZString \&data) override \end{DoxyCompactItemize} \doxysubsection*{Additional Inherited Members} @@ -42,20 +43,20 @@ void \mbox{\hyperlink{classcore_1_1ConsoleSession_aa1818efcd33a4152d2089aa545f08 \doxysubsection{Detailed Description} \mbox{\hyperlink{classcore_1_1ConsoleSession}{Console\+Session}} -Extends the session parameters for this \mbox{\hyperlink{classcore_1_1TCPSocket}{T\+C\+P\+Socket}} derived object. Extend the \mbox{\hyperlink{classcore_1_1ConsoleSession_aa1818efcd33a4152d2089aa545f08833}{protocol()}} method in order to define the behavior and protocol interaction for this socket which is a console session. +Extends the session parameters for this \mbox{\hyperlink{classcore_1_1TCPSocket}{TCPSocket}} derived object. Extend the \mbox{\hyperlink{classcore_1_1ConsoleSession_aa1818efcd33a4152d2089aa545f08833}{protocol()}} method in order to define the behavior and protocol interaction for this socket which is a console session. \doxysubsection{Member Function Documentation} \mbox{\Hypertarget{classcore_1_1ConsoleSession_aa1818efcd33a4152d2089aa545f08833}\label{classcore_1_1ConsoleSession_aa1818efcd33a4152d2089aa545f08833}} \index{core::ConsoleSession@{core::ConsoleSession}!protocol@{protocol}} \index{protocol@{protocol}!core::ConsoleSession@{core::ConsoleSession}} \doxysubsubsection{\texorpdfstring{protocol()}{protocol()}} -{\footnotesize\ttfamily void core\+::\+Console\+Session\+::protocol (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}} +{\footnotesize\ttfamily void core\+::\+Console\+Session\+::protocol (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}} Override the protocol method to manage and control the session communications in your inherited session. If you do not override this method then the Session default will process the \textquotesingle{}commands\textquotesingle{} added to the server object using the process\+Request method on the session input. -When data is received within the session two modes are available to pass the data through the protocol method\+: L\+I\+NE or B\+L\+O\+CK. +When data is received within the session two modes are available to pass the data through the protocol method\+: LINE or BLOCK. -Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_a98a65da2346b79bee659fca6902e94c7}{core\+::\+T\+C\+P\+Session}}. +Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_a98a65da2346b79bee659fca6902e94c7}{core\+::\+TCPSession}}. diff --git a/latex/classcore_1_1ConsoleSession__coll__graph.md5 b/latex/classcore_1_1ConsoleSession__coll__graph.md5 index 320b452..1c6e4cb 100644 --- a/latex/classcore_1_1ConsoleSession__coll__graph.md5 +++ b/latex/classcore_1_1ConsoleSession__coll__graph.md5 @@ -1 +1 @@ -095ce2fe54c4cbec491c802d229e681e \ No newline at end of file +cc5d4fa0c42ae34b1169b000474a8246 \ No newline at end of file diff --git a/latex/classcore_1_1ConsoleSession__coll__graph.pdf b/latex/classcore_1_1ConsoleSession__coll__graph.pdf index 3fff3a3..47cadc6 100644 Binary files a/latex/classcore_1_1ConsoleSession__coll__graph.pdf and b/latex/classcore_1_1ConsoleSession__coll__graph.pdf differ diff --git a/latex/classcore_1_1EPoll.tex b/latex/classcore_1_1EPoll.tex index 6456ef5..a3da268 100644 --- a/latex/classcore_1_1EPoll.tex +++ b/latex/classcore_1_1EPoll.tex @@ -1,12 +1,12 @@ -\hypertarget{classcore_1_1EPoll}{}\doxysection{core\+::E\+Poll Class Reference} +\hypertarget{classcore_1_1EPoll}{}\doxysection{core\+::EPoll Class Reference} \label{classcore_1_1EPoll}\index{core::EPoll@{core::EPoll}} -{\ttfamily \#include $<$E\+Poll.\+h$>$} +{\ttfamily \#include $<$EPoll.\+h$>$} -Inheritance diagram for core\+::E\+Poll\+:\nopagebreak +Inheritance diagram for core\+::EPoll\+:\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -15,7 +15,7 @@ Inheritance diagram for core\+::E\+Poll\+:\nopagebreak \end{figure} -Collaboration diagram for core\+::E\+Poll\+:\nopagebreak +Collaboration diagram for core\+::EPoll\+:\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -25,25 +25,25 @@ Collaboration diagram for core\+::E\+Poll\+:\nopagebreak \doxysubsection*{Public Member Functions} \begin{DoxyCompactItemize} \item -\mbox{\hyperlink{classcore_1_1EPoll_a2fd5cc4336b5f72990ecc0e7ea3d7641}{E\+Poll}} () +\mbox{\hyperlink{classcore_1_1EPoll_a2fd5cc4336b5f72990ecc0e7ea3d7641}{EPoll}} () \item -\mbox{\hyperlink{classcore_1_1EPoll_a8e7a2496d684b745a6410f9bd3e88534}{$\sim$\+E\+Poll}} () +\mbox{\hyperlink{classcore_1_1EPoll_a8e7a2496d684b745a6410f9bd3e88534}{$\sim$\+EPoll}} () \item bool \mbox{\hyperlink{classcore_1_1EPoll_aaefe2caef75eb538af90cb34682d277b}{start}} (int number\+Of\+Threads, int \mbox{\hyperlink{classcore_1_1EPoll_acfcef2513d94f7b9a191fed3dc744d90}{max\+Sockets}}) -\begin{DoxyCompactList}\small\item\em Start the B\+M\+A\+E\+Poll processing. \end{DoxyCompactList}\item +\begin{DoxyCompactList}\small\item\em Start the BMAEPoll processing. \end{DoxyCompactList}\item bool \mbox{\hyperlink{classcore_1_1EPoll_a0c2865acd31d14fbf19dbc42cc084ddc}{stop}} () -\begin{DoxyCompactList}\small\item\em Stop and shut down the B\+M\+A\+E\+Poll processing. \end{DoxyCompactList}\item +\begin{DoxyCompactList}\small\item\em Stop and shut down the BMAEPoll processing. \end{DoxyCompactList}\item bool \mbox{\hyperlink{classcore_1_1EPoll_a301b46b71ac7ac61a687ff723fe269b3}{is\+Stopping}} () \begin{DoxyCompactList}\small\item\em Returns a true if the stop command has been requested. \end{DoxyCompactList}\item bool \mbox{\hyperlink{classcore_1_1EPoll_a3d813c7bbf0da70ebc8e3cb6aeeacfb4}{register\+Socket}} (\mbox{\hyperlink{classcore_1_1Socket}{Socket}} $\ast$socket) -\begin{DoxyCompactList}\small\item\em Register a B\+M\+A\+Socket for monitoring by B\+M\+A\+E\+Poll. \end{DoxyCompactList}\item +\begin{DoxyCompactList}\small\item\em Register a BMASocket for monitoring by BMAEPoll. \end{DoxyCompactList}\item bool \mbox{\hyperlink{classcore_1_1EPoll_a5ab5e82ab51e0952fc8fbcc128f52900}{unregister\+Socket}} (\mbox{\hyperlink{classcore_1_1Socket}{Socket}} $\ast$socket) -\begin{DoxyCompactList}\small\item\em Unregister a B\+M\+A\+Socket from monitoring by B\+M\+A\+E\+Poll. \end{DoxyCompactList}\item +\begin{DoxyCompactList}\small\item\em Unregister a BMASocket from monitoring by BMAEPoll. \end{DoxyCompactList}\item int \mbox{\hyperlink{classcore_1_1EPoll_a1e52017e1deae15c1c87c6b6a099e1ed}{get\+Descriptor}} () \begin{DoxyCompactList}\small\item\em Return the descriptor for the e\+Poll socket. \end{DoxyCompactList}\item void \mbox{\hyperlink{classcore_1_1EPoll_a3238b150b5d0a57eb2e1b17daa236d3b}{event\+Received}} (struct epoll\+\_\+event event) \begin{DoxyCompactList}\small\item\em Dispatch event to appropriate socket. \end{DoxyCompactList}\item -int \mbox{\hyperlink{classcore_1_1EPoll_a22b5f1545aff3162040844be043abcce}{process\+Command}} (coreutils\+::\+Z\+String \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session) override +int \mbox{\hyperlink{classcore_1_1EPoll_a22b5f1545aff3162040844be043abcce}{process\+Command}} (coreutils\+::\+ZString \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session) override \begin{DoxyCompactList}\small\item\em Output the threads array to the console. \end{DoxyCompactList}\item \mbox{\Hypertarget{classcore_1_1EPoll_a033633714311f3edc4127ddd1c37f299}\label{classcore_1_1EPoll_a033633714311f3edc4127ddd1c37f299}} void {\bfseries reset\+Socket} (\mbox{\hyperlink{classcore_1_1Socket}{Socket}} $\ast$socket) @@ -56,13 +56,13 @@ int \mbox{\hyperlink{classcore_1_1EPoll_acfcef2513d94f7b9a191fed3dc744d90}{max\+ \doxysubsection{Detailed Description} -\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} +\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} Manage socket events from the epoll system call. Use this object to establish a socket server using the epoll network structure of Linux. -Use this object to establish the basis of working with multiple sockets of all sorts using the epoll capabilities of the Linux platform. \mbox{\hyperlink{classcore_1_1Socket}{Socket}} objects can register with \mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} which will establish a communication mechanism with that socket. +Use this object to establish the basis of working with multiple sockets of all sorts using the epoll capabilities of the Linux platform. \mbox{\hyperlink{classcore_1_1Socket}{Socket}} objects can register with \mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} which will establish a communication mechanism with that socket. The maximum number of sockets to communicate with is specified on the start method. @@ -73,22 +73,22 @@ Threads are used to establish a read queue for epoll. The desired number of thre \index{core::EPoll@{core::EPoll}!EPoll@{EPoll}} \index{EPoll@{EPoll}!core::EPoll@{core::EPoll}} \doxysubsubsection{\texorpdfstring{EPoll()}{EPoll()}} -{\footnotesize\ttfamily core\+::\+E\+Poll\+::\+E\+Poll (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} +{\footnotesize\ttfamily core\+::\+EPoll\+::\+EPoll (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} -The constructor for the B\+M\+A\+E\+Poll object. \mbox{\Hypertarget{classcore_1_1EPoll_a8e7a2496d684b745a6410f9bd3e88534}\label{classcore_1_1EPoll_a8e7a2496d684b745a6410f9bd3e88534}} +The constructor for the BMAEPoll object. \mbox{\Hypertarget{classcore_1_1EPoll_a8e7a2496d684b745a6410f9bd3e88534}\label{classcore_1_1EPoll_a8e7a2496d684b745a6410f9bd3e88534}} \index{core::EPoll@{core::EPoll}!````~EPoll@{$\sim$EPoll}} \index{````~EPoll@{$\sim$EPoll}!core::EPoll@{core::EPoll}} \doxysubsubsection{\texorpdfstring{$\sim$EPoll()}{~EPoll()}} -{\footnotesize\ttfamily core\+::\+E\+Poll\+::$\sim$\+E\+Poll (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} +{\footnotesize\ttfamily core\+::\+EPoll\+::$\sim$\+EPoll (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} -The destructor for the B\+M\+A\+E\+Poll object. +The destructor for the BMAEPoll object. \doxysubsection{Member Function Documentation} \mbox{\Hypertarget{classcore_1_1EPoll_a3238b150b5d0a57eb2e1b17daa236d3b}\label{classcore_1_1EPoll_a3238b150b5d0a57eb2e1b17daa236d3b}} \index{core::EPoll@{core::EPoll}!eventReceived@{eventReceived}} \index{eventReceived@{eventReceived}!core::EPoll@{core::EPoll}} \doxysubsubsection{\texorpdfstring{eventReceived()}{eventReceived()}} -{\footnotesize\ttfamily void core\+::\+E\+Poll\+::event\+Received (\begin{DoxyParamCaption}\item[{struct epoll\+\_\+event}]{event }\end{DoxyParamCaption})} +{\footnotesize\ttfamily void core\+::\+EPoll\+::event\+Received (\begin{DoxyParamCaption}\item[{struct epoll\+\_\+event}]{event }\end{DoxyParamCaption})} @@ -98,7 +98,7 @@ Receive the epoll events and dispatch the event to the socket making the request \index{core::EPoll@{core::EPoll}!getDescriptor@{getDescriptor}} \index{getDescriptor@{getDescriptor}!core::EPoll@{core::EPoll}} \doxysubsubsection{\texorpdfstring{getDescriptor()}{getDescriptor()}} -{\footnotesize\ttfamily int core\+::\+E\+Poll\+::get\+Descriptor (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} +{\footnotesize\ttfamily int core\+::\+EPoll\+::get\+Descriptor (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} @@ -108,7 +108,7 @@ Use this method to obtain the current descriptor socket number for the epoll fun \index{core::EPoll@{core::EPoll}!isStopping@{isStopping}} \index{isStopping@{isStopping}!core::EPoll@{core::EPoll}} \doxysubsubsection{\texorpdfstring{isStopping()}{isStopping()}} -{\footnotesize\ttfamily bool core\+::\+E\+Poll\+::is\+Stopping (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} +{\footnotesize\ttfamily bool core\+::\+EPoll\+::is\+Stopping (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} @@ -118,7 +118,7 @@ This method returns a true if the \mbox{\hyperlink{classcore_1_1EPoll_a0c2865acd \index{core::EPoll@{core::EPoll}!processCommand@{processCommand}} \index{processCommand@{processCommand}!core::EPoll@{core::EPoll}} \doxysubsubsection{\texorpdfstring{processCommand()}{processCommand()}} -{\footnotesize\ttfamily int core\+::\+E\+Poll\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&}]{session }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}} +{\footnotesize\ttfamily int core\+::\+EPoll\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&}]{session }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}} @@ -139,17 +139,17 @@ Reimplemented from \mbox{\hyperlink{classcore_1_1Command_a95176f2532c38ee14e3fee \index{core::EPoll@{core::EPoll}!registerSocket@{registerSocket}} \index{registerSocket@{registerSocket}!core::EPoll@{core::EPoll}} \doxysubsubsection{\texorpdfstring{registerSocket()}{registerSocket()}} -{\footnotesize\ttfamily bool core\+::\+E\+Poll\+::register\+Socket (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1Socket}{Socket}} $\ast$}]{socket }\end{DoxyParamCaption})} +{\footnotesize\ttfamily bool core\+::\+EPoll\+::register\+Socket (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1Socket}{Socket}} $\ast$}]{socket }\end{DoxyParamCaption})} -Register a B\+M\+A\+Socket for monitoring by B\+M\+A\+E\+Poll. +Register a BMASocket for monitoring by BMAEPoll. -Use register\+Socket to add a new socket to the e\+Poll event watch list. This enables a new B\+M\+A\+Socket object to receive events when data is received as well as to write data output to the socket. +Use register\+Socket to add a new socket to the e\+Poll event watch list. This enables a new BMASocket object to receive events when data is received as well as to write data output to the socket. \begin{DoxyParams}{Parameters} -{\em socket} & a pointer to a B\+M\+A\+Socket object. \\ +{\em socket} & a pointer to a BMASocket object. \\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} @@ -159,11 +159,11 @@ a booelean that indicates the socket was registered or not. \index{core::EPoll@{core::EPoll}!start@{start}} \index{start@{start}!core::EPoll@{core::EPoll}} \doxysubsubsection{\texorpdfstring{start()}{start()}} -{\footnotesize\ttfamily bool core\+::\+E\+Poll\+::start (\begin{DoxyParamCaption}\item[{int}]{number\+Of\+Threads, }\item[{int}]{max\+Sockets }\end{DoxyParamCaption})} +{\footnotesize\ttfamily bool core\+::\+EPoll\+::start (\begin{DoxyParamCaption}\item[{int}]{number\+Of\+Threads, }\item[{int}]{max\+Sockets }\end{DoxyParamCaption})} -Start the B\+M\+A\+E\+Poll processing. +Start the BMAEPoll processing. Use the \mbox{\hyperlink{classcore_1_1EPoll_aaefe2caef75eb538af90cb34682d277b}{start()}} method to initiate the threads and begin epoll queue processing. @@ -178,11 +178,11 @@ Use the \mbox{\hyperlink{classcore_1_1EPoll_aaefe2caef75eb538af90cb34682d277b}{s \index{core::EPoll@{core::EPoll}!stop@{stop}} \index{stop@{stop}!core::EPoll@{core::EPoll}} \doxysubsubsection{\texorpdfstring{stop()}{stop()}} -{\footnotesize\ttfamily bool core\+::\+E\+Poll\+::stop (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} +{\footnotesize\ttfamily bool core\+::\+EPoll\+::stop (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} -Stop and shut down the B\+M\+A\+E\+Poll processing. +Stop and shut down the BMAEPoll processing. Use the \mbox{\hyperlink{classcore_1_1EPoll_a0c2865acd31d14fbf19dbc42cc084ddc}{stop()}} method to initiate the shutdown process for the epoll socket management. @@ -190,11 +190,11 @@ A complete shutdown of all managed sockets will be initiated by this method call \index{core::EPoll@{core::EPoll}!unregisterSocket@{unregisterSocket}} \index{unregisterSocket@{unregisterSocket}!core::EPoll@{core::EPoll}} \doxysubsubsection{\texorpdfstring{unregisterSocket()}{unregisterSocket()}} -{\footnotesize\ttfamily bool core\+::\+E\+Poll\+::unregister\+Socket (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1Socket}{Socket}} $\ast$}]{socket }\end{DoxyParamCaption})} +{\footnotesize\ttfamily bool core\+::\+EPoll\+::unregister\+Socket (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1Socket}{Socket}} $\ast$}]{socket }\end{DoxyParamCaption})} -Unregister a B\+M\+A\+Socket from monitoring by B\+M\+A\+E\+Poll. +Unregister a BMASocket from monitoring by BMAEPoll. Use this method to remove a socket from receiving events from the epoll system. @@ -203,7 +203,7 @@ Use this method to remove a socket from receiving events from the epoll system. \index{core::EPoll@{core::EPoll}!maxSockets@{maxSockets}} \index{maxSockets@{maxSockets}!core::EPoll@{core::EPoll}} \doxysubsubsection{\texorpdfstring{maxSockets}{maxSockets}} -{\footnotesize\ttfamily int core\+::\+E\+Poll\+::max\+Sockets} +{\footnotesize\ttfamily int core\+::\+EPoll\+::max\+Sockets} @@ -213,5 +213,5 @@ The maximum number of sockets that can be managed by the epoll system. The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} \item -E\+Poll.\+h\item -E\+Poll.\+cpp\end{DoxyCompactItemize} +EPoll.\+h\item +EPoll.\+cpp\end{DoxyCompactItemize} diff --git a/latex/classcore_1_1INotify.tex b/latex/classcore_1_1INotify.tex index ea23d97..cb3271d 100644 --- a/latex/classcore_1_1INotify.tex +++ b/latex/classcore_1_1INotify.tex @@ -1,8 +1,8 @@ -\hypertarget{classcore_1_1INotify}{}\doxysection{core\+::I\+Notify Class Reference} +\hypertarget{classcore_1_1INotify}{}\doxysection{core\+::INotify Class Reference} \label{classcore_1_1INotify}\index{core::INotify@{core::INotify}} -Inheritance diagram for core\+::I\+Notify\+:\nopagebreak +Inheritance diagram for core\+::INotify\+:\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -11,7 +11,7 @@ Inheritance diagram for core\+::I\+Notify\+:\nopagebreak \end{figure} -Collaboration diagram for core\+::I\+Notify\+:\nopagebreak +Collaboration diagram for core\+::INotify\+:\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -22,7 +22,7 @@ Collaboration diagram for core\+::I\+Notify\+:\nopagebreak \begin{DoxyCompactItemize} \item \mbox{\Hypertarget{classcore_1_1INotify_a777d8ab058639165974b7c0144564b26}\label{classcore_1_1INotify_a777d8ab058639165974b7c0144564b26}} -{\bfseries I\+Notify} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll) +{\bfseries INotify} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll) \item \mbox{\Hypertarget{classcore_1_1INotify_ab498fca3d44a7de75b1a6b1f9e1404e7}\label{classcore_1_1INotify_ab498fca3d44a7de75b1a6b1f9e1404e7}} int {\bfseries add\+Watch} (std\+::string watch) @@ -31,7 +31,7 @@ int {\bfseries add\+Watch} (std\+::string watch) void {\bfseries remove\+Watch} (int wd) \item \mbox{\Hypertarget{classcore_1_1INotify_a642e44e906da81ce8180beb2bc09d602}\label{classcore_1_1INotify_a642e44e906da81ce8180beb2bc09d602}} -void {\bfseries on\+Data\+Received} (coreutils\+::\+Z\+String \&data) override +void {\bfseries on\+Data\+Received} (coreutils\+::\+ZString \&data) override \item \mbox{\Hypertarget{classcore_1_1INotify_a172949023698fc486d690d3b6d3d6f17}\label{classcore_1_1INotify_a172949023698fc486d690d3b6d3d6f17}} virtual void {\bfseries in\+Access} (std\+::string name) @@ -73,5 +73,5 @@ virtual void {\bfseries in\+Open} (std\+::string name) The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} \item -I\+Notify.\+h\item -I\+Notify.\+cpp\end{DoxyCompactItemize} +INotify.\+h\item +INotify.\+cpp\end{DoxyCompactItemize} diff --git a/latex/classcore_1_1IPAddress.tex b/latex/classcore_1_1IPAddress.tex index eb2a5b5..e3ae49b 100644 --- a/latex/classcore_1_1IPAddress.tex +++ b/latex/classcore_1_1IPAddress.tex @@ -1,8 +1,8 @@ -\hypertarget{classcore_1_1IPAddress}{}\doxysection{core\+::I\+P\+Address Class Reference} +\hypertarget{classcore_1_1IPAddress}{}\doxysection{core\+::IPAddress Class Reference} \label{classcore_1_1IPAddress}\index{core::IPAddress@{core::IPAddress}} -Inheritance diagram for core\+::I\+P\+Address\+:\nopagebreak +Inheritance diagram for core\+::IPAddress\+:\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -11,7 +11,7 @@ Inheritance diagram for core\+::I\+P\+Address\+:\nopagebreak \end{figure} -Collaboration diagram for core\+::I\+P\+Address\+:\nopagebreak +Collaboration diagram for core\+::IPAddress\+:\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -22,10 +22,10 @@ Collaboration diagram for core\+::I\+P\+Address\+:\nopagebreak \begin{DoxyCompactItemize} \item \mbox{\Hypertarget{classcore_1_1IPAddress_a31fb55b1b979f0e8a07446285f9a99f8}\label{classcore_1_1IPAddress_a31fb55b1b979f0e8a07446285f9a99f8}} -{\bfseries I\+P\+Address} (std\+::string address) +{\bfseries IPAddress} (std\+::string address) \item \mbox{\Hypertarget{classcore_1_1IPAddress_a37d942b8fae09010adbda33f714808c0}\label{classcore_1_1IPAddress_a37d942b8fae09010adbda33f714808c0}} -{\bfseries I\+P\+Address} (std\+::string address, int port) +{\bfseries IPAddress} (std\+::string address, int port) \item \mbox{\Hypertarget{classcore_1_1IPAddress_a095a5ab48cc72161c1614ddfa89ac3ee}\label{classcore_1_1IPAddress_a095a5ab48cc72161c1614ddfa89ac3ee}} struct sockaddr $\ast$ {\bfseries get\+Pointer} () @@ -52,5 +52,5 @@ socklen\+\_\+t {\bfseries address\+Length} The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} \item -I\+P\+Address.\+h\item -I\+P\+Address.\+cpp\end{DoxyCompactItemize} +IPAddress.\+h\item +IPAddress.\+cpp\end{DoxyCompactItemize} diff --git a/latex/classcore_1_1IPAddressList.tex b/latex/classcore_1_1IPAddressList.tex index 6922343..654f1d8 100644 --- a/latex/classcore_1_1IPAddressList.tex +++ b/latex/classcore_1_1IPAddressList.tex @@ -1,16 +1,16 @@ -\hypertarget{classcore_1_1IPAddressList}{}\doxysection{core\+::I\+P\+Address\+List Class Reference} +\hypertarget{classcore_1_1IPAddressList}{}\doxysection{core\+::IPAddress\+List Class Reference} \label{classcore_1_1IPAddressList}\index{core::IPAddressList@{core::IPAddressList}} \doxysubsection*{Public Member Functions} \begin{DoxyCompactItemize} \item \mbox{\Hypertarget{classcore_1_1IPAddressList_a740cf5f7e2633836b7a741b9f048036f}\label{classcore_1_1IPAddressList_a740cf5f7e2633836b7a741b9f048036f}} -std\+::map$<$ std\+::string, \mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}} $>$ {\bfseries get\+List} () +std\+::map$<$ std\+::string, \mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}} $>$ {\bfseries get\+List} () \item \mbox{\Hypertarget{classcore_1_1IPAddressList_ab98c5a502d8f5cfb4e8c451c48dbc131}\label{classcore_1_1IPAddressList_ab98c5a502d8f5cfb4e8c451c48dbc131}} -void {\bfseries add} (\mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}} ip\+Address) +void {\bfseries add} (\mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}} ip\+Address) \item \mbox{\Hypertarget{classcore_1_1IPAddressList_a86e9890e15e8e0d87e34f36b637d5c40}\label{classcore_1_1IPAddressList_a86e9890e15e8e0d87e34f36b637d5c40}} -bool {\bfseries remove} (\mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}} ip\+Address) +bool {\bfseries remove} (\mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}} ip\+Address) \item \mbox{\Hypertarget{classcore_1_1IPAddressList_add254c996687fd8f9ada0b5335e477cd}\label{classcore_1_1IPAddressList_add254c996687fd8f9ada0b5335e477cd}} bool {\bfseries contains} (std\+::string ip\+Address) @@ -19,5 +19,5 @@ bool {\bfseries contains} (std\+::string ip\+Address) The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} \item -I\+P\+Address\+List.\+h\item -I\+P\+Address\+List.\+cpp\end{DoxyCompactItemize} +IPAddress\+List.\+h\item +IPAddress\+List.\+cpp\end{DoxyCompactItemize} diff --git a/latex/classcore_1_1SessionFilter.tex b/latex/classcore_1_1SessionFilter.tex index fa4bd33..a6c9358 100644 --- a/latex/classcore_1_1SessionFilter.tex +++ b/latex/classcore_1_1SessionFilter.tex @@ -22,7 +22,7 @@ Collaboration diagram for core\+::Session\+Filter\+:\nopagebreak \begin{DoxyCompactItemize} \item \mbox{\Hypertarget{classcore_1_1SessionFilter_a9871d18a9f90c8028f879b0993b25b6f}\label{classcore_1_1SessionFilter_a9871d18a9f90c8028f879b0993b25b6f}} -virtual bool {\bfseries test} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session) +virtual bool {\bfseries test} (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session) \end{DoxyCompactItemize} \doxysubsection*{Additional Inherited Members} diff --git a/latex/classcore_1_1Socket.tex b/latex/classcore_1_1Socket.tex index 873b0f2..d3e8728 100644 --- a/latex/classcore_1_1Socket.tex +++ b/latex/classcore_1_1Socket.tex @@ -6,7 +6,8 @@ -Inheritance diagram for core\+::Socket\+:\nopagebreak +Inheritance diagram for core\+::Socket\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -25,7 +26,7 @@ Collaboration diagram for core\+::Socket\+:\nopagebreak \doxysubsection*{Public Member Functions} \begin{DoxyCompactItemize} \item -\mbox{\hyperlink{classcore_1_1Socket_a4c3f87fd1de3c9eab4bf5efbb30ce87d}{Socket}} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, std\+::string text=\char`\"{}\char`\"{}) +\mbox{\hyperlink{classcore_1_1Socket_a4c3f87fd1de3c9eab4bf5efbb30ce87d}{Socket}} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, std\+::string text=\char`\"{}\char`\"{}) \item virtual \mbox{\hyperlink{classcore_1_1Socket_aa5003845f8ae464ad2fa206176381be0}{$\sim$\+Socket}} () \item @@ -78,15 +79,15 @@ int {\bfseries get\+Buffer\+Size} () virtual void \mbox{\hyperlink{classcore_1_1Socket_ac8d6a2c54696eb6fc2024cf6bcf6b4e5}{on\+Data\+Received}} (std\+::string data) \begin{DoxyCompactList}\small\item\em Called when data is received from the socket. \end{DoxyCompactList}\item \mbox{\Hypertarget{classcore_1_1Socket_ae048b57ac2c34381378f3da0e758b3c8}\label{classcore_1_1Socket_ae048b57ac2c34381378f3da0e758b3c8}} -virtual void {\bfseries on\+Data\+Received} (coreutils\+::\+Z\+String \&data) +virtual void {\bfseries on\+Data\+Received} (coreutils\+::\+ZString \&data) \item -virtual void \mbox{\hyperlink{classcore_1_1Socket_a46ed2e240852d3fa949979ebbc4ac875}{receive\+Data}} (coreutils\+::\+Z\+String \&buffer) +virtual void \mbox{\hyperlink{classcore_1_1Socket_a46ed2e240852d3fa949979ebbc4ac875}{receive\+Data}} (coreutils\+::\+ZString \&buffer) \end{DoxyCompactItemize} \doxysubsection*{Protected Attributes} \begin{DoxyCompactItemize} \item \mbox{\Hypertarget{classcore_1_1Socket_a3b0b139ac7da581f0d969f6ae9a0c97c}\label{classcore_1_1Socket_a3b0b139ac7da581f0d969f6ae9a0c97c}} -\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \& {\bfseries e\+Poll} +\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \& {\bfseries e\+Poll} \item \mbox{\Hypertarget{classcore_1_1Socket_aa09db6c6298d20ea76c6e65f8bffd3dc}\label{classcore_1_1Socket_aa09db6c6298d20ea76c6e65f8bffd3dc}} bool {\bfseries shut\+Down} = false @@ -98,26 +99,26 @@ bool {\bfseries shut\+Down} = false The core component to managing a socket. -Hooks into the \mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} through the registration and unregistration process and provides a communication socket of the specified protocol type. This object provides for all receiving data threading through use of the \mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} object and also provides buffering for output data requests to the socket. +Hooks into the \mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} through the registration and unregistration process and provides a communication socket of the specified protocol type. This object provides for all receiving data threading through use of the \mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} object and also provides buffering for output data requests to the socket. A program using a socket object can request to open a socket (network or device) and communicate through the streambuffer interface of the socket object. -The socket side of the \mbox{\hyperlink{classcore_1_1Socket}{Socket}} accepts E\+P\+O\+L\+L\+IN event and will maintain the data in a buffer for the stream readers to read. A on\+Data\+Received event is then sent with the data received in the buffer that can be read through the stream. Only sockets that send events to epoll can be used with this object. +The socket side of the \mbox{\hyperlink{classcore_1_1Socket}{Socket}} accepts EPOLLIN event and will maintain the data in a buffer for the stream readers to read. A on\+Data\+Received event is then sent with the data received in the buffer that can be read through the stream. Only sockets that send events to epoll can be used with this object. -When writing to the stream the data is written into a buffer and a E\+P\+O\+L\+L\+O\+UT is scheduled. Upon receiving the E\+P\+O\+L\+L\+O\+UT event then the buffer is written to the socket output. +When writing to the stream the data is written into a buffer and a EPOLLOUT is scheduled. Upon receiving the EPOLLOUT event then the buffer is written to the socket output. \doxysubsection{Constructor \& Destructor Documentation} \mbox{\Hypertarget{classcore_1_1Socket_a4c3f87fd1de3c9eab4bf5efbb30ce87d}\label{classcore_1_1Socket_a4c3f87fd1de3c9eab4bf5efbb30ce87d}} \index{core::Socket@{core::Socket}!Socket@{Socket}} \index{Socket@{Socket}!core::Socket@{core::Socket}} \doxysubsubsection{\texorpdfstring{Socket()}{Socket()}} -{\footnotesize\ttfamily core\+::\+Socket\+::\+Socket (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&}]{e\+Poll, }\item[{std\+::string}]{text = {\ttfamily \char`\"{}\char`\"{}} }\end{DoxyParamCaption})} +{\footnotesize\ttfamily core\+::\+Socket\+::\+Socket (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&}]{e\+Poll, }\item[{std\+::string}]{text = {\ttfamily \char`\"{}\char`\"{}} }\end{DoxyParamCaption})} Constructor \begin{DoxyParams}{Parameters} -{\em e\+Poll} & The \mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} socket descriptor. \\ +{\em e\+Poll} & The \mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} socket descriptor. \\ \hline {\em text} & A title for this socket. \\ \hline @@ -143,7 +144,7 @@ Parse epoll event and call specified callbacks. The event received from epoll is sent through the event\+Received method which will parse the event and call the read and write callbacks on the socket. -This method is called by the B\+M\+A\+E\+Poll object and should not be called from any user extended classes unless an epoll event is being simulated. +This method is called by the BMAEPoll object and should not be called from any user extended classes unless an epoll event is being simulated. The return value of false will delete the socket object causing the destructors to run. The return value of true will enable the socket on e\+Poll to receive more events. \mbox{\Hypertarget{classcore_1_1Socket_ac8d6a2c54696eb6fc2024cf6bcf6b4e5}\label{classcore_1_1Socket_ac8d6a2c54696eb6fc2024cf6bcf6b4e5}} \index{core::Socket@{core::Socket}!onDataReceived@{onDataReceived}} @@ -155,7 +156,7 @@ The return value of false will delete the socket object causing the destructors Called when data is received from the socket. -The on\+Connected method is called when the socket is ready to communicate. Writing to the socket can begin on this call to initiate a contact with the remote device. The on\+Data\+Received method is called when the socket has received an event from epoll and there is data ready to be read from the socket. The default handler will pull the data and put it into the streambuf for the socket. E\+P\+O\+L\+L\+IN +The on\+Connected method is called when the socket is ready to communicate. Writing to the socket can begin on this call to initiate a contact with the remote device. The on\+Data\+Received method is called when the socket has received an event from epoll and there is data ready to be read from the socket. The default handler will pull the data and put it into the streambuf for the socket. EPOLLIN \begin{DoxyParams}{Parameters} @@ -164,7 +165,7 @@ The on\+Connected method is called when the socket is ready to communicate. Writ \end{DoxyParams} -Reimplemented in \mbox{\hyperlink{classcore_1_1TCPServer_a276ccbc8cb9b4380ebd78807b97f0159}{core\+::\+T\+C\+P\+Server}}, and \mbox{\hyperlink{classcore_1_1UDPServerSocket_a41933ca153c854a800e3d047ab18313e}{core\+::\+U\+D\+P\+Server\+Socket}}. +Reimplemented in \mbox{\hyperlink{classcore_1_1UDPServerSocket_a41933ca153c854a800e3d047ab18313e}{core\+::\+UDPServer\+Socket}}, and \mbox{\hyperlink{classcore_1_1TCPServer_a276ccbc8cb9b4380ebd78807b97f0159}{core\+::\+TCPServer}}. \mbox{\Hypertarget{classcore_1_1Socket_a81e5ee3e17834166d97c6e8b7dfe0da0}\label{classcore_1_1Socket_a81e5ee3e17834166d97c6e8b7dfe0da0}} \index{core::Socket@{core::Socket}!onRegister@{onRegister}} @@ -178,7 +179,7 @@ Called before the socket has registered with the epoll processing. The on\+Register method is called before the socket is registered with e\+Poll so objects extending the \mbox{\hyperlink{classcore_1_1Socket}{Socket}} definition can initialize the socket before receiving events. Evoked when the descriptor is set using set\+Descriptor for the socket. -Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a76cec7cf4851eb27abe77a2339344c6d}{core\+::\+T\+L\+S\+Session}}. +Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a76cec7cf4851eb27abe77a2339344c6d}{core\+::\+TLSSession}}. \mbox{\Hypertarget{classcore_1_1Socket_ae9be59697c2b2e5efb19aaae3ba943d2}\label{classcore_1_1Socket_ae9be59697c2b2e5efb19aaae3ba943d2}} \index{core::Socket@{core::Socket}!onUnregistered@{onUnregistered}} @@ -194,11 +195,11 @@ The on\+Unregistered method is called whenever the socket is unregistered with e \index{core::Socket@{core::Socket}!receiveData@{receiveData}} \index{receiveData@{receiveData}!core::Socket@{core::Socket}} \doxysubsubsection{\texorpdfstring{receiveData()}{receiveData()}} -{\footnotesize\ttfamily void core\+::\+Socket\+::receive\+Data (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{buffer }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}} +{\footnotesize\ttfamily void core\+::\+Socket\+::receive\+Data (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{buffer }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}} -receive\+Data will read the data from the socket and place it in the socket buffer. T\+LS layer overrides this to be able to read from S\+SL. +receive\+Data will read the data from the socket and place it in the socket buffer. TLS layer overrides this to be able to read from SSL. -Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a8507cdcd23ac4b340ce6f6d5f0b26a52}{core\+::\+T\+L\+S\+Session}}. +Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a8507cdcd23ac4b340ce6f6d5f0b26a52}{core\+::\+TLSSession}}. \mbox{\Hypertarget{classcore_1_1Socket_ac44f6ae3196a8a3e09a6a85fcf495762}\label{classcore_1_1Socket_ac44f6ae3196a8a3e09a6a85fcf495762}} \index{core::Socket@{core::Socket}!setDescriptor@{setDescriptor}} @@ -210,7 +211,7 @@ Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a8507cdcd23ac4b340ce6f Set the descriptor for the socket. -set\+Descriptor establishes the file descriptor for the socket and registers the socket on the \mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} controller. set\+Descriptor will invoke the \mbox{\hyperlink{classcore_1_1Socket_a81e5ee3e17834166d97c6e8b7dfe0da0}{on\+Register()}} event. \mbox{\Hypertarget{classcore_1_1Socket_af2d1b6de7a64a9d446b0305b6ec47b31}\label{classcore_1_1Socket_af2d1b6de7a64a9d446b0305b6ec47b31}} +set\+Descriptor establishes the file descriptor for the socket and registers the socket on the \mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} controller. set\+Descriptor will invoke the \mbox{\hyperlink{classcore_1_1Socket_a81e5ee3e17834166d97c6e8b7dfe0da0}{on\+Register()}} event. \mbox{\Hypertarget{classcore_1_1Socket_af2d1b6de7a64a9d446b0305b6ec47b31}\label{classcore_1_1Socket_af2d1b6de7a64a9d446b0305b6ec47b31}} \index{core::Socket@{core::Socket}!shutdown@{shutdown}} \index{shutdown@{shutdown}!core::Socket@{core::Socket}} \doxysubsubsection{\texorpdfstring{shutdown()}{shutdown()}} diff --git a/latex/classcore_1_1Socket__inherit__graph.md5 b/latex/classcore_1_1Socket__inherit__graph.md5 index fccfbd3..cae5d78 100644 --- a/latex/classcore_1_1Socket__inherit__graph.md5 +++ b/latex/classcore_1_1Socket__inherit__graph.md5 @@ -1 +1 @@ -8091a6c3a543813cfce9b032080c642a \ No newline at end of file +5ea0d5d5486386272f1f6c4c06eae462 \ No newline at end of file diff --git a/latex/classcore_1_1Socket__inherit__graph.pdf b/latex/classcore_1_1Socket__inherit__graph.pdf index 8b311d2..c2405ee 100644 Binary files a/latex/classcore_1_1Socket__inherit__graph.pdf and b/latex/classcore_1_1Socket__inherit__graph.pdf differ diff --git a/latex/classcore_1_1Subscription.tex b/latex/classcore_1_1Subscription.tex index eb40276..b1dae8b 100644 --- a/latex/classcore_1_1Subscription.tex +++ b/latex/classcore_1_1Subscription.tex @@ -2,7 +2,8 @@ \label{classcore_1_1Subscription}\index{core::Subscription@{core::Subscription}} -Collaboration diagram for core\+::Subscription\+:\nopagebreak +Collaboration diagram for core\+::Subscription\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -13,28 +14,28 @@ Collaboration diagram for core\+::Subscription\+:\nopagebreak \begin{DoxyCompactItemize} \item \mbox{\Hypertarget{classcore_1_1Subscription_a348a4ec8232ada37f5be2b6f756f01f3}\label{classcore_1_1Subscription_a348a4ec8232ada37f5be2b6f756f01f3}} -{\bfseries Subscription} (std\+::string id, std\+::string mode=\char`\"{}$\ast$A\+U\+T\+H\+OR\char`\"{}) +{\bfseries Subscription} (std\+::string id, std\+::string mode=\char`\"{}$\ast$AUTHOR\char`\"{}) \item \mbox{\Hypertarget{classcore_1_1Subscription_a75e36b110e87138d4f5d8f0cbbaca4c1}\label{classcore_1_1Subscription_a75e36b110e87138d4f5d8f0cbbaca4c1}} -{\bfseries Subscription} (std\+::string id, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session, std\+::string mode=\char`\"{}$\ast$A\+U\+T\+H\+OR\char`\"{}) +{\bfseries Subscription} (std\+::string id, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session, std\+::string mode=\char`\"{}$\ast$AUTHOR\char`\"{}) \item \mbox{\Hypertarget{classcore_1_1Subscription_a57c23d7c49328eecf8358f84b485f7cb}\label{classcore_1_1Subscription_a57c23d7c49328eecf8358f84b485f7cb}} -int {\bfseries subscribe} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session) +int {\bfseries subscribe} (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session) \item \mbox{\Hypertarget{classcore_1_1Subscription_a4b6d9f10c605f20c7e27c308577ab8d4}\label{classcore_1_1Subscription_a4b6d9f10c605f20c7e27c308577ab8d4}} -int {\bfseries unsubscribe} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session) +int {\bfseries unsubscribe} (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session) \item -\mbox{\Hypertarget{classcore_1_1Subscription_a6065524e207dde927d553c581269e937}\label{classcore_1_1Subscription_a6065524e207dde927d553c581269e937}} -virtual int {\bfseries process} (coreutils\+::\+Z\+String \&request, std\+::stringstream \&out) +\mbox{\Hypertarget{classcore_1_1Subscription_afe97bd6c3c714df84381fdd6d66e5037}\label{classcore_1_1Subscription_afe97bd6c3c714df84381fdd6d66e5037}} +virtual int {\bfseries process} (coreutils\+::\+ZString \&request, std\+::stringstream \&out, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session) \item \mbox{\Hypertarget{classcore_1_1Subscription_a886b136b6eae0adcfac1384fc2fae67f}\label{classcore_1_1Subscription_a886b136b6eae0adcfac1384fc2fae67f}} -virtual int {\bfseries on\+Subscribe} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session) +virtual int {\bfseries on\+Subscribe} (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session) \item \mbox{\Hypertarget{classcore_1_1Subscription_adfd211503f5eccfda620995de58c73f9}\label{classcore_1_1Subscription_adfd211503f5eccfda620995de58c73f9}} int {\bfseries event} (std\+::stringstream \&out) \item \mbox{\Hypertarget{classcore_1_1Subscription_addf187a8e97c2be1ac0cce9c21da5a28}\label{classcore_1_1Subscription_addf187a8e97c2be1ac0cce9c21da5a28}} -bool {\bfseries if\+Subscriber} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session) +bool {\bfseries if\+Subscriber} (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session) \end{DoxyCompactItemize} \doxysubsection*{Public Attributes} \begin{DoxyCompactItemize} @@ -46,10 +47,10 @@ std\+::string {\bfseries id} std\+::string {\bfseries mode} \item \mbox{\Hypertarget{classcore_1_1Subscription_a5526427600aa4a5b180f76f201e85f58}\label{classcore_1_1Subscription_a5526427600aa4a5b180f76f201e85f58}} -\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$ {\bfseries owner} +\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$ {\bfseries owner} \item \mbox{\Hypertarget{classcore_1_1Subscription_ad1a5c1a3e5a6e253eb34795f43d4f9be}\label{classcore_1_1Subscription_ad1a5c1a3e5a6e253eb34795f43d4f9be}} -std\+::vector$<$ \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$ $>$ {\bfseries subscribers} +std\+::vector$<$ \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$ $>$ {\bfseries subscribers} \end{DoxyCompactItemize} diff --git a/latex/classcore_1_1SubscriptionManager.tex b/latex/classcore_1_1SubscriptionManager.tex index 288625d..321cb86 100644 --- a/latex/classcore_1_1SubscriptionManager.tex +++ b/latex/classcore_1_1SubscriptionManager.tex @@ -25,9 +25,9 @@ Collaboration diagram for core\+::Subscription\+Manager\+:\nopagebreak int {\bfseries add} (\mbox{\hyperlink{classcore_1_1Subscription}{Subscription}} \&subscription) \item \mbox{\Hypertarget{classcore_1_1SubscriptionManager_aed407c183c390f4459bb6527b30c8198}\label{classcore_1_1SubscriptionManager_aed407c183c390f4459bb6527b30c8198}} -int {\bfseries remove\+Session\+Subscriptions} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session) +int {\bfseries remove\+Session\+Subscriptions} (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session) \item -int \mbox{\hyperlink{classcore_1_1SubscriptionManager_aaa30bf772ad72b3f319a790662e4f8ae}{process\+Command}} (coreutils\+::\+Z\+String \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session) override +int \mbox{\hyperlink{classcore_1_1SubscriptionManager_aaa30bf772ad72b3f319a790662e4f8ae}{process\+Command}} (coreutils\+::\+ZString \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session) override \end{DoxyCompactItemize} @@ -36,7 +36,7 @@ int \mbox{\hyperlink{classcore_1_1SubscriptionManager_aaa30bf772ad72b3f319a79066 \index{core::SubscriptionManager@{core::SubscriptionManager}!processCommand@{processCommand}} \index{processCommand@{processCommand}!core::SubscriptionManager@{core::SubscriptionManager}} \doxysubsubsection{\texorpdfstring{processCommand()}{processCommand()}} -{\footnotesize\ttfamily int core\+::\+Subscription\+Manager\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&}]{session }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}} +{\footnotesize\ttfamily int core\+::\+Subscription\+Manager\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&}]{session }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}} This method is used to implement the functionality of the requested command. This pure virtual function must be implemented in your inheriting object. diff --git a/latex/classcore_1_1Subscription__coll__graph.md5 b/latex/classcore_1_1Subscription__coll__graph.md5 index 1903073..59c55fd 100644 --- a/latex/classcore_1_1Subscription__coll__graph.md5 +++ b/latex/classcore_1_1Subscription__coll__graph.md5 @@ -1 +1 @@ -66e736a90742b1dc209cc7069b9e8c91 \ No newline at end of file +2729f4733c58f8e25137c8d4e188b60b \ No newline at end of file diff --git a/latex/classcore_1_1Subscription__coll__graph.pdf b/latex/classcore_1_1Subscription__coll__graph.pdf index 14f99de..33d7f0b 100644 Binary files a/latex/classcore_1_1Subscription__coll__graph.pdf and b/latex/classcore_1_1Subscription__coll__graph.pdf differ diff --git a/latex/classcore_1_1TCPServer.tex b/latex/classcore_1_1TCPServer.tex index 30e186a..b3fee9d 100644 --- a/latex/classcore_1_1TCPServer.tex +++ b/latex/classcore_1_1TCPServer.tex @@ -1,12 +1,12 @@ -\hypertarget{classcore_1_1TCPServer}{}\doxysection{core\+::T\+C\+P\+Server Class Reference} +\hypertarget{classcore_1_1TCPServer}{}\doxysection{core\+::TCPServer Class Reference} \label{classcore_1_1TCPServer}\index{core::TCPServer@{core::TCPServer}} -{\ttfamily \#include $<$T\+C\+P\+Server.\+h$>$} +{\ttfamily \#include $<$TCPServer.\+h$>$} -Inheritance diagram for core\+::T\+C\+P\+Server\+:\nopagebreak +Inheritance diagram for core\+::TCPServer\+:\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -15,7 +15,8 @@ Inheritance diagram for core\+::T\+C\+P\+Server\+:\nopagebreak \end{figure} -Collaboration diagram for core\+::T\+C\+P\+Server\+:\nopagebreak +Collaboration diagram for core\+::TCPServer\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -25,17 +26,17 @@ Collaboration diagram for core\+::T\+C\+P\+Server\+:\nopagebreak \doxysubsection*{Public Member Functions} \begin{DoxyCompactItemize} \item -\mbox{\hyperlink{classcore_1_1TCPServer_abaecb97c336b757d1029d45277f9fc5b}{T\+C\+P\+Server}} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}} address, std\+::string delimiter=\char`\"{} \char`\"{}, int depth=10, std\+::string text=\char`\"{}\char`\"{}) +\mbox{\hyperlink{classcore_1_1TCPServer_abaecb97c336b757d1029d45277f9fc5b}{TCPServer}} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}} address, std\+::string delimiter=\char`\"{} \char`\"{}, int depth=10, std\+::string text=\char`\"{}\char`\"{}) \item -virtual \mbox{\hyperlink{classcore_1_1TCPServer_a7ccdc057c9eee8504fce796301f82088}{$\sim$\+T\+C\+P\+Server}} () +virtual \mbox{\hyperlink{classcore_1_1TCPServer_a7ccdc057c9eee8504fce796301f82088}{$\sim$\+TCPServer}} () \item \mbox{\Hypertarget{classcore_1_1TCPServer_a554ec6e67d368e7bb545d95635c0a0df}\label{classcore_1_1TCPServer_a554ec6e67d368e7bb545d95635c0a0df}} virtual void {\bfseries session\+Error\+Handler} (std\+::string error\+String, std\+::stringstream \&out) \item -virtual \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$ \mbox{\hyperlink{classcore_1_1TCPServer_a841f02799ad8529aad7cea132f4de8a9}{get\+Socket\+Accept}} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&epoll) +virtual \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$ \mbox{\hyperlink{classcore_1_1TCPServer_a841f02799ad8529aad7cea132f4de8a9}{get\+Socket\+Accept}} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&epoll) \item \mbox{\Hypertarget{classcore_1_1TCPServer_a88c603cd5df9dbc1632fd4b5e164d75b}\label{classcore_1_1TCPServer_a88c603cd5df9dbc1632fd4b5e164d75b}} -void {\bfseries remove\+From\+Session\+List} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session) +void {\bfseries remove\+From\+Session\+List} (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$session) \item \mbox{\Hypertarget{classcore_1_1TCPServer_a49e3ead1bf4e7830685780e73c4db5db}\label{classcore_1_1TCPServer_a49e3ead1bf4e7830685780e73c4db5db}} void \mbox{\hyperlink{classcore_1_1TCPServer_a49e3ead1bf4e7830685780e73c4db5db}{output}} (std\+::stringstream \&out) @@ -43,20 +44,20 @@ void \mbox{\hyperlink{classcore_1_1TCPServer_a49e3ead1bf4e7830685780e73c4db5db}{ \mbox{\Hypertarget{classcore_1_1TCPServer_a9cfcf2984ddc7e1d8f157c9f07ad03e1}\label{classcore_1_1TCPServer_a9cfcf2984ddc7e1d8f157c9f07ad03e1}} void {\bfseries send\+To\+All} (std\+::stringstream \&out) \item -void \mbox{\hyperlink{classcore_1_1TCPServer_a7080f7d45e734087e81b83c5e1f8e676}{send\+To\+All}} (std\+::stringstream \&out, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&sender, \mbox{\hyperlink{classcore_1_1SessionFilter}{Session\+Filter}} filter) +void \mbox{\hyperlink{classcore_1_1TCPServer_a7080f7d45e734087e81b83c5e1f8e676}{send\+To\+All}} (std\+::stringstream \&out, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&sender, \mbox{\hyperlink{classcore_1_1SessionFilter}{Session\+Filter}} filter) \item -void \mbox{\hyperlink{classcore_1_1TCPServer_af708df59e1bc60077c16db97f9cc8ff0}{send\+To\+All}} (std\+::stringstream \&out, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&sender) +void \mbox{\hyperlink{classcore_1_1TCPServer_af708df59e1bc60077c16db97f9cc8ff0}{send\+To\+All}} (std\+::stringstream \&out, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&sender) \end{DoxyCompactItemize} \doxysubsection*{Public Attributes} \begin{DoxyCompactItemize} \item -std\+::vector$<$ \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$ $>$ \mbox{\hyperlink{classcore_1_1TCPServer_aeed1bc55d099667ccda51cd682bfc633}{sessions}} +std\+::vector$<$ \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$ $>$ \mbox{\hyperlink{classcore_1_1TCPServer_aeed1bc55d099667ccda51cd682bfc633}{sessions}} \item \mbox{\hyperlink{classcore_1_1CommandList}{Command\+List}} \mbox{\hyperlink{classcore_1_1TCPServer_afcc44802b988e2f4292504e804dccf8b}{commands}} \item -\mbox{\hyperlink{classcore_1_1IPAddressList}{I\+P\+Address\+List}} $\ast$ \mbox{\hyperlink{classcore_1_1TCPServer_a82f6bf16e4ab20d8b30da09e034fffff}{black\+List}} +\mbox{\hyperlink{classcore_1_1IPAddressList}{IPAddress\+List}} $\ast$ \mbox{\hyperlink{classcore_1_1TCPServer_a82f6bf16e4ab20d8b30da09e034fffff}{black\+List}} \item -\mbox{\hyperlink{classcore_1_1IPAddressList}{I\+P\+Address\+List}} $\ast$ \mbox{\hyperlink{classcore_1_1TCPServer_abad6300b6234ca8b69cef9128755342e}{white\+List}} +\mbox{\hyperlink{classcore_1_1IPAddressList}{IPAddress\+List}} $\ast$ \mbox{\hyperlink{classcore_1_1TCPServer_abad6300b6234ca8b69cef9128755342e}{white\+List}} \item \mbox{\hyperlink{classcore_1_1SubscriptionManager}{Subscription\+Manager}} \mbox{\hyperlink{classcore_1_1TCPServer_a28302dd844cfc971ee41de2000d24aa0}{subscriptions}} \end{DoxyCompactItemize} @@ -65,32 +66,32 @@ std\+::vector$<$ \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ \item void \mbox{\hyperlink{classcore_1_1TCPServer_a276ccbc8cb9b4380ebd78807b97f0159}{on\+Data\+Received}} (std\+::string data) override \item -int \mbox{\hyperlink{classcore_1_1TCPServer_a6b7a7e1ac4132942fcaf418ed41c1437}{process\+Command}} (coreutils\+::\+Z\+String \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session) override +int \mbox{\hyperlink{classcore_1_1TCPServer_a6b7a7e1ac4132942fcaf418ed41c1437}{process\+Command}} (coreutils\+::\+ZString \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session) override \end{DoxyCompactItemize} \doxysubsection*{Additional Inherited Members} \doxysubsection{Detailed Description} -\mbox{\hyperlink{classcore_1_1TCPServer}{T\+C\+P\+Server}} +\mbox{\hyperlink{classcore_1_1TCPServer}{TCPServer}} -Manage a socket connection as a T\+CP server type. Connections to the socket are processed through the accept functionality. +Manage a socket connection as a TCP server type. Connections to the socket are processed through the accept functionality. A list of connections is maintained in a vector object. -This object extends the B\+M\+A\+Command object as well so it can be added to a Console object and process commands to display status information. +This object extends the BMACommand object as well so it can be added to a Console object and process commands to display status information. \doxysubsection{Constructor \& Destructor Documentation} \mbox{\Hypertarget{classcore_1_1TCPServer_abaecb97c336b757d1029d45277f9fc5b}\label{classcore_1_1TCPServer_abaecb97c336b757d1029d45277f9fc5b}} \index{core::TCPServer@{core::TCPServer}!TCPServer@{TCPServer}} \index{TCPServer@{TCPServer}!core::TCPServer@{core::TCPServer}} \doxysubsubsection{\texorpdfstring{TCPServer()}{TCPServer()}} -{\footnotesize\ttfamily core\+::\+T\+C\+P\+Server\+::\+T\+C\+P\+Server (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&}]{e\+Poll, }\item[{\mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}}}]{address, }\item[{std\+::string}]{delimiter = {\ttfamily \char`\"{}~\char`\"{}}, }\item[{int}]{depth = {\ttfamily 10}, }\item[{std\+::string}]{text = {\ttfamily \char`\"{}\char`\"{}} }\end{DoxyParamCaption})} +{\footnotesize\ttfamily core\+::\+TCPServer\+::\+TCPServer (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&}]{e\+Poll, }\item[{\mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}}}]{address, }\item[{std\+::string}]{delimiter = {\ttfamily \char`\"{}~\char`\"{}}, }\item[{int}]{depth = {\ttfamily 10}, }\item[{std\+::string}]{text = {\ttfamily \char`\"{}\char`\"{}} }\end{DoxyParamCaption})} -The constructor for the \mbox{\hyperlink{classcore_1_1TCPServer}{T\+C\+P\+Server}} object. +The constructor for the \mbox{\hyperlink{classcore_1_1TCPServer}{TCPServer}} object. \begin{DoxyParams}{Parameters} -{\em e\+Poll} & the \mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} instance that manages the socket. \\ +{\em e\+Poll} & the \mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} instance that manages the socket. \\ \hline {\em url} & the IP address for the socket to receive connection requests. \\ \hline @@ -103,7 +104,7 @@ The constructor for the \mbox{\hyperlink{classcore_1_1TCPServer}{T\+C\+P\+Server \index{core::TCPServer@{core::TCPServer}!````~TCPServer@{$\sim$TCPServer}} \index{````~TCPServer@{$\sim$TCPServer}!core::TCPServer@{core::TCPServer}} \doxysubsubsection{\texorpdfstring{$\sim$TCPServer()}{~TCPServer()}} -{\footnotesize\ttfamily core\+::\+T\+C\+P\+Server\+::$\sim$\+T\+C\+P\+Server (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} +{\footnotesize\ttfamily core\+::\+TCPServer\+::$\sim$\+TCPServer (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} The destructor for this object. @@ -112,7 +113,7 @@ The destructor for this object. \index{core::TCPServer@{core::TCPServer}!getSocketAccept@{getSocketAccept}} \index{getSocketAccept@{getSocketAccept}!core::TCPServer@{core::TCPServer}} \doxysubsubsection{\texorpdfstring{getSocketAccept()}{getSocketAccept()}} -{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$ core\+::\+T\+C\+P\+Server\+::get\+Socket\+Accept (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&}]{epoll }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} +{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$ core\+::\+TCPServer\+::get\+Socket\+Accept (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&}]{epoll }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} get\+Socket\+Accept is designed to allow a polymorphic extension of this object to return a type of object that extends the definition of the server socket. Returning the appropriate session object that extends from Session provides the mechanism where the server can select the protocol dialog for the desired service. @@ -122,7 +123,7 @@ Reimplemented in \mbox{\hyperlink{classcore_1_1ConsoleServer_a80d9ea7f3fc5e07c50 \index{core::TCPServer@{core::TCPServer}!onDataReceived@{onDataReceived}} \index{onDataReceived@{onDataReceived}!core::TCPServer@{core::TCPServer}} \doxysubsubsection{\texorpdfstring{onDataReceived()}{onDataReceived()}} -{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Server\+::on\+Data\+Received (\begin{DoxyParamCaption}\item[{std\+::string}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}} +{\footnotesize\ttfamily void core\+::\+TCPServer\+::on\+Data\+Received (\begin{DoxyParamCaption}\item[{std\+::string}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}} Override the virtual data\+Received since for the server these are requests to accept the new connection socket. No data is to be read or written when this method is called. It is the response to the fact that a new connection is coming into the system @@ -141,7 +142,7 @@ Reimplemented from \mbox{\hyperlink{classcore_1_1Socket_ac8d6a2c54696eb6fc2024cf \index{core::TCPServer@{core::TCPServer}!processCommand@{processCommand}} \index{processCommand@{processCommand}!core::TCPServer@{core::TCPServer}} \doxysubsubsection{\texorpdfstring{processCommand()}{processCommand()}} -{\footnotesize\ttfamily int core\+::\+T\+C\+P\+Server\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&}]{session }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}} +{\footnotesize\ttfamily int core\+::\+TCPServer\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&}]{session }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}} This method is called when the \mbox{\hyperlink{classcore_1_1Command}{Command}} associated with this object is requested because a user has typed in the associated command name on a command entry line. @@ -158,13 +159,13 @@ Reimplemented from \mbox{\hyperlink{classcore_1_1Command_a95176f2532c38ee14e3fee \index{core::TCPServer@{core::TCPServer}!sendToAll@{sendToAll}} \index{sendToAll@{sendToAll}!core::TCPServer@{core::TCPServer}} \doxysubsubsection{\texorpdfstring{sendToAll()}{sendToAll()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Server\+::send\+To\+All (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&}]{sender }\end{DoxyParamCaption})} +{\footnotesize\ttfamily void core\+::\+TCPServer\+::send\+To\+All (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&}]{sender }\end{DoxyParamCaption})} Use this send\+To\+All method to output the contents of the out stream to all the connections on the server excluding the sender session and the entries identified by the passed in filter object. \mbox{\Hypertarget{classcore_1_1TCPServer_a7080f7d45e734087e81b83c5e1f8e676}\label{classcore_1_1TCPServer_a7080f7d45e734087e81b83c5e1f8e676}} \index{core::TCPServer@{core::TCPServer}!sendToAll@{sendToAll}} \index{sendToAll@{sendToAll}!core::TCPServer@{core::TCPServer}} \doxysubsubsection{\texorpdfstring{sendToAll()}{sendToAll()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Server\+::send\+To\+All (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&}]{sender, }\item[{\mbox{\hyperlink{classcore_1_1SessionFilter}{Session\+Filter}}}]{filter }\end{DoxyParamCaption})} +{\footnotesize\ttfamily void core\+::\+TCPServer\+::send\+To\+All (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&}]{sender, }\item[{\mbox{\hyperlink{classcore_1_1SessionFilter}{Session\+Filter}}}]{filter }\end{DoxyParamCaption})} Use this send\+To\+All method to output the contents of the out stream to all the connections on the server excluding the sender session. @@ -173,35 +174,35 @@ Use this send\+To\+All method to output the contents of the out stream to all th \index{core::TCPServer@{core::TCPServer}!blackList@{blackList}} \index{blackList@{blackList}!core::TCPServer@{core::TCPServer}} \doxysubsubsection{\texorpdfstring{blackList}{blackList}} -{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1IPAddressList}{I\+P\+Address\+List}}$\ast$ core\+::\+T\+C\+P\+Server\+::black\+List} +{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1IPAddressList}{IPAddress\+List}}$\ast$ core\+::\+TCPServer\+::black\+List} -If not N\+U\+LL the blacklist object can be assigned to this server socket and the server IP addresses connecting to the server attempting to accept a socket are contained in this list then the connection is rejected and no accept is granted. \mbox{\Hypertarget{classcore_1_1TCPServer_afcc44802b988e2f4292504e804dccf8b}\label{classcore_1_1TCPServer_afcc44802b988e2f4292504e804dccf8b}} +If not NULL the blacklist object can be assigned to this server socket and the server IP addresses connecting to the server attempting to accept a socket are contained in this list then the connection is rejected and no accept is granted. \mbox{\Hypertarget{classcore_1_1TCPServer_afcc44802b988e2f4292504e804dccf8b}\label{classcore_1_1TCPServer_afcc44802b988e2f4292504e804dccf8b}} \index{core::TCPServer@{core::TCPServer}!commands@{commands}} \index{commands@{commands}!core::TCPServer@{core::TCPServer}} \doxysubsubsection{\texorpdfstring{commands}{commands}} -{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1CommandList}{Command\+List}} core\+::\+T\+C\+P\+Server\+::commands} +{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1CommandList}{Command\+List}} core\+::\+TCPServer\+::commands} The commands object is a \mbox{\hyperlink{classcore_1_1CommandList}{Command\+List}} and is used to store \mbox{\hyperlink{classcore_1_1Command}{Command}} objects to be parsed and run as data comes into the session. \mbox{\Hypertarget{classcore_1_1TCPServer_aeed1bc55d099667ccda51cd682bfc633}\label{classcore_1_1TCPServer_aeed1bc55d099667ccda51cd682bfc633}} \index{core::TCPServer@{core::TCPServer}!sessions@{sessions}} \index{sessions@{sessions}!core::TCPServer@{core::TCPServer}} \doxysubsubsection{\texorpdfstring{sessions}{sessions}} -{\footnotesize\ttfamily std\+::vector$<$\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$$>$ core\+::\+T\+C\+P\+Server\+::sessions} +{\footnotesize\ttfamily std\+::vector$<$\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$$>$ core\+::\+TCPServer\+::sessions} The list of sessions that are currently open and being maintained by this object. \mbox{\Hypertarget{classcore_1_1TCPServer_a28302dd844cfc971ee41de2000d24aa0}\label{classcore_1_1TCPServer_a28302dd844cfc971ee41de2000d24aa0}} \index{core::TCPServer@{core::TCPServer}!subscriptions@{subscriptions}} \index{subscriptions@{subscriptions}!core::TCPServer@{core::TCPServer}} \doxysubsubsection{\texorpdfstring{subscriptions}{subscriptions}} -{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1SubscriptionManager}{Subscription\+Manager}} core\+::\+T\+C\+P\+Server\+::subscriptions} +{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1SubscriptionManager}{Subscription\+Manager}} core\+::\+TCPServer\+::subscriptions} The \mbox{\hyperlink{classcore_1_1Subscription}{Subscription}} Manager tracks all subscriptions on the server. \mbox{\Hypertarget{classcore_1_1TCPServer_abad6300b6234ca8b69cef9128755342e}\label{classcore_1_1TCPServer_abad6300b6234ca8b69cef9128755342e}} \index{core::TCPServer@{core::TCPServer}!whiteList@{whiteList}} \index{whiteList@{whiteList}!core::TCPServer@{core::TCPServer}} \doxysubsubsection{\texorpdfstring{whiteList}{whiteList}} -{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1IPAddressList}{I\+P\+Address\+List}}$\ast$ core\+::\+T\+C\+P\+Server\+::white\+List} +{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1IPAddressList}{IPAddress\+List}}$\ast$ core\+::\+TCPServer\+::white\+List} -If not N\+U\+LL the blacklist object can be assigned to this server socket and the server IP addresses connecting to the server attempting to accept a socket are contained in this list then the connection is rejected and no accept is granted. +If not NULL the blacklist object can be assigned to this server socket and the server IP addresses connecting to the server attempting to accept a socket are contained in this list then the connection is rejected and no accept is granted. The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} \item -T\+C\+P\+Server.\+h\item -T\+C\+P\+Server.\+cpp\end{DoxyCompactItemize} +TCPServer.\+h\item +TCPServer.\+cpp\end{DoxyCompactItemize} diff --git a/latex/classcore_1_1TCPServer__coll__graph.md5 b/latex/classcore_1_1TCPServer__coll__graph.md5 index f6519c9..07d9f0d 100644 --- a/latex/classcore_1_1TCPServer__coll__graph.md5 +++ b/latex/classcore_1_1TCPServer__coll__graph.md5 @@ -1 +1 @@ -69b71d93a92fa95269e4cf915e547067 \ No newline at end of file +6217c13639011961a1bf70a3e5264d12 \ No newline at end of file diff --git a/latex/classcore_1_1TCPServer__coll__graph.pdf b/latex/classcore_1_1TCPServer__coll__graph.pdf index 264b396..23388c6 100644 Binary files a/latex/classcore_1_1TCPServer__coll__graph.pdf and b/latex/classcore_1_1TCPServer__coll__graph.pdf differ diff --git a/latex/classcore_1_1TCPSession.tex b/latex/classcore_1_1TCPSession.tex index 683d619..8be5c90 100644 --- a/latex/classcore_1_1TCPSession.tex +++ b/latex/classcore_1_1TCPSession.tex @@ -1,12 +1,13 @@ -\hypertarget{classcore_1_1TCPSession}{}\doxysection{core\+::T\+C\+P\+Session Class Reference} +\hypertarget{classcore_1_1TCPSession}{}\doxysection{core\+::TCPSession Class Reference} \label{classcore_1_1TCPSession}\index{core::TCPSession@{core::TCPSession}} -{\ttfamily \#include $<$T\+C\+P\+Session.\+h$>$} +{\ttfamily \#include $<$TCPSession.\+h$>$} -Inheritance diagram for core\+::T\+C\+P\+Session\+:\nopagebreak +Inheritance diagram for core\+::TCPSession\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -15,7 +16,8 @@ Inheritance diagram for core\+::T\+C\+P\+Session\+:\nopagebreak \end{figure} -Collaboration diagram for core\+::T\+C\+P\+Session\+:\nopagebreak +Collaboration diagram for core\+::TCPSession\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -26,7 +28,7 @@ Collaboration diagram for core\+::T\+C\+P\+Session\+:\nopagebreak \begin{DoxyCompactItemize} \item \mbox{\Hypertarget{classcore_1_1TCPSession_a7e1192babcdeb688f463d3e9e85d0979}\label{classcore_1_1TCPSession_a7e1192babcdeb688f463d3e9e85d0979}} -{\bfseries T\+C\+P\+Session} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1TCPServer}{T\+C\+P\+Server}} \&server, std\+::string text=\char`\"{}\char`\"{}) +{\bfseries TCPSession} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1TCPServer}{TCPServer}} \&server, std\+::string text=\char`\"{}\char`\"{}) \item virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}{output}} (std\+::stringstream \&data) \item @@ -38,10 +40,10 @@ void \mbox{\hyperlink{classcore_1_1TCPSession_a34936745e8d7669d5400e78d353a56d3} \begin{DoxyCompactItemize} \item \mbox{\Hypertarget{classcore_1_1TCPSession_a2c39191d695d79891989ea628f42c0a8}\label{classcore_1_1TCPSession_a2c39191d695d79891989ea628f42c0a8}} -\mbox{\hyperlink{classcore_1_1Command}{Command}} $\ast$ {\bfseries grab} = N\+U\+LL +\mbox{\hyperlink{classcore_1_1Command}{Command}} $\ast$ {\bfseries grab} = NULL \item \mbox{\Hypertarget{classcore_1_1TCPSession_a265d9493fa544e601b5ad5fb1663340c}\label{classcore_1_1TCPSession_a265d9493fa544e601b5ad5fb1663340c}} -\mbox{\hyperlink{classcore_1_1TCPServer}{T\+C\+P\+Server}} \& {\bfseries server} +\mbox{\hyperlink{classcore_1_1TCPServer}{TCPServer}} \& {\bfseries server} \item std\+::stringstream \mbox{\hyperlink{classcore_1_1TCPSession_abb302bbb3d7e7bc75490c736364f0d4d}{out}} \end{DoxyCompactItemize} @@ -51,15 +53,15 @@ std\+::stringstream \mbox{\hyperlink{classcore_1_1TCPSession_abb302bbb3d7e7bc754 \mbox{\Hypertarget{classcore_1_1TCPSession_aed4ed499b978bcea57a8efefe929fc98}\label{classcore_1_1TCPSession_aed4ed499b978bcea57a8efefe929fc98}} virtual void \mbox{\hyperlink{classcore_1_1TCPSession_aed4ed499b978bcea57a8efefe929fc98}{on\+Registered}} () override \begin{DoxyCompactList}\small\item\em Called after the socket has been registered with epoll processing. \end{DoxyCompactList}\item -virtual void \mbox{\hyperlink{classcore_1_1TCPSession_afc2d2a92bc65e1e5122a93d120253a1d}{on\+Data\+Received}} (coreutils\+::\+Z\+String \&data) override +virtual void \mbox{\hyperlink{classcore_1_1TCPSession_afc2d2a92bc65e1e5122a93d120253a1d}{on\+Data\+Received}} (coreutils\+::\+ZString \&data) override \item -virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a3d9e0f14e7d24357fd1950b3f9b4eaff}{on\+Line\+Received}} (coreutils\+::\+Z\+String \&line) +virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a3d9e0f14e7d24357fd1950b3f9b4eaff}{on\+Line\+Received}} (coreutils\+::\+ZString \&line) \item -virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a9c996cbbfa2e592c23cf67ed8b15a32a}{on\+Block\+Received}} (coreutils\+::\+Z\+String \&block) +virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a9c996cbbfa2e592c23cf67ed8b15a32a}{on\+Block\+Received}} (coreutils\+::\+ZString \&block) \item virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a8719952f7bb00bf7239ec40aa2868626}{on\+Connected}} () \item -virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a98a65da2346b79bee659fca6902e94c7}{protocol}} (coreutils\+::\+Z\+String \&data) +virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a98a65da2346b79bee659fca6902e94c7}{protocol}} (coreutils\+::\+ZString \&data) \item void \mbox{\hyperlink{classcore_1_1TCPSession_a836fb3fd5ee543ebc93262a980ae88b5}{set\+Block\+Size}} (int size=0) \end{DoxyCompactItemize} @@ -67,28 +69,28 @@ void \mbox{\hyperlink{classcore_1_1TCPSession_a836fb3fd5ee543ebc93262a980ae88b5} \doxysubsection{Detailed Description} -\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} +\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} -\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} defines the nature of the interaction with the client and stores persistent data for a defined session. \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} objects are not sockets but instead provide a communications control mechanism. Protocol conversations are provided through extensions from this object. +\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} defines the nature of the interaction with the client and stores persistent data for a defined session. \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} objects are not sockets but instead provide a communications control mechanism. Protocol conversations are provided through extensions from this object. \doxysubsection{Member Function Documentation} \mbox{\Hypertarget{classcore_1_1TCPSession_a9c996cbbfa2e592c23cf67ed8b15a32a}\label{classcore_1_1TCPSession_a9c996cbbfa2e592c23cf67ed8b15a32a}} \index{core::TCPSession@{core::TCPSession}!onBlockReceived@{onBlockReceived}} \index{onBlockReceived@{onBlockReceived}!core::TCPSession@{core::TCPSession}} \doxysubsubsection{\texorpdfstring{onBlockReceived()}{onBlockReceived()}} -{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::on\+Block\+Received (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{block }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}} +{\footnotesize\ttfamily void core\+::\+TCPSession\+::on\+Block\+Received (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{block }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}} Override the on\+Block\+Received method to receive a string of characters that represents a single block of data of length determined by the block length value. If on\+Data\+Received was overriden this method will not be called unless the on\+Data\+Received calls this method explicitly using the class and member name. \mbox{\Hypertarget{classcore_1_1TCPSession_a8719952f7bb00bf7239ec40aa2868626}\label{classcore_1_1TCPSession_a8719952f7bb00bf7239ec40aa2868626}} \index{core::TCPSession@{core::TCPSession}!onConnected@{onConnected}} \index{onConnected@{onConnected}!core::TCPSession@{core::TCPSession}} \doxysubsubsection{\texorpdfstring{onConnected()}{onConnected()}} -{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::on\+Connected (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}} +{\footnotesize\ttfamily void core\+::\+TCPSession\+::on\+Connected (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}} This method is called from within the protocol method when protocol is called on the initial connection where the data is an empty string. Use this method to deliver a message to the connection upon connection. \mbox{\Hypertarget{classcore_1_1TCPSession_afc2d2a92bc65e1e5122a93d120253a1d}\label{classcore_1_1TCPSession_afc2d2a92bc65e1e5122a93d120253a1d}} \index{core::TCPSession@{core::TCPSession}!onDataReceived@{onDataReceived}} \index{onDataReceived@{onDataReceived}!core::TCPSession@{core::TCPSession}} \doxysubsubsection{\texorpdfstring{onDataReceived()}{onDataReceived()}} -{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::on\+Data\+Received (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}} +{\footnotesize\ttfamily void core\+::\+TCPSession\+::on\+Data\+Received (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}} Override this method to receive data directly from the socket as data is received. If you need data split by line termination characters then override the on\+Line\+Received method instead. @@ -98,64 +100,64 @@ Reimplemented from \mbox{\hyperlink{classcore_1_1Socket}{core\+::\+Socket}}. \index{core::TCPSession@{core::TCPSession}!onLineReceived@{onLineReceived}} \index{onLineReceived@{onLineReceived}!core::TCPSession@{core::TCPSession}} \doxysubsubsection{\texorpdfstring{onLineReceived()}{onLineReceived()}} -{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::on\+Line\+Received (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{line }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}} +{\footnotesize\ttfamily void core\+::\+TCPSession\+::on\+Line\+Received (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{line }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}} -Override the on\+Line\+Received method to receive a string of characters that represents a single line of data terminated by a LF or C\+R\+LF. If on\+Data\+Received was overriden this method will not be called unless the on\+Data\+Received calls this method explicitly using the class and member name. \mbox{\Hypertarget{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}\label{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}} +Override the on\+Line\+Received method to receive a string of characters that represents a single line of data terminated by a LF or CRLF. If on\+Data\+Received was overriden this method will not be called unless the on\+Data\+Received calls this method explicitly using the class and member name. \mbox{\Hypertarget{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}\label{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}} \index{core::TCPSession@{core::TCPSession}!output@{output}} \index{output@{output}!core::TCPSession@{core::TCPSession}} \doxysubsubsection{\texorpdfstring{output()}{output()}} -{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::output (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} +{\footnotesize\ttfamily void core\+::\+TCPSession\+::output (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} -The output method is called by a socket session (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}}) and will output the detail information for the client socket. When extending B\+M\+A\+T\+C\+P\+Socket or B\+M\+A\+Session you can override the method to add attributes to the list. +The output method is called by a socket session (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}}) and will output the detail information for the client socket. When extending BMATCPSocket or BMASession you can override the method to add attributes to the list. -Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSocket_afacf7528ff3c9ac077d7b5a49e2116fd}{core\+::\+T\+C\+P\+Socket}}. +Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSocket_afacf7528ff3c9ac077d7b5a49e2116fd}{core\+::\+TCPSocket}}. -Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_ae55de8a035d1ddc560cf619b2030af43}{core\+::\+T\+L\+S\+Session}}. +Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_ae55de8a035d1ddc560cf619b2030af43}{core\+::\+TLSSession}}. \mbox{\Hypertarget{classcore_1_1TCPSession_a98a65da2346b79bee659fca6902e94c7}\label{classcore_1_1TCPSession_a98a65da2346b79bee659fca6902e94c7}} \index{core::TCPSession@{core::TCPSession}!protocol@{protocol}} \index{protocol@{protocol}!core::TCPSession@{core::TCPSession}} \doxysubsubsection{\texorpdfstring{protocol()}{protocol()}} -{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::protocol (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}} +{\footnotesize\ttfamily void core\+::\+TCPSession\+::protocol (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}} Override the protocol method to manage and control the session communications in your inherited session. If you do not override this method then the Session default will process the \textquotesingle{}commands\textquotesingle{} added to the server object using the process\+Request method on the session input. -When data is received within the session two modes are available to pass the data through the protocol method\+: L\+I\+NE or B\+L\+O\+CK. +When data is received within the session two modes are available to pass the data through the protocol method\+: LINE or BLOCK. -Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a208145cc1fcdc14054602aacc2c51d91}{core\+::\+T\+L\+S\+Session}}, and \mbox{\hyperlink{classcore_1_1ConsoleSession_aa1818efcd33a4152d2089aa545f08833}{core\+::\+Console\+Session}}. +Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a208145cc1fcdc14054602aacc2c51d91}{core\+::\+TLSSession}}, and \mbox{\hyperlink{classcore_1_1ConsoleSession_aa1818efcd33a4152d2089aa545f08833}{core\+::\+Console\+Session}}. \mbox{\Hypertarget{classcore_1_1TCPSession_a2b09eeafef5e44009a77d9da43e3b889}\label{classcore_1_1TCPSession_a2b09eeafef5e44009a77d9da43e3b889}} \index{core::TCPSession@{core::TCPSession}!send@{send}} \index{send@{send}!core::TCPSession@{core::TCPSession}} \doxysubsubsection{\texorpdfstring{send()}{send()}} -{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::send (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} +{\footnotesize\ttfamily void core\+::\+TCPSession\+::send (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} The send method is used to output the contents of the out stream to the session containing the stream. \mbox{\Hypertarget{classcore_1_1TCPSession_a836fb3fd5ee543ebc93262a980ae88b5}\label{classcore_1_1TCPSession_a836fb3fd5ee543ebc93262a980ae88b5}} \index{core::TCPSession@{core::TCPSession}!setBlockSize@{setBlockSize}} \index{setBlockSize@{setBlockSize}!core::TCPSession@{core::TCPSession}} \doxysubsubsection{\texorpdfstring{setBlockSize()}{setBlockSize()}} -{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::set\+Block\+Size (\begin{DoxyParamCaption}\item[{int}]{size = {\ttfamily 0} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}} +{\footnotesize\ttfamily void core\+::\+TCPSession\+::set\+Block\+Size (\begin{DoxyParamCaption}\item[{int}]{size = {\ttfamily 0} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}} Use set\+Block\+Size to set the amount of data that should be read at once from the session data buffer. If this value is set to 0 then the data will be retrieved \mbox{\Hypertarget{classcore_1_1TCPSession_a34936745e8d7669d5400e78d353a56d3}\label{classcore_1_1TCPSession_a34936745e8d7669d5400e78d353a56d3}} \index{core::TCPSession@{core::TCPSession}!terminate@{terminate}} \index{terminate@{terminate}!core::TCPSession@{core::TCPSession}} \doxysubsubsection{\texorpdfstring{terminate()}{terminate()}} -{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::terminate (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} +{\footnotesize\ttfamily void core\+::\+TCPSession\+::terminate (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} -Use this method to terminate this \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}}. +Use this method to terminate this \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}}. \doxysubsection{Member Data Documentation} \mbox{\Hypertarget{classcore_1_1TCPSession_abb302bbb3d7e7bc75490c736364f0d4d}\label{classcore_1_1TCPSession_abb302bbb3d7e7bc75490c736364f0d4d}} \index{core::TCPSession@{core::TCPSession}!out@{out}} \index{out@{out}!core::TCPSession@{core::TCPSession}} \doxysubsubsection{\texorpdfstring{out}{out}} -{\footnotesize\ttfamily std\+::stringstream core\+::\+T\+C\+P\+Session\+::out} +{\footnotesize\ttfamily std\+::stringstream core\+::\+TCPSession\+::out} Use out to send data to the session socket or other session sockets. The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} \item -T\+C\+P\+Session.\+h\item -T\+C\+P\+Session.\+cpp\end{DoxyCompactItemize} +TCPSession.\+h\item +TCPSession.\+cpp\end{DoxyCompactItemize} diff --git a/latex/classcore_1_1TCPSession__coll__graph.md5 b/latex/classcore_1_1TCPSession__coll__graph.md5 index aca7b5d..a022454 100644 --- a/latex/classcore_1_1TCPSession__coll__graph.md5 +++ b/latex/classcore_1_1TCPSession__coll__graph.md5 @@ -1 +1 @@ -f3d3860698dff70bd5955f0fbd35ea6d \ No newline at end of file +3b790dd1292cdd59467f33301651c136 \ No newline at end of file diff --git a/latex/classcore_1_1TCPSession__coll__graph.pdf b/latex/classcore_1_1TCPSession__coll__graph.pdf index 6bdfcef..326a39f 100644 Binary files a/latex/classcore_1_1TCPSession__coll__graph.pdf and b/latex/classcore_1_1TCPSession__coll__graph.pdf differ diff --git a/latex/classcore_1_1TCPSession__inherit__graph.md5 b/latex/classcore_1_1TCPSession__inherit__graph.md5 index 24b6da6..fc624b8 100644 --- a/latex/classcore_1_1TCPSession__inherit__graph.md5 +++ b/latex/classcore_1_1TCPSession__inherit__graph.md5 @@ -1 +1 @@ -91ad32f695f6c4292b387bb70491673d \ No newline at end of file +01b803dfb26ef948867565d97c1cc8c4 \ No newline at end of file diff --git a/latex/classcore_1_1TCPSession__inherit__graph.pdf b/latex/classcore_1_1TCPSession__inherit__graph.pdf index 0afa7c1..68fd7f4 100644 Binary files a/latex/classcore_1_1TCPSession__inherit__graph.pdf and b/latex/classcore_1_1TCPSession__inherit__graph.pdf differ diff --git a/latex/classcore_1_1TCPSocket.tex b/latex/classcore_1_1TCPSocket.tex index 36fe96a..50993f4 100644 --- a/latex/classcore_1_1TCPSocket.tex +++ b/latex/classcore_1_1TCPSocket.tex @@ -1,12 +1,13 @@ -\hypertarget{classcore_1_1TCPSocket}{}\doxysection{core\+::T\+C\+P\+Socket Class Reference} +\hypertarget{classcore_1_1TCPSocket}{}\doxysection{core\+::TCPSocket Class Reference} \label{classcore_1_1TCPSocket}\index{core::TCPSocket@{core::TCPSocket}} -{\ttfamily \#include $<$T\+C\+P\+Socket.\+h$>$} +{\ttfamily \#include $<$TCPSocket.\+h$>$} -Inheritance diagram for core\+::T\+C\+P\+Socket\+:\nopagebreak +Inheritance diagram for core\+::TCPSocket\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -15,7 +16,7 @@ Inheritance diagram for core\+::T\+C\+P\+Socket\+:\nopagebreak \end{figure} -Collaboration diagram for core\+::T\+C\+P\+Socket\+:\nopagebreak +Collaboration diagram for core\+::TCPSocket\+:\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -26,13 +27,13 @@ Collaboration diagram for core\+::T\+C\+P\+Socket\+:\nopagebreak \begin{DoxyCompactItemize} \item \mbox{\Hypertarget{classcore_1_1TCPSocket_a09089f0bc701edcf6c148958fd29d374}\label{classcore_1_1TCPSocket_a09089f0bc701edcf6c148958fd29d374}} -{\bfseries T\+C\+P\+Socket} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll) +{\bfseries TCPSocket} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll) \item \mbox{\Hypertarget{classcore_1_1TCPSocket_aa7ffbbd17827ffe769684fa8345862d6}\label{classcore_1_1TCPSocket_aa7ffbbd17827ffe769684fa8345862d6}} -{\bfseries T\+C\+P\+Socket} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, std\+::string text) +{\bfseries TCPSocket} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, std\+::string text) \item \mbox{\Hypertarget{classcore_1_1TCPSocket_a22dae8f5b7989d206fab918297e0df94}\label{classcore_1_1TCPSocket_a22dae8f5b7989d206fab918297e0df94}} -void {\bfseries connect} (\mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}} \&address) +void {\bfseries connect} (\mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}} \&address) \item virtual void \mbox{\hyperlink{classcore_1_1TCPSocket_afacf7528ff3c9ac077d7b5a49e2116fd}{output}} (std\+::stringstream \&out) \end{DoxyCompactItemize} @@ -40,32 +41,32 @@ virtual void \mbox{\hyperlink{classcore_1_1TCPSocket_afacf7528ff3c9ac077d7b5a49e \begin{DoxyCompactItemize} \item \mbox{\Hypertarget{classcore_1_1TCPSocket_abe7d0a740dc0c19c058661270a6fb630}\label{classcore_1_1TCPSocket_abe7d0a740dc0c19c058661270a6fb630}} -\mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}} {\bfseries ip\+Address} +\mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}} {\bfseries ip\+Address} \end{DoxyCompactItemize} \doxysubsection*{Additional Inherited Members} \doxysubsection{Detailed Description} -\mbox{\hyperlink{classcore_1_1TCPSocket}{T\+C\+P\+Socket}} +\mbox{\hyperlink{classcore_1_1TCPSocket}{TCPSocket}} -Provides a network T\+CP socket. +Provides a network TCP socket. -For accessing T\+CP network functions use this object. The connection oriented nature of T\+CP provides a single client persistent connection with data error correction and a durable synchronous data connection. +For accessing TCP network functions use this object. The connection oriented nature of TCP provides a single client persistent connection with data error correction and a durable synchronous data connection. \doxysubsection{Member Function Documentation} \mbox{\Hypertarget{classcore_1_1TCPSocket_afacf7528ff3c9ac077d7b5a49e2116fd}\label{classcore_1_1TCPSocket_afacf7528ff3c9ac077d7b5a49e2116fd}} \index{core::TCPSocket@{core::TCPSocket}!output@{output}} \index{output@{output}!core::TCPSocket@{core::TCPSocket}} \doxysubsubsection{\texorpdfstring{output()}{output()}} -{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Socket\+::output (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} +{\footnotesize\ttfamily void core\+::\+TCPSocket\+::output (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} -The output method is called by a socket session (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}}) and will output the detail information for the client socket. When extending B\+M\+A\+T\+C\+P\+Socket or B\+M\+A\+Session you can override the method to add attributes to the list. +The output method is called by a socket session (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}}) and will output the detail information for the client socket. When extending BMATCPSocket or BMASession you can override the method to add attributes to the list. -Reimplemented in \mbox{\hyperlink{classcore_1_1TCPServer_a49e3ead1bf4e7830685780e73c4db5db}{core\+::\+T\+C\+P\+Server}}, \mbox{\hyperlink{classcore_1_1TLSSession_ae55de8a035d1ddc560cf619b2030af43}{core\+::\+T\+L\+S\+Session}}, and \mbox{\hyperlink{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}{core\+::\+T\+C\+P\+Session}}. +Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_ae55de8a035d1ddc560cf619b2030af43}{core\+::\+TLSSession}}, \mbox{\hyperlink{classcore_1_1TCPServer_a49e3ead1bf4e7830685780e73c4db5db}{core\+::\+TCPServer}}, and \mbox{\hyperlink{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}{core\+::\+TCPSession}}. The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} \item -T\+C\+P\+Socket.\+h\item -T\+C\+P\+Socket.\+cpp\end{DoxyCompactItemize} +TCPSocket.\+h\item +TCPSocket.\+cpp\end{DoxyCompactItemize} diff --git a/latex/classcore_1_1TCPSocket__inherit__graph.md5 b/latex/classcore_1_1TCPSocket__inherit__graph.md5 index 8aa947c..9478047 100644 --- a/latex/classcore_1_1TCPSocket__inherit__graph.md5 +++ b/latex/classcore_1_1TCPSocket__inherit__graph.md5 @@ -1 +1 @@ -2c35632b80d53d66f35deaed94cc2c7e \ No newline at end of file +5cc14ce538486df71a602b5b618d16e5 \ No newline at end of file diff --git a/latex/classcore_1_1TCPSocket__inherit__graph.pdf b/latex/classcore_1_1TCPSocket__inherit__graph.pdf index 4f32c9a..b0a306c 100644 Binary files a/latex/classcore_1_1TCPSocket__inherit__graph.pdf and b/latex/classcore_1_1TCPSocket__inherit__graph.pdf differ diff --git a/latex/classcore_1_1TLSServer.tex b/latex/classcore_1_1TLSServer.tex index 791e8f0..dbb68c5 100644 --- a/latex/classcore_1_1TLSServer.tex +++ b/latex/classcore_1_1TLSServer.tex @@ -1,12 +1,12 @@ -\hypertarget{classcore_1_1TLSServer}{}\doxysection{core\+::T\+L\+S\+Server Class Reference} +\hypertarget{classcore_1_1TLSServer}{}\doxysection{core\+::TLSServer Class Reference} \label{classcore_1_1TLSServer}\index{core::TLSServer@{core::TLSServer}} -{\ttfamily \#include $<$T\+L\+S\+Server.\+h$>$} +{\ttfamily \#include $<$TLSServer.\+h$>$} -Inheritance diagram for core\+::T\+L\+S\+Server\+:\nopagebreak +Inheritance diagram for core\+::TLSServer\+:\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -15,7 +15,8 @@ Inheritance diagram for core\+::T\+L\+S\+Server\+:\nopagebreak \end{figure} -Collaboration diagram for core\+::T\+L\+S\+Server\+:\nopagebreak +Collaboration diagram for core\+::TLSServer\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -25,39 +26,39 @@ Collaboration diagram for core\+::T\+L\+S\+Server\+:\nopagebreak \doxysubsection*{Public Member Functions} \begin{DoxyCompactItemize} \item -\mbox{\hyperlink{classcore_1_1TLSServer_a6460f9872936015efdfd0b8de04aa2fe}{T\+L\+S\+Server}} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}} address) +\mbox{\hyperlink{classcore_1_1TLSServer_a6460f9872936015efdfd0b8de04aa2fe}{TLSServer}} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}} address) \item -\mbox{\hyperlink{classcore_1_1TLSServer_ac71db77c796a1bf65357409cb96054c7}{$\sim$\+T\+L\+S\+Server}} () +\mbox{\hyperlink{classcore_1_1TLSServer_ac71db77c796a1bf65357409cb96054c7}{$\sim$\+TLSServer}} () \item \mbox{\Hypertarget{classcore_1_1TLSServer_a984dfd9faaa792e29f905e860d2e4a9e}\label{classcore_1_1TLSServer_a984dfd9faaa792e29f905e860d2e4a9e}} -\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$ {\bfseries get\+Socket\+Accept} () +\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$ {\bfseries get\+Socket\+Accept} () \end{DoxyCompactItemize} \doxysubsection*{Public Attributes} \begin{DoxyCompactItemize} \item \mbox{\Hypertarget{classcore_1_1TLSServer_ab4e788350bda508fa44604d146e7537f}\label{classcore_1_1TLSServer_ab4e788350bda508fa44604d146e7537f}} -S\+S\+L\+\_\+\+C\+TX $\ast$ {\bfseries ctx} +SSL\+\_\+\+CTX $\ast$ {\bfseries ctx} \end{DoxyCompactItemize} \doxysubsection*{Additional Inherited Members} \doxysubsection{Detailed Description} -\mbox{\hyperlink{classcore_1_1TLSServer}{T\+L\+S\+Server}} +\mbox{\hyperlink{classcore_1_1TLSServer}{TLSServer}} -Manage a socket connection as a T\+LS server type. Connections to the socket are processed through the accept functionality. +Manage a socket connection as a TLS server type. Connections to the socket are processed through the accept functionality. \doxysubsection{Constructor \& Destructor Documentation} \mbox{\Hypertarget{classcore_1_1TLSServer_a6460f9872936015efdfd0b8de04aa2fe}\label{classcore_1_1TLSServer_a6460f9872936015efdfd0b8de04aa2fe}} \index{core::TLSServer@{core::TLSServer}!TLSServer@{TLSServer}} \index{TLSServer@{TLSServer}!core::TLSServer@{core::TLSServer}} \doxysubsubsection{\texorpdfstring{TLSServer()}{TLSServer()}} -{\footnotesize\ttfamily core\+::\+T\+L\+S\+Server\+::\+T\+L\+S\+Server (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&}]{e\+Poll, }\item[{\mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}}}]{address }\end{DoxyParamCaption})} +{\footnotesize\ttfamily core\+::\+TLSServer\+::\+TLSServer (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&}]{e\+Poll, }\item[{\mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}}}]{address }\end{DoxyParamCaption})} The constructor. \begin{DoxyParams}{Parameters} -{\em e\+Poll} & the B\+M\+A\+E\+Poll instance that manages the socket. \\ +{\em e\+Poll} & the BMAEPoll instance that manages the socket. \\ \hline {\em url} & the IP address for the socket to receive connection requests. \\ \hline @@ -67,17 +68,17 @@ The constructor. \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} -the instance of the B\+M\+A\+T\+L\+S\+Server\+Socket. +the instance of the BMATLSServer\+Socket. \end{DoxyReturn} \mbox{\Hypertarget{classcore_1_1TLSServer_ac71db77c796a1bf65357409cb96054c7}\label{classcore_1_1TLSServer_ac71db77c796a1bf65357409cb96054c7}} \index{core::TLSServer@{core::TLSServer}!````~TLSServer@{$\sim$TLSServer}} \index{````~TLSServer@{$\sim$TLSServer}!core::TLSServer@{core::TLSServer}} \doxysubsubsection{\texorpdfstring{$\sim$TLSServer()}{~TLSServer()}} -{\footnotesize\ttfamily core\+::\+T\+L\+S\+Server\+::$\sim$\+T\+L\+S\+Server (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} +{\footnotesize\ttfamily core\+::\+TLSServer\+::$\sim$\+TLSServer (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} The destructor for this object. The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} \item -T\+L\+S\+Server.\+h\item -T\+L\+S\+Server.\+cpp\end{DoxyCompactItemize} +TLSServer.\+h\item +TLSServer.\+cpp\end{DoxyCompactItemize} diff --git a/latex/classcore_1_1TLSServer__coll__graph.md5 b/latex/classcore_1_1TLSServer__coll__graph.md5 index 09cdcd8..84562fe 100644 --- a/latex/classcore_1_1TLSServer__coll__graph.md5 +++ b/latex/classcore_1_1TLSServer__coll__graph.md5 @@ -1 +1 @@ -e96a05dd0a826020326f33fbd922b00e \ No newline at end of file +f3c936336841423916e1884cda6e5405 \ No newline at end of file diff --git a/latex/classcore_1_1TLSServer__coll__graph.pdf b/latex/classcore_1_1TLSServer__coll__graph.pdf index 0c69083..5aa9f54 100644 Binary files a/latex/classcore_1_1TLSServer__coll__graph.pdf and b/latex/classcore_1_1TLSServer__coll__graph.pdf differ diff --git a/latex/classcore_1_1TLSSession.tex b/latex/classcore_1_1TLSSession.tex index 00585d4..be530e4 100644 --- a/latex/classcore_1_1TLSSession.tex +++ b/latex/classcore_1_1TLSSession.tex @@ -1,12 +1,12 @@ -\hypertarget{classcore_1_1TLSSession}{}\doxysection{core\+::T\+L\+S\+Session Class Reference} +\hypertarget{classcore_1_1TLSSession}{}\doxysection{core\+::TLSSession Class Reference} \label{classcore_1_1TLSSession}\index{core::TLSSession@{core::TLSSession}} -{\ttfamily \#include $<$T\+L\+S\+Session.\+h$>$} +{\ttfamily \#include $<$TLSSession.\+h$>$} -Inheritance diagram for core\+::T\+L\+S\+Session\+:\nopagebreak +Inheritance diagram for core\+::TLSSession\+:\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -15,7 +15,8 @@ Inheritance diagram for core\+::T\+L\+S\+Session\+:\nopagebreak \end{figure} -Collaboration diagram for core\+::T\+L\+S\+Session\+:\nopagebreak +Collaboration diagram for core\+::TLSSession\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -26,16 +27,16 @@ Collaboration diagram for core\+::T\+L\+S\+Session\+:\nopagebreak \begin{DoxyCompactItemize} \item \mbox{\Hypertarget{classcore_1_1TLSSession_ac2bd48a18a46a3b6827cd689775e3552}\label{classcore_1_1TLSSession_ac2bd48a18a46a3b6827cd689775e3552}} -{\bfseries T\+L\+S\+Session} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1TCPServer}{T\+C\+P\+Server}} \&server) +{\bfseries TLSSession} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1TCPServer}{TCPServer}} \&server) \item virtual void \mbox{\hyperlink{classcore_1_1TLSSession_ae55de8a035d1ddc560cf619b2030af43}{output}} (std\+::stringstream \&\mbox{\hyperlink{classcore_1_1TCPSession_abb302bbb3d7e7bc75490c736364f0d4d}{out}}) \item -virtual void \mbox{\hyperlink{classcore_1_1TLSSession_a208145cc1fcdc14054602aacc2c51d91}{protocol}} (coreutils\+::\+Z\+String \&data) override +virtual void \mbox{\hyperlink{classcore_1_1TLSSession_a208145cc1fcdc14054602aacc2c51d91}{protocol}} (coreutils\+::\+ZString \&data) override \end{DoxyCompactItemize} \doxysubsection*{Protected Member Functions} \begin{DoxyCompactItemize} \item -void \mbox{\hyperlink{classcore_1_1TLSSession_a8507cdcd23ac4b340ce6f6d5f0b26a52}{receive\+Data}} (coreutils\+::\+Z\+String \&buffer) override +void \mbox{\hyperlink{classcore_1_1TLSSession_a8507cdcd23ac4b340ce6f6d5f0b26a52}{receive\+Data}} (coreutils\+::\+ZString \&buffer) override \item void \mbox{\hyperlink{classcore_1_1TLSSession_a76cec7cf4851eb27abe77a2339344c6d}{on\+Register}} () \begin{DoxyCompactList}\small\item\em Called before the socket has registered with the epoll processing. \end{DoxyCompactList}\item @@ -46,18 +47,18 @@ void \mbox{\hyperlink{classcore_1_1TLSSession_a8e26fdc9e8a6c573b5a504a1f1b137a9} \doxysubsection{Detailed Description} -\mbox{\hyperlink{classcore_1_1TLSSession}{T\+L\+S\+Session}} +\mbox{\hyperlink{classcore_1_1TLSSession}{TLSSession}} -Provides a network T\+LS socket. +Provides a network TLS socket. -For accessing T\+LS network functions use this object. The connection oriented nature of T\+LS provides a single client persistent connection with data error correction and a durable synchronous data connection. +For accessing TLS network functions use this object. The connection oriented nature of TLS provides a single client persistent connection with data error correction and a durable synchronous data connection. \doxysubsection{Member Function Documentation} \mbox{\Hypertarget{classcore_1_1TLSSession_a76cec7cf4851eb27abe77a2339344c6d}\label{classcore_1_1TLSSession_a76cec7cf4851eb27abe77a2339344c6d}} \index{core::TLSSession@{core::TLSSession}!onRegister@{onRegister}} \index{onRegister@{onRegister}!core::TLSSession@{core::TLSSession}} \doxysubsubsection{\texorpdfstring{onRegister()}{onRegister()}} -{\footnotesize\ttfamily void core\+::\+T\+L\+S\+Session\+::on\+Register (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}} +{\footnotesize\ttfamily void core\+::\+TLSSession\+::on\+Register (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}} @@ -71,31 +72,31 @@ Reimplemented from \mbox{\hyperlink{classcore_1_1Socket_a81e5ee3e17834166d97c6e8 \index{core::TLSSession@{core::TLSSession}!output@{output}} \index{output@{output}!core::TLSSession@{core::TLSSession}} \doxysubsubsection{\texorpdfstring{output()}{output()}} -{\footnotesize\ttfamily void core\+::\+T\+L\+S\+Session\+::output (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} +{\footnotesize\ttfamily void core\+::\+TLSSession\+::output (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} -The output method is called by a socket session (Session) and will output the detail information for the client socket. When extending T\+L\+S\+Socket or Session you can override the method to add attributes to the list. +The output method is called by a socket session (Session) and will output the detail information for the client socket. When extending TLSSocket or Session you can override the method to add attributes to the list. -Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}{core\+::\+T\+C\+P\+Session}}. +Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}{core\+::\+TCPSession}}. \mbox{\Hypertarget{classcore_1_1TLSSession_a208145cc1fcdc14054602aacc2c51d91}\label{classcore_1_1TLSSession_a208145cc1fcdc14054602aacc2c51d91}} \index{core::TLSSession@{core::TLSSession}!protocol@{protocol}} \index{protocol@{protocol}!core::TLSSession@{core::TLSSession}} \doxysubsubsection{\texorpdfstring{protocol()}{protocol()}} -{\footnotesize\ttfamily void core\+::\+T\+L\+S\+Session\+::protocol (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}} +{\footnotesize\ttfamily void core\+::\+TLSSession\+::protocol (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}} Override the protocol method to manage and control the session communications in your inherited session. If you do not override this method then the Session default will process the \textquotesingle{}commands\textquotesingle{} added to the server object using the process\+Request method on the session input. -When data is received within the session two modes are available to pass the data through the protocol method\+: L\+I\+NE or B\+L\+O\+CK. +When data is received within the session two modes are available to pass the data through the protocol method\+: LINE or BLOCK. -Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_a98a65da2346b79bee659fca6902e94c7}{core\+::\+T\+C\+P\+Session}}. +Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_a98a65da2346b79bee659fca6902e94c7}{core\+::\+TCPSession}}. \mbox{\Hypertarget{classcore_1_1TLSSession_a8507cdcd23ac4b340ce6f6d5f0b26a52}\label{classcore_1_1TLSSession_a8507cdcd23ac4b340ce6f6d5f0b26a52}} \index{core::TLSSession@{core::TLSSession}!receiveData@{receiveData}} \index{receiveData@{receiveData}!core::TLSSession@{core::TLSSession}} \doxysubsubsection{\texorpdfstring{receiveData()}{receiveData()}} -{\footnotesize\ttfamily void core\+::\+T\+L\+S\+Session\+::receive\+Data (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{buffer }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}} +{\footnotesize\ttfamily void core\+::\+TLSSession\+::receive\+Data (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{buffer }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}} -receive\+Data will read the data from the socket and place it in the socket buffer. T\+LS layer overrides this to be able to read from S\+SL. +receive\+Data will read the data from the socket and place it in the socket buffer. TLS layer overrides this to be able to read from SSL. Reimplemented from \mbox{\hyperlink{classcore_1_1Socket_a46ed2e240852d3fa949979ebbc4ac875}{core\+::\+Socket}}. @@ -103,5 +104,5 @@ Reimplemented from \mbox{\hyperlink{classcore_1_1Socket_a46ed2e240852d3fa949979e The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} \item -T\+L\+S\+Session.\+h\item -T\+L\+S\+Session.\+cpp\end{DoxyCompactItemize} +TLSSession.\+h\item +TLSSession.\+cpp\end{DoxyCompactItemize} diff --git a/latex/classcore_1_1TLSSession__coll__graph.md5 b/latex/classcore_1_1TLSSession__coll__graph.md5 index ea95fd1..78e7281 100644 --- a/latex/classcore_1_1TLSSession__coll__graph.md5 +++ b/latex/classcore_1_1TLSSession__coll__graph.md5 @@ -1 +1 @@ -cc9f449868650fe7138b6b9b091dc80a \ No newline at end of file +5fc9a5f70f8f3528a30212ff7794e169 \ No newline at end of file diff --git a/latex/classcore_1_1TLSSession__coll__graph.pdf b/latex/classcore_1_1TLSSession__coll__graph.pdf index 065e6c3..bc31ece 100644 Binary files a/latex/classcore_1_1TLSSession__coll__graph.pdf and b/latex/classcore_1_1TLSSession__coll__graph.pdf differ diff --git a/latex/classcore_1_1TerminalSession.tex b/latex/classcore_1_1TerminalSession.tex index 008b7f5..59ab457 100644 --- a/latex/classcore_1_1TerminalSession.tex +++ b/latex/classcore_1_1TerminalSession.tex @@ -11,7 +11,8 @@ Inheritance diagram for core\+::Terminal\+Session\+:\nopagebreak \end{figure} -Collaboration diagram for core\+::Terminal\+Session\+:\nopagebreak +Collaboration diagram for core\+::Terminal\+Session\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -22,14 +23,14 @@ Collaboration diagram for core\+::Terminal\+Session\+:\nopagebreak \begin{DoxyCompactItemize} \item \mbox{\Hypertarget{classcore_1_1TerminalSession_a6773b1897d2e417ab573b28fa127230c}\label{classcore_1_1TerminalSession_a6773b1897d2e417ab573b28fa127230c}} -{\bfseries Terminal\+Session} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1TCPServer}{T\+C\+P\+Server}} \&server) +{\bfseries Terminal\+Session} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1TCPServer}{TCPServer}} \&server) \item \mbox{\Hypertarget{classcore_1_1TerminalSession_a0df0106164a7f213acf2e814e725c576}\label{classcore_1_1TerminalSession_a0df0106164a7f213acf2e814e725c576}} int {\bfseries get\+Lines} () \item void \mbox{\hyperlink{classcore_1_1TerminalSession_a42bb06857891220a831da04248233935}{clear}} () \item -void \mbox{\hyperlink{classcore_1_1TerminalSession_aa660768eed03b0b996a749e8a146446c}{clear\+E\+OL}} () +void \mbox{\hyperlink{classcore_1_1TerminalSession_aa660768eed03b0b996a749e8a146446c}{clear\+EOL}} () \item void \mbox{\hyperlink{classcore_1_1TerminalSession_aa9939cbe36c08e1a0b8413a96ca251fa}{set\+Cursor\+Location}} (int x, int y) \item @@ -68,7 +69,7 @@ Clear the display. \mbox{\Hypertarget{classcore_1_1TerminalSession_aa660768eed03 \index{core::TerminalSession@{core::TerminalSession}!clearEOL@{clearEOL}} \index{clearEOL@{clearEOL}!core::TerminalSession@{core::TerminalSession}} \doxysubsubsection{\texorpdfstring{clearEOL()}{clearEOL()}} -{\footnotesize\ttfamily void core\+::\+Terminal\+Session\+::clear\+E\+OL (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} +{\footnotesize\ttfamily void core\+::\+Terminal\+Session\+::clear\+EOL (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} Clear the display from the cursor to the end of line. \mbox{\Hypertarget{classcore_1_1TerminalSession_aa9939cbe36c08e1a0b8413a96ca251fa}\label{classcore_1_1TerminalSession_aa9939cbe36c08e1a0b8413a96ca251fa}} \index{core::TerminalSession@{core::TerminalSession}!setCursorLocation@{setCursorLocation}} diff --git a/latex/classcore_1_1TerminalSession__coll__graph.md5 b/latex/classcore_1_1TerminalSession__coll__graph.md5 index 9a0cbc1..d79d57b 100644 --- a/latex/classcore_1_1TerminalSession__coll__graph.md5 +++ b/latex/classcore_1_1TerminalSession__coll__graph.md5 @@ -1 +1 @@ -44e3860ca5ea088dcdbc253a2d4546a7 \ No newline at end of file +17d88516083d283b6b2b71a206782d19 \ No newline at end of file diff --git a/latex/classcore_1_1TerminalSession__coll__graph.pdf b/latex/classcore_1_1TerminalSession__coll__graph.pdf index c939160..e376f56 100644 Binary files a/latex/classcore_1_1TerminalSession__coll__graph.pdf and b/latex/classcore_1_1TerminalSession__coll__graph.pdf differ diff --git a/latex/classcore_1_1Thread.tex b/latex/classcore_1_1Thread.tex index 1b87953..0abdb62 100644 --- a/latex/classcore_1_1Thread.tex +++ b/latex/classcore_1_1Thread.tex @@ -26,10 +26,10 @@ Collaboration diagram for core\+::Thread\+:\nopagebreak \begin{DoxyCompactItemize} \item \mbox{\Hypertarget{classcore_1_1Thread_acf8e7e682431fa6a4a3a77ce9b33aefc}\label{classcore_1_1Thread_acf8e7e682431fa6a4a3a77ce9b33aefc}} -{\bfseries Thread} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll) +{\bfseries Thread} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll) \item \mbox{\Hypertarget{classcore_1_1Thread_a88638bbc82ac8d05fc4400db90a89451}\label{classcore_1_1Thread_a88638bbc82ac8d05fc4400db90a89451}} -{\bfseries Thread} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1ThreadScope}{Thread\+Scope}} $\ast$thread) +{\bfseries Thread} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1ThreadScope}{Thread\+Scope}} $\ast$thread) \item void \mbox{\hyperlink{classcore_1_1Thread_ae6885df9a9b9503669e5776518b19054}{start}} () \item @@ -54,7 +54,7 @@ void {\bfseries output} (std\+::stringstream \&data) \doxysubsection{Detailed Description} \mbox{\hyperlink{classcore_1_1Thread}{Thread}} -This thread object is designed to be the thread processor for the \mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} object. It wraps the thread object to allow maintaining a status value for monitoring the thread activity. \mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} will instantiate a \mbox{\hyperlink{classcore_1_1Thread}{Thread}} object for each thread specified in the \mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}}\textquotesingle{}s start method. +This thread object is designed to be the thread processor for the \mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} object. It wraps the thread object to allow maintaining a status value for monitoring the thread activity. \mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} will instantiate a \mbox{\hyperlink{classcore_1_1Thread}{Thread}} object for each thread specified in the \mbox{\hyperlink{classcore_1_1EPoll}{EPoll}}\textquotesingle{}s start method. \doxysubsection{Member Function Documentation} \mbox{\Hypertarget{classcore_1_1Thread_ae6885df9a9b9503669e5776518b19054}\label{classcore_1_1Thread_ae6885df9a9b9503669e5776518b19054}} diff --git a/latex/classcore_1_1Timer.tex b/latex/classcore_1_1Timer.tex index 325e0c7..3126db9 100644 --- a/latex/classcore_1_1Timer.tex +++ b/latex/classcore_1_1Timer.tex @@ -26,10 +26,10 @@ Collaboration diagram for core\+::Timer\+:\nopagebreak \begin{DoxyCompactItemize} \item \mbox{\Hypertarget{classcore_1_1Timer_aa12f319bab9c7a350244c4d47fe59de9}\label{classcore_1_1Timer_aa12f319bab9c7a350244c4d47fe59de9}} -{\bfseries Timer} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll) +{\bfseries Timer} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll) \item \mbox{\Hypertarget{classcore_1_1Timer_a6ba8de81f8e3b26fd132e29230646024}\label{classcore_1_1Timer_a6ba8de81f8e3b26fd132e29230646024}} -{\bfseries Timer} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, double delay) +{\bfseries Timer} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, double delay) \item void \mbox{\hyperlink{classcore_1_1Timer_ac0a642cdcb76b7f995137162050d3d0b}{set\+Timer}} (double delay) \item diff --git a/latex/classcore_1_1UDPServerSocket.tex b/latex/classcore_1_1UDPServerSocket.tex index d6263a2..039ecb6 100644 --- a/latex/classcore_1_1UDPServerSocket.tex +++ b/latex/classcore_1_1UDPServerSocket.tex @@ -1,12 +1,12 @@ -\hypertarget{classcore_1_1UDPServerSocket}{}\doxysection{core\+::U\+D\+P\+Server\+Socket Class Reference} +\hypertarget{classcore_1_1UDPServerSocket}{}\doxysection{core\+::UDPServer\+Socket Class Reference} \label{classcore_1_1UDPServerSocket}\index{core::UDPServerSocket@{core::UDPServerSocket}} -{\ttfamily \#include $<$U\+D\+P\+Server\+Socket.\+h$>$} +{\ttfamily \#include $<$UDPServer\+Socket.\+h$>$} -Inheritance diagram for core\+::U\+D\+P\+Server\+Socket\+:\nopagebreak +Inheritance diagram for core\+::UDPServer\+Socket\+:\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -15,7 +15,7 @@ Inheritance diagram for core\+::U\+D\+P\+Server\+Socket\+:\nopagebreak \end{figure} -Collaboration diagram for core\+::U\+D\+P\+Server\+Socket\+:\nopagebreak +Collaboration diagram for core\+::UDPServer\+Socket\+:\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -26,7 +26,7 @@ Collaboration diagram for core\+::U\+D\+P\+Server\+Socket\+:\nopagebreak \begin{DoxyCompactItemize} \item \mbox{\Hypertarget{classcore_1_1UDPServerSocket_a6fee7bc6dc2f94d48734c07cbc918734}\label{classcore_1_1UDPServerSocket_a6fee7bc6dc2f94d48734c07cbc918734}} -{\bfseries U\+D\+P\+Server\+Socket} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, std\+::string url, short int port, std\+::string command\+Name) +{\bfseries UDPServer\+Socket} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, std\+::string url, short int port, std\+::string command\+Name) \end{DoxyCompactItemize} \doxysubsection*{Protected Member Functions} \begin{DoxyCompactItemize} @@ -46,22 +46,22 @@ std\+::vector$<$ Session $\ast$ $>$ {\bfseries sessions} \doxysubsection{Detailed Description} -\mbox{\hyperlink{classcore_1_1UDPSocket}{U\+D\+P\+Socket}} +\mbox{\hyperlink{classcore_1_1UDPSocket}{UDPSocket}} -Manage a socket connection as a U\+DP server type. Connections to the socket are processed through the session list functionality. A list of sessions is maintained in a vector object. +Manage a socket connection as a UDP server type. Connections to the socket are processed through the session list functionality. A list of sessions is maintained in a vector object. \doxysubsection{Member Function Documentation} \mbox{\Hypertarget{classcore_1_1UDPServerSocket_a41933ca153c854a800e3d047ab18313e}\label{classcore_1_1UDPServerSocket_a41933ca153c854a800e3d047ab18313e}} \index{core::UDPServerSocket@{core::UDPServerSocket}!onDataReceived@{onDataReceived}} \index{onDataReceived@{onDataReceived}!core::UDPServerSocket@{core::UDPServerSocket}} \doxysubsubsection{\texorpdfstring{onDataReceived()}{onDataReceived()}} -{\footnotesize\ttfamily void core\+::\+U\+D\+P\+Server\+Socket\+::on\+Data\+Received (\begin{DoxyParamCaption}\item[{std\+::string}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}} +{\footnotesize\ttfamily void core\+::\+UDPServer\+Socket\+::on\+Data\+Received (\begin{DoxyParamCaption}\item[{std\+::string}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}} Called when data is received from the socket. -The on\+Connected method is called when the socket is ready to communicate. Writing to the socket can begin on this call to initiate a contact with the remote device. The on\+Data\+Received method is called when the socket has received an event from epoll and there is data ready to be read from the socket. The default handler will pull the data and put it into the streambuf for the socket. E\+P\+O\+L\+L\+IN +The on\+Connected method is called when the socket is ready to communicate. Writing to the socket can begin on this call to initiate a contact with the remote device. The on\+Data\+Received method is called when the socket has received an event from epoll and there is data ready to be read from the socket. The default handler will pull the data and put it into the streambuf for the socket. EPOLLIN \begin{DoxyParams}{Parameters} @@ -76,5 +76,5 @@ Reimplemented from \mbox{\hyperlink{classcore_1_1Socket_ac8d6a2c54696eb6fc2024cf The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} \item -U\+D\+P\+Server\+Socket.\+h\item -U\+D\+P\+Server\+Socket.\+cpp\end{DoxyCompactItemize} +UDPServer\+Socket.\+h\item +UDPServer\+Socket.\+cpp\end{DoxyCompactItemize} diff --git a/latex/classcore_1_1UDPSocket.tex b/latex/classcore_1_1UDPSocket.tex index 450dd78..c36c711 100644 --- a/latex/classcore_1_1UDPSocket.tex +++ b/latex/classcore_1_1UDPSocket.tex @@ -1,8 +1,8 @@ -\hypertarget{classcore_1_1UDPSocket}{}\doxysection{core\+::U\+D\+P\+Socket Class Reference} +\hypertarget{classcore_1_1UDPSocket}{}\doxysection{core\+::UDPSocket Class Reference} \label{classcore_1_1UDPSocket}\index{core::UDPSocket@{core::UDPSocket}} -Inheritance diagram for core\+::U\+D\+P\+Socket\+:\nopagebreak +Inheritance diagram for core\+::UDPSocket\+:\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -11,7 +11,7 @@ Inheritance diagram for core\+::U\+D\+P\+Socket\+:\nopagebreak \end{figure} -Collaboration diagram for core\+::U\+D\+P\+Socket\+:\nopagebreak +Collaboration diagram for core\+::UDPSocket\+:\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -22,12 +22,12 @@ Collaboration diagram for core\+::U\+D\+P\+Socket\+:\nopagebreak \begin{DoxyCompactItemize} \item \mbox{\Hypertarget{classcore_1_1UDPSocket_a9dcbe1203fea9c25400a391d3430e976}\label{classcore_1_1UDPSocket_a9dcbe1203fea9c25400a391d3430e976}} -{\bfseries U\+D\+P\+Socket} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll) +{\bfseries UDPSocket} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll) \end{DoxyCompactItemize} \doxysubsection*{Additional Inherited Members} The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} \item -U\+D\+P\+Socket.\+h\item -U\+D\+P\+Socket.\+cpp\end{DoxyCompactItemize} +UDPSocket.\+h\item +UDPSocket.\+cpp\end{DoxyCompactItemize} diff --git a/latex/doxygen.sty b/latex/doxygen.sty index 78a5254..8f59bcc 100644 --- a/latex/doxygen.sty +++ b/latex/doxygen.sty @@ -13,6 +13,7 @@ \RequirePackage{tabu_doxygen} \RequirePackage{fancyvrb} \RequirePackage{tabularx} +\RequirePackage{multicol} \RequirePackage{multirow} \RequirePackage{hanging} \RequirePackage{ifpdf} @@ -186,9 +187,8 @@ % (only if caption is specified) \newenvironment{DoxyImage}{% \begin{figure}[H]% - \begin{center}% + \centering% }{% - \end{center}% \end{figure}% } @@ -571,6 +571,6 @@ % Define caption that is also suitable in a table \makeatletter \def\doxyfigcaption{% -\refstepcounter{figure}% +\H@refstepcounter{figure}% \@dblarg{\@caption{figure}}} \makeatother diff --git a/latex/hierarchy.tex b/latex/hierarchy.tex index 6ccbd33..dd9b309 100644 --- a/latex/hierarchy.tex +++ b/latex/hierarchy.tex @@ -3,44 +3,44 @@ This inheritance list is sorted roughly, but not completely, alphabetically\+:\b \item \contentsline{section}{core\+::Command}{\pageref{classcore_1_1Command}}{} \begin{DoxyCompactList} \item \contentsline{section}{core\+::Command\+List}{\pageref{classcore_1_1CommandList}}{} -\item \contentsline{section}{core\+::E\+Poll}{\pageref{classcore_1_1EPoll}}{} +\item \contentsline{section}{core\+::EPoll}{\pageref{classcore_1_1EPoll}}{} \item \contentsline{section}{core\+::Subscription\+Manager}{\pageref{classcore_1_1SubscriptionManager}}{} -\item \contentsline{section}{core\+::T\+C\+P\+Server}{\pageref{classcore_1_1TCPServer}}{} +\item \contentsline{section}{core\+::TCPServer}{\pageref{classcore_1_1TCPServer}}{} \begin{DoxyCompactList} \item \contentsline{section}{core\+::Console\+Server}{\pageref{classcore_1_1ConsoleServer}}{} -\item \contentsline{section}{core\+::T\+L\+S\+Server}{\pageref{classcore_1_1TLSServer}}{} +\item \contentsline{section}{core\+::TLSServer}{\pageref{classcore_1_1TLSServer}}{} \end{DoxyCompactList} -\item \contentsline{section}{core\+::U\+D\+P\+Server\+Socket}{\pageref{classcore_1_1UDPServerSocket}}{} +\item \contentsline{section}{core\+::UDPServer\+Socket}{\pageref{classcore_1_1UDPServerSocket}}{} \end{DoxyCompactList} -\item \contentsline{section}{core\+::I\+P\+Address\+List}{\pageref{classcore_1_1IPAddressList}}{} -\item Log\+Listener\begin{DoxyCompactList} +\item \contentsline{section}{core\+::IPAddress\+List}{\pageref{classcore_1_1IPAddressList}}{} +\item coreutils\+::Log\+Listener\begin{DoxyCompactList} \item \contentsline{section}{core\+::Console\+Server}{\pageref{classcore_1_1ConsoleServer}}{} \end{DoxyCompactList} \item \contentsline{section}{core\+::Object}{\pageref{classcore_1_1Object}}{} \begin{DoxyCompactList} -\item \contentsline{section}{core\+::I\+P\+Address}{\pageref{classcore_1_1IPAddress}}{} +\item \contentsline{section}{core\+::IPAddress}{\pageref{classcore_1_1IPAddress}}{} \item \contentsline{section}{core\+::Session\+Filter}{\pageref{classcore_1_1SessionFilter}}{} \item \contentsline{section}{core\+::Thread}{\pageref{classcore_1_1Thread}}{} \end{DoxyCompactList} \item \contentsline{section}{core\+::Socket}{\pageref{classcore_1_1Socket}}{} \begin{DoxyCompactList} -\item \contentsline{section}{core\+::I\+Notify}{\pageref{classcore_1_1INotify}}{} -\item \contentsline{section}{core\+::T\+C\+P\+Socket}{\pageref{classcore_1_1TCPSocket}}{} +\item \contentsline{section}{core\+::INotify}{\pageref{classcore_1_1INotify}}{} +\item \contentsline{section}{core\+::TCPSocket}{\pageref{classcore_1_1TCPSocket}}{} \begin{DoxyCompactList} -\item \contentsline{section}{core\+::T\+C\+P\+Server}{\pageref{classcore_1_1TCPServer}}{} -\item \contentsline{section}{core\+::T\+C\+P\+Session}{\pageref{classcore_1_1TCPSession}}{} +\item \contentsline{section}{core\+::TCPServer}{\pageref{classcore_1_1TCPServer}}{} +\item \contentsline{section}{core\+::TCPSession}{\pageref{classcore_1_1TCPSession}}{} \begin{DoxyCompactList} +\item \contentsline{section}{core\+::TLSSession}{\pageref{classcore_1_1TLSSession}}{} \item \contentsline{section}{core\+::Terminal\+Session}{\pageref{classcore_1_1TerminalSession}}{} \begin{DoxyCompactList} \item \contentsline{section}{core\+::Console\+Session}{\pageref{classcore_1_1ConsoleSession}}{} \end{DoxyCompactList} -\item \contentsline{section}{core\+::T\+L\+S\+Session}{\pageref{classcore_1_1TLSSession}}{} \end{DoxyCompactList} \end{DoxyCompactList} \item \contentsline{section}{core\+::Timer}{\pageref{classcore_1_1Timer}}{} -\item \contentsline{section}{core\+::U\+D\+P\+Socket}{\pageref{classcore_1_1UDPSocket}}{} +\item \contentsline{section}{core\+::UDPSocket}{\pageref{classcore_1_1UDPSocket}}{} \begin{DoxyCompactList} -\item \contentsline{section}{core\+::U\+D\+P\+Server\+Socket}{\pageref{classcore_1_1UDPServerSocket}}{} +\item \contentsline{section}{core\+::UDPServer\+Socket}{\pageref{classcore_1_1UDPServerSocket}}{} \end{DoxyCompactList} \end{DoxyCompactList} \item \contentsline{section}{core\+::Subscription}{\pageref{classcore_1_1Subscription}}{} diff --git a/latex/refman.tex b/latex/refman.tex index f45d5c9..5127819 100644 --- a/latex/refman.tex +++ b/latex/refman.tex @@ -10,26 +10,21 @@ %% % Packages required by doxygen \usepackage{fixltx2e} -\usepackage{calc} \usepackage{doxygen} \usepackage{graphicx} \usepackage[utf8]{inputenc} \usepackage{makeidx} -\usepackage{multicol} -\usepackage{multirow} \PassOptionsToPackage{warn}{textcomp} \usepackage{textcomp} \usepackage[nointegrals]{wasysym} -\usepackage[table]{xcolor} -\usepackage{ifpdf,ifxetex} +\usepackage{ifxetex} % Font selection \usepackage[T1]{fontenc} \usepackage[scaled=.90]{helvet} \usepackage{courier} -\usepackage{amssymb} -\usepackage{sectsty} \renewcommand{\familydefault}{\sfdefault} +\usepackage{sectsty} \allsectionsfont{% \fontseries{bc}\selectfont% \color{darkgray}% @@ -84,19 +79,23 @@ % Headers & footers \usepackage{fancyhdr} \pagestyle{fancyplain} -\fancyhead[LE]{\fancyplain{}{\bfseries\thepage}} -\fancyhead[CE]{\fancyplain{}{}} -\fancyhead[RE]{\fancyplain{}{\bfseries\leftmark}} -\fancyhead[LO]{\fancyplain{}{\bfseries\rightmark}} -\fancyhead[CO]{\fancyplain{}{}} -\fancyhead[RO]{\fancyplain{}{\bfseries\thepage}} -\fancyfoot[LE]{\fancyplain{}{}} -\fancyfoot[CE]{\fancyplain{}{}} -\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generated by Doxygen }} -\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated by Doxygen }} -\fancyfoot[CO]{\fancyplain{}{}} -\fancyfoot[RO]{\fancyplain{}{}} \renewcommand{\footrulewidth}{0.4pt} +% +\fancypagestyle{fancyplain}{ +\fancyhf{} +\fancyhead[LE, RO]{\bfseries\thepage} +\fancyhead[LO]{\bfseries\rightmark} +\fancyhead[RE]{\bfseries\leftmark} +\fancyfoot[LO, RE]{\bfseries\scriptsize Generated by Doxygen } +} +% +\fancypagestyle{plain}{ +\fancyhf{} +\fancyfoot[LO, RE]{\bfseries\scriptsize Generated by Doxygen } +\renewcommand{\headrulewidth}{0pt}} +% +\pagestyle{fancyplain} +% \renewcommand{\chaptermark}[1]{% \markboth{#1}{}% } @@ -148,6 +147,7 @@ %===== C O N T E N T S ===== \begin{document} +\raggedbottom % Titlepage & ToC \hypersetup{pageanchor=false, @@ -160,7 +160,7 @@ \begin{center}% {\Large My Project }\\ \vspace*{1cm} -{\large Generated by Doxygen 1.8.17}\\ +{\large Generated by Doxygen 1.9.1}\\ \end{center} \end{titlepage} \clearemptydoublepage
    • - - - -
    - - - - - - -
    - +
    + @@ -91,25 +78,38 @@ $(function() { - + - - - + + +
    - +
    + + + +
    + + + + + + +
    +
    - +
    +