From d445834af683ca831823709179cbecd6ca77dd46 Mon Sep 17 00:00:00 2001 From: Brad Arant Date: Fri, 23 Jul 2021 08:57:27 -0700 Subject: [PATCH] Many changes to ServerCore --- .vscode/c_cpp_properties.json | 11 +- Command.cpp | 13 +- Command.h | 6 +- CommandList.cpp | 13 +- CommandList.h | 2 +- ConsoleSession.cpp | 19 +- ConsoleSession.h | 6 +- EPoll.cpp | 2 +- EPoll.h | 2 +- INotify.cpp | 4 +- INotify.h | 2 +- Socket.cpp | 38 ++- Socket.h | 9 +- TCPServer.cpp | 28 ++- TCPServer.h | 56 +++-- TCPSession.cpp | 96 ++++---- TCPSession.h | 24 +- TCPSocket.cpp | 18 +- TLSSession.cpp | 8 +- TLSSession.h | 4 +- html/CommandList_8h_source.html | 9 +- html/Command_8h_source.html | 12 +- html/ConsoleSession_8h_source.html | 8 +- html/EPoll_8h_source.html | 6 +- html/INotify_8h_source.html | 4 +- html/Socket_8h_source.html | 222 +++++++++--------- html/TCPServer_8h_source.html | 4 +- html/TCPSession_8h_source.html | 30 +-- html/TCPSocket_8h_source.html | 2 +- html/TLSSession_8h_source.html | 8 +- html/Timer_8h_source.html | 2 +- html/UDPSocket_8h_source.html | 2 +- html/classcore_1_1Command-members.html | 4 +- html/classcore_1_1Command.html | 24 +- html/classcore_1_1CommandList-members.html | 13 +- html/classcore_1_1CommandList.html | 74 +----- html/classcore_1_1ConsoleServer-members.html | 8 +- html/classcore_1_1ConsoleServer.html | 18 +- html/classcore_1_1ConsoleSession-members.html | 10 +- html/classcore_1_1ConsoleSession.html | 32 +-- html/classcore_1_1EPoll-members.html | 4 +- html/classcore_1_1EPoll.html | 20 +- html/classcore_1_1INotify-members.html | 2 +- html/classcore_1_1INotify.html | 6 +- html/classcore_1_1Socket-members.html | 4 +- html/classcore_1_1Socket.html | 30 +-- html/classcore_1_1TCPServer-members.html | 8 +- html/classcore_1_1TCPServer.html | 26 +- html/classcore_1_1TCPSession-members.html | 10 +- html/classcore_1_1TCPSession.html | 60 ++--- html/classcore_1_1TCPSocket-members.html | 4 +- html/classcore_1_1TCPSocket.html | 10 +- html/classcore_1_1TLSServer-members.html | 8 +- html/classcore_1_1TLSServer.html | 18 +- html/classcore_1_1TLSSession-members.html | 10 +- html/classcore_1_1TLSSession.html | 48 ++-- .../classcore_1_1TerminalSession-members.html | 10 +- html/classcore_1_1TerminalSession.html | 20 +- html/classcore_1_1Timer-members.html | 2 +- .../classcore_1_1UDPServerSocket-members.html | 8 +- html/classcore_1_1UDPServerSocket.html | 18 +- html/classcore_1_1UDPSocket-members.html | 4 +- html/classcore_1_1UDPSocket.html | 10 +- html/functions.html | 27 +-- html/functions_func.html | 27 +-- html/search/all_2.js | 2 +- html/search/all_7.js | 6 +- html/search/all_8.js | 6 +- html/search/all_9.js | 2 +- html/search/functions_1.js | 2 +- html/search/functions_5.js | 6 +- html/search/functions_6.js | 6 +- html/search/functions_7.js | 2 +- latex/classcore_1_1Command.tex | 16 +- latex/classcore_1_1CommandList.tex | 33 +-- latex/classcore_1_1ConsoleSession.tex | 10 +- latex/classcore_1_1EPoll.tex | 10 +- latex/classcore_1_1INotify.tex | 4 +- latex/classcore_1_1Socket.tex | 12 +- latex/classcore_1_1TCPServer.tex | 8 +- latex/classcore_1_1TCPSession.tex | 26 +- latex/classcore_1_1TLSSession.tex | 16 +- servercore.code-workspace | 8 + 83 files changed, 666 insertions(+), 756 deletions(-) create mode 100644 servercore.code-workspace diff --git a/.vscode/c_cpp_properties.json b/.vscode/c_cpp_properties.json index a426fd3..be23ad4 100644 --- a/.vscode/c_cpp_properties.json +++ b/.vscode/c_cpp_properties.json @@ -3,13 +3,14 @@ { "name": "Linux", "includePath": [ - "${workspaceFolder}/**" + "${workspaceFolder}/**", + "${workspaceFolder}/../CoreUtils" ], "defines": [], - "compilerPath": "/usr/bin/gcc", - "cStandard": "gnu17", - "cppStandard": "gnu++14", - "intelliSenseMode": "gcc-x64", + "compilerPath": "/usr/bin/g++-9", + "cStandard": "c17", + "cppStandard": "gnu++20", + "intelliSenseMode": "windows-gcc-x64", "compileCommands": "./compile" }, { diff --git a/Command.cpp b/Command.cpp index e5fe0bf..5a349e7 100644 --- a/Command.cpp +++ b/Command.cpp @@ -4,17 +4,18 @@ namespace core { - int Command::processCommand(std::string request, TCPSession *session, std::stringstream &data) { + int Command::processCommand(coreutils::ZString request, TCPSession *session, std::stringstream &data) { return 0; } void Command::output(Session *session) {} - bool Command::check(std::string request) { - if(request.size() > 0) - if(request == name) - if(name.length() > 0) - return true; + bool Command::check(coreutils::ZString request) { + if(request.getLength() > 0) + if(request.getLength() == name.length()) + if(strncmp(request.getData(), name.c_str(), name.length()) == 0) + if(name.length() > 0) + return true; return false; } diff --git a/Command.h b/Command.h index e3c999a..3680c1f 100644 --- a/Command.h +++ b/Command.h @@ -4,7 +4,7 @@ #include "includes" #include "Object.h" #include "TCPSession.h" -#include "PString.h" +#include "ZString.h" namespace core { @@ -37,7 +37,7 @@ namespace core { /// on this command. /// - virtual bool check(std::string request); + virtual bool check(coreutils::ZString request); /// /// This method is used to implement the functionality of the requested command. @@ -50,7 +50,7 @@ namespace core { /// a non-zero value indicating an error condition. /// - virtual int processCommand(std::string request, TCPSession *session, std::stringstream &data); + virtual int processCommand(coreutils::ZString request, TCPSession *session, std::stringstream &data); /// /// Specify the output that will occur to the specified session. diff --git a/CommandList.cpp b/CommandList.cpp index 1474518..1a40c5f 100644 --- a/CommandList.cpp +++ b/CommandList.cpp @@ -12,15 +12,14 @@ namespace core { } - bool CommandList::processRequest(std::string request, TCPSession *session, std::stringstream &data) { + bool CommandList::processRequest(coreutils::ZString request, TCPSession *session, std::stringstream &data) { if(session->grab != NULL) - return session->grab->processCommand(request, session, data); + return session->grab->processCommand(request, session, data); else { - int pos = request.find(" "); - std::string function = pos == request.npos ? request: request.substr(0, pos); - for(auto *command : commands) - if(command->check(function)) - return command->processCommand(request, session, data); + coreutils::ZString function = request.getTokenExclude((char *)" "); + for(auto *command : commands) + if(command->check(function)) + return command->processCommand(request, session, data); } return false; } diff --git a/CommandList.h b/CommandList.h index 522911b..d57a09f 100644 --- a/CommandList.h +++ b/CommandList.h @@ -38,7 +38,7 @@ namespace core { /// then control is given to the process handler holding the grab on the input. /// - bool processRequest(std::string request, TCPSession *session, std::stringstream &data); + bool processRequest(coreutils::ZString request, TCPSession *session, std::stringstream &data); /// /// Use grabInput() within a Command object to force the requesting handler to receive diff --git a/ConsoleSession.cpp b/ConsoleSession.cpp index 4a9b869..1ec787e 100644 --- a/ConsoleSession.cpp +++ b/ConsoleSession.cpp @@ -9,7 +9,7 @@ namespace core { ConsoleSession::~ConsoleSession() {} - void ConsoleSession::protocol(std::string data = "") { + void ConsoleSession::protocol(coreutils::ZString data) { coreutils::Log(coreutils::LOG_DEBUG_1) << "ConsoleSession protocol " << status; switch (status) { @@ -24,7 +24,7 @@ namespace core { setCursorLocation(2, 1); setBackColor(BG_BLACK); status = LOGIN; - protocol(); + protocol((char*)""); break; case LOGIN: @@ -35,7 +35,7 @@ namespace core { case WAIT_USER_PROFILE: status = PASSWORD; - protocol(); + protocol((char*)""); break; case PASSWORD: @@ -55,7 +55,7 @@ namespace core { setBackColor(BG_BLACK); scrollArea(2, 16); status = PROMPT; - protocol(); + protocol((char*)""); break; case PROMPT: @@ -66,16 +66,15 @@ namespace core { break; case INPUT: - command = std::string(data); - command.erase(command.find_last_not_of("\r\n\t") + 1); + command = data; status = PROCESS; - protocol(); + protocol((char*)""); break; case PROCESS: doCommand(command); - status = (command == "exit")? DONE: PROMPT; - protocol(); + status = command.equals((char *)"exit") ? DONE: PROMPT; + protocol((char*)""); break; case DONE: @@ -95,7 +94,7 @@ namespace core { send(); } - void ConsoleSession::doCommand(std::string request) { + void ConsoleSession::doCommand(coreutils::ZString request) { saveCursor(); setCursorLocation(16, 1); out << "--> " << request << std::endl; diff --git a/ConsoleSession.h b/ConsoleSession.h index d0202b2..330c178 100644 --- a/ConsoleSession.h +++ b/ConsoleSession.h @@ -24,13 +24,13 @@ namespace core { void writeLog(std::string data); protected: - void protocol(std::string data) override; + void protocol(coreutils::ZString data) override; private: enum Status {WELCOME, LOGIN, WAIT_USER_PROFILE, PASSWORD, WAIT_PASSWORD, PROMPT, INPUT, PROCESS, DONE}; Status status = WELCOME; - void doCommand(std::string request); - std::string command; + void doCommand(coreutils::ZString request); + coreutils::ZString command; }; diff --git a/EPoll.cpp b/EPoll.cpp index 2ec4d47..e170b8f 100644 --- a/EPoll.cpp +++ b/EPoll.cpp @@ -84,7 +84,7 @@ namespace core { return epfd; } - int EPoll::processCommand(std::string command, TCPSession *session, std::stringstream &data) { + int EPoll::processCommand(coreutils::ZString command, TCPSession *session, std::stringstream &data) { int sequence = 0; for(auto threadx : threads) { data << "|" << ++sequence; diff --git a/EPoll.h b/EPoll.h index ad4d7d7..82d8846 100644 --- a/EPoll.h +++ b/EPoll.h @@ -110,7 +110,7 @@ namespace core { /// @param session the session to write the requested data to. /// - int processCommand(std::string command, TCPSession *session, std::stringstream &data) override; ///len) { event = (const struct inotify_event *) ptr; diff --git a/INotify.h b/INotify.h index 2bc5091..a2e9650 100644 --- a/INotify.h +++ b/INotify.h @@ -15,7 +15,7 @@ namespace core { int addWatch(std::string watch); void removeWatch(int wd); - void onDataReceived(char *buffer, int len) override; + void onDataReceived(coreutils::ZString data) override; virtual void inAccess(std::string name) {} virtual void inAttrib(std::string name) {} diff --git a/Socket.cpp b/Socket.cpp index adcbe83..ee2cc36 100644 --- a/Socket.cpp +++ b/Socket.cpp @@ -59,43 +59,33 @@ namespace core { void Socket::onUnregistered() {} bool Socket::eventReceived(struct epoll_event event) { - - coreutils::Log(coreutils::LOG_DEBUG_2) << "waiting for lock on socket " << descriptor << "."; lock.lock(); - coreutils::Log(coreutils::LOG_DEBUG_2) << "Obtained lock on socket " << descriptor << "."; if(event.events & EPOLLRDHUP) { - coreutils::Log(coreutils::LOG_DEBUG_1) << "start EPOLLRDHUP " << descriptor; readHangup = true; shutdown("hangup received"); - lock.unlock(); - coreutils::Log(coreutils::LOG_DEBUG_2) << "Release lock on socket " << descriptor << ". RDHUP"; + lock.unlock(); return false; } - if(event.events & EPOLLIN) { - coreutils::Log(coreutils::LOG_DEBUG_1) << "start EPOLLIN " << descriptor; - receiveData(buffer, length); + if(event.events & EPOLLIN) {} + receiveData(buffer); } if(event.events & EPOLLWRNORM) { - coreutils::Log(coreutils::LOG_DEBUG_1) << "start EPOLLOUT " << descriptor; - writeSocket(); + writeSocket(); } if(event.events & EPOLLHUP) { - coreutils::Log(coreutils::LOG_DEBUG_1) << "start EPOLLHUP " << descriptor; shutdown(); - lock.unlock(); - coreutils::Log(coreutils::LOG_DEBUG_2) << "Release lock on socket " << descriptor << ". HUP"; - return false; + lock.unlock(); + return false; } lock.unlock(); - coreutils::Log(coreutils::LOG_DEBUG_2) << "Release lock on socket " << descriptor << " with reset " << reset << "."; - reset = true; + reset = true; return reset; } @@ -103,20 +93,20 @@ namespace core { throw coreutils::Exception("Need to override onDataReceived.", __FILE__, __LINE__, -1); } - void Socket::onDataReceived(char *buffer, int len) { - onDataReceived(std::string(buffer, len)); + void Socket::onDataReceived(coreutils::ZString data) { + onDataReceived(std::string(data.getData(), data.getLength())); } - void Socket::receiveData(char *buffer, int bufferLength) { + void Socket::receiveData(coreutils::ZString buffer) { - if(bufferLength <= 0) + if(buffer.getLength() <= 0) throw coreutils::Exception("Request to receive data with a zero buffer length.", __FILE__, __LINE__, -1); int len; int error = -1; - if((len = ::read(getDescriptor(), buffer, bufferLength)) >= 0) { - onDataReceived(buffer, len); + if((len = ::read(getDescriptor(), buffer.getData(), buffer.getLength())) >= 0) { + onDataReceived(buffer); } else { @@ -128,7 +118,7 @@ namespace core { // request we get one of these. // case ENOTCONN: - onDataReceived(std::string(buffer, 0)); + onDataReceived(std::string(buffer.getData(), 0)); break; case ECONNRESET: diff --git a/Socket.h b/Socket.h index 920d900..87e799a 100644 --- a/Socket.h +++ b/Socket.h @@ -3,6 +3,7 @@ #include "includes" #include "Object.h" +#include "ZString.h" namespace core { @@ -146,14 +147,18 @@ namespace core { virtual void onDataReceived(std::string data); ///< Called when data is received from the socket. - virtual void onDataReceived(char *buffer, int len); + /// + /// + /// + + virtual void onDataReceived(coreutils::ZString data); /// /// receiveData 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. /// - virtual void receiveData(char *buffer, int bufferLength); + virtual void receiveData(coreutils::ZString buffer); private: diff --git a/TCPServer.cpp b/TCPServer.cpp index a4c7668..edd57c2 100644 --- a/TCPServer.cpp +++ b/TCPServer.cpp @@ -1,4 +1,5 @@ #include "TCPServer.h" +#include "TCPService.h" #include "EPoll.h" #include "TCPSession.h" #include "Exception.h" @@ -12,9 +13,10 @@ namespace core { int yes = 1; setsockopt(getDescriptor(), SOL_SOCKET, SO_REUSEADDR, &yes, sizeof(int)); if(bind(getDescriptor(), address.getPointer(), address.addressLength) < 0) - throw coreutils::Exception("Error on bind to socket: " + std::to_string(errno)); + throw coreutils::Exception("Error on bind to socket: " + std::to_string(errno)); if(listen(getDescriptor(), 20) < 0) - throw coreutils::Exception("Error on listen to socket"); + throw coreutils::Exception("Error on listen to socket"); + service = getService(ePoll); } TCPServer::~TCPServer() { @@ -58,6 +60,10 @@ namespace core { throw coreutils::Exception(errorString); } + TCPService * TCPServer::getService(EPoll &epoll) { + return new TCPService(epoll); + } + TCPSession * TCPServer::getSocketAccept(EPoll &ePoll) { return new TCPSession(ePoll, *this); } @@ -68,7 +74,7 @@ namespace core { session->send(); } - int TCPServer::processCommand(std::string command, TCPSession *session, std::stringstream &data) { + int TCPServer::processCommand(coreutils::ZString command, TCPSession *session, std::stringstream &data) { int sequence = 0; for(auto *sessionx : sessions) { data << "|" << ++sequence; @@ -77,5 +83,21 @@ namespace core { } return 1; } + + void TCPSession::sendToAll() { + for(auto session : server.sessions) + if(session != this) + session->write(out.str()); + out.str(""); + } + + void TCPSession::sendToAll(SessionFilter filter) { + for(auto session : server.sessions) + if(filter.test(*session)) + if(session != this) + session->write(out.str()); + out.str(""); + } + } diff --git a/TCPServer.h b/TCPServer.h index 0a7360d..4cab2fe 100644 --- a/TCPServer.h +++ b/TCPServer.h @@ -26,13 +26,12 @@ namespace core { public: /// - /// The constructor for the BMATCPSocket object. + /// The constructor for the TCPServer object. /// /// @param ePoll the EPoll instance that manages the socket. /// @param url the IP address for the socket to receive connection requests. /// @param port the port number that the socket will listen on. /// @param commandName the name of the command used to invoke the status display for this object. - /// @return the instance of the BMATCPServerSocket. /// TCPServer(EPoll &ePoll, IPAddress address, std::string text = ""); @@ -43,22 +42,6 @@ namespace core { ~TCPServer(); - /// - /// 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. - /// - - IPAddressList *blackList; - - /// - /// 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. - /// - - IPAddressList *whiteList; - void removeFromSessionList(TCPSession *session); virtual void sessionErrorHandler(std::string errorString, std::stringstream &out); @@ -88,6 +71,26 @@ namespace core { CommandList commands; + /// + /// 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. + /// + + IPAddressList *blackList; + + /// + /// 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. + /// + + IPAddressList *whiteList; + + void removeFromSessionList(TCPSession *session); + + void output(TCPSession *session); /// 0) { - lineBuffer = (char *)realloc(lineBuffer, lineBufferSize + len); - memcpy(lineBuffer + lineBufferSize, data, len); - lineBufferSize += len; - while(lineBufferSize > 0) { - if(blockSize == 0) { - lineLength = strcspn(lineBuffer, "\r\n"); - if(lineLength == lineBufferSize) - break; - onLineReceived(std::string(lineBuffer, lineLength)); - if(lineBuffer[lineLength] == '\r') - ++lineLength; - if(lineBuffer[lineLength] == '\n') - ++lineLength; - lineBufferSize -= lineLength; - if(lineBufferSize > 0) - memmove(lineBuffer, lineBuffer + lineLength, lineBufferSize); - lineBuffer = (char *)realloc(lineBuffer, lineBufferSize); + void TCPSession::onDataReceived(coreutils::ZString data) { + if(data.getLength() > 0) { + lineBuffer = (char *)realloc(lineBuffer, lineBufferSize + data.getLength()); + memcpy(lineBuffer + lineBufferSize, data.getData(), data.getLength()); + lineBufferSize += data.getLength(); + while(lineBufferSize > 0) { + if(blockSize == 0) { + lineLength = strcspn(lineBuffer, "\r\n"); + if(lineLength == lineBufferSize) + break; + onLineReceived(coreutils::ZString(lineBuffer, lineLength)); + if(lineBuffer[lineLength] == '\r') + ++lineLength; + if(lineBuffer[lineLength] == '\n') + ++lineLength; + lineBufferSize -= lineLength; + if(lineBufferSize > 0) + memmove(lineBuffer, lineBuffer + lineLength, lineBufferSize); + lineBuffer = (char *)realloc(lineBuffer, lineBufferSize); } else { - if(lineBufferSize >= blockLength) { - onBlockReceived(std::string(lineBuffer, blockLength)); - lineBufferSize -= blockLength; - if(lineBufferSize > 0) - memmove(lineBuffer, lineBuffer + blockLength, lineBufferSize); - lineBuffer = (char *)realloc(lineBuffer, lineBufferSize); - } - } - } + if(lineBufferSize >= blockLength) { + onBlockReceived(coreutils::ZString(lineBuffer, blockLength)); + lineBufferSize -= blockLength; + if(lineBufferSize > 0) + memmove(lineBuffer, lineBuffer + blockLength, lineBufferSize); + lineBuffer = (char *)realloc(lineBuffer, lineBufferSize); + } + } + } } } - + void TCPSession::setBlockSize(int blockSize) { this->blockSize = blockSize; } - - void TCPSession::onLineReceived(std::string line) { + + void TCPSession::onLineReceived(coreutils::ZString line) { protocol(line); send(); if(term) shutdown("termination requested"); } - - void TCPSession::onBlockReceived(std::string block) { - coreutils::Log(coreutils::LOG_DEBUG_3) << "[" << block.length() << "]"; + + void TCPSession::onBlockReceived(coreutils::ZString block) { + coreutils::Log(coreutils::LOG_DEBUG_3) << "[" << block.getLength() << "]"; if(term) shutdown("termination requested"); } - - void TCPSession::sendToAll() { - for(auto session : server.sessions) - if(session != this) - session->write(out.str()); - out.str(""); - } - - void TCPSession::sendToAll(SessionFilter filter) { - for(auto session : server.sessions) - if(filter.test(*session)) - if(session != this) - session->write(out.str()); - out.str(""); - } - + void TCPSession::send() { if(out.tellp() > 0) - write(out.str()); + write(out.str()); out.str(""); } diff --git a/TCPSession.h b/TCPSession.h index 53fd52c..b0e7be4 100644 --- a/TCPSession.h +++ b/TCPSession.h @@ -54,21 +54,6 @@ namespace core { void send(); - /// - /// Use this sendToAll method to output the contents of the out stream - /// to all the connections on the server excluding the sender session. - /// - - void sendToAll(); - - /// - /// Use this sendToAll 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. - /// - - void sendToAll(SessionFilter filter); - /// /// Use this method to terminate this TCPSession. /// @@ -94,8 +79,7 @@ namespace core { /// received. If you need data split by line termination characters then /// override the onLineReceived method instead. /// - - virtual void onDataReceived(char *data, int len) override; + virtual void onDataReceived(coreutils::ZString data) override; /// /// Override the onLineReceived method to receive a string of characters that @@ -104,7 +88,7 @@ namespace core { /// this method explicitly using the class and member name. /// - virtual void onLineReceived(std::string line); + virtual void onLineReceived(coreutils::ZString line); /// /// Override the onBlockReceived method to receive a string of characters that @@ -113,7 +97,7 @@ namespace core { /// calls this method explicitly using the class and member name. /// - virtual void onBlockReceived(std::string block); + virtual void onBlockReceived(coreutils::ZString block); /// /// This method is called from within the protocol method when protocol is called @@ -133,7 +117,7 @@ namespace core { /// data through the protocol method: LINE or BLOCK. /// - virtual void protocol(std::string data); + virtual void protocol(coreutils::ZString data); /// /// Use setBlockSize to set the amount of data that should be read at once from the diff --git a/TCPSocket.cpp b/TCPSocket.cpp index efd4754..3ac3606 100644 --- a/TCPSocket.cpp +++ b/TCPSocket.cpp @@ -4,23 +4,23 @@ #include "Exception.h" namespace core { - + TCPSocket::TCPSocket(EPoll &ePoll) : Socket(ePoll) {} TCPSocket::TCPSocket(EPoll &ePoll, std::string text) : Socket(ePoll, text) {} - + TCPSocket::~TCPSocket() {} - + void TCPSocket::connect(IPAddress &address) { setDescriptor(socket(AF_INET, SOCK_STREAM, 0)); - if(::connect(getDescriptor(), (struct sockaddr *)&address.addr, address.addressLength) == -1) - throw coreutils::Exception("Error on connect to TCP socket."); - + if(::connect(getDescriptor(), (struct sockaddr *)&address.addr, address.addressLength) == -1) + throw coreutils::Exception("Error on connect to TCP socket."); + } - + void TCPSocket::output(std::stringstream &out) { - out << "|" << ipAddress.getClientAddressAndPort(); + out << "|" << ipAddress.getClientAddressAndPort(); } - + } diff --git a/TLSSession.cpp b/TLSSession.cpp index 56ee2e3..52094e0 100644 --- a/TLSSession.cpp +++ b/TLSSession.cpp @@ -80,18 +80,18 @@ namespace core { TLSSession::~TLSSession() {} - void TLSSession::protocol(std::string data) {} + void TLSSession::protocol(coreutils::ZString data) {} - void TLSSession::receiveData(char *buffer, int bufferLength) { + void TLSSession::receiveData(coreutils::ZString buffer) { int len; // int error = -1; // std::cout << "receiveData TLS" << std::endl; - if((len = ::SSL_read(ssl, buffer, bufferLength)) >= 0) { + if((len = ::SSL_read(ssl, buffer.getData(), buffer.getLength())) >= 0) { std::cout << "receiveData TLS...len=" << len << ":" << buffer << std::endl; - onDataReceived(buffer, len); + onDataReceived(buffer); } else { switch (SSL_get_error(ssl, len)) { diff --git a/TLSSession.h b/TLSSession.h index 12da72d..715d34e 100644 --- a/TLSSession.h +++ b/TLSSession.h @@ -35,10 +35,10 @@ namespace core { /// virtual void output(std::stringstream &out); - virtual void protocol(std::string data) override; + virtual void protocol(coreutils::ZString data) override; protected: - void receiveData(char *buffer, int bufferLength) override; + void receiveData(coreutils::ZString buffer) override; void onRegister(); void onRegistered(); diff --git a/html/CommandList_8h_source.html b/html/CommandList_8h_source.html index 39abef4..a07a5b2 100644 --- a/html/CommandList_8h_source.html +++ b/html/CommandList_8h_source.html @@ -86,7 +86,7 @@ $(function() {
32  void remove(Command &command);
33 
40 
-
41  bool processRequest(std::string request, TCPSession *session, std::stringstream &data);
+
41  bool processRequest(coreutils::ZString request, TCPSession *session, std::stringstream &data);
42 
48 
49  bool grabInput(TCPSession *session, Command &command);
@@ -95,7 +95,7 @@ $(function() {
55  void clearGrab(TCPSession *session);
56 
60 
-
61  int processCommand(std::string request, TCPSession *session, std::stringstream &data);
+
61  int processCommand(std::string request, TCPSession *session, std::stringstream &data);
62 
63  protected:
64 
@@ -108,15 +108,14 @@ $(function() {
74 
75 #endif
-
core::CommandList::grabInput
bool grabInput(TCPSession *session, Command &command)
Definition: CommandList.cpp:28
+
core::CommandList::grabInput
bool grabInput(TCPSession *session, Command &command)
Definition: CommandList.cpp:27
+
core::CommandList::processRequest
bool processRequest(coreutils::ZString request, TCPSession *session, std::stringstream &data)
Definition: CommandList.cpp:15
core::TCPSession
Definition: TCPSession.h:24
core::CommandList::commands
std::vector< Command * > commands
Definition: CommandList.h:69
-
core::CommandList::processCommand
int processCommand(std::string request, TCPSession *session, std::stringstream &data)
Definition: CommandList.cpp:37
core::CommandList::add
void add(Command &command, std::string name="")
Definition: CommandList.cpp:6
core::CommandList::remove
void remove(Command &command)
Definition: CommandList.cpp:11
core::Command
Definition: Command.h:22
core::CommandList
Definition: CommandList.h:18
-
core::CommandList::processRequest
bool processRequest(std::string request, TCPSession *session, std::stringstream &data)
Definition: CommandList.cpp:15
Generated by   diff --git a/html/Command_8h_source.html b/html/Command_8h_source.html index 8c0cfd2..fe50b05 100644 --- a/html/Command_8h_source.html +++ b/html/Command_8h_source.html @@ -71,7 +71,7 @@ $(function() {
4 #include "includes"
5 #include "Object.h"
6 #include "TCPSession.h"
-
7 #include "PString.h"
+
7 #include "ZString.h"
8 
9 namespace core {
10 
@@ -85,10 +85,10 @@ $(function() {
24  public:
25 
39 
-
40  virtual bool check(std::string request);
+
40  virtual bool check(coreutils::ZString request);
41 
52 
-
53  virtual int processCommand(std::string request, TCPSession *session, std::stringstream &data);
+
53  virtual int processCommand(coreutils::ZString request, TCPSession *session, std::stringstream &data);
54 
60 
61  virtual void output(Session *session);
@@ -108,12 +108,12 @@ $(function() {
83 #endif
core::TCPSession
Definition: TCPSession.h:24
-
core::Command::check
virtual bool check(std::string request)
Definition: Command.cpp:13
+
core::Command::processCommand
virtual int processCommand(coreutils::ZString request, TCPSession *session, std::stringstream &data)
Definition: Command.cpp:7
core::Command::output
virtual void output(Session *session)
Definition: Command.cpp:11
core::Command
Definition: Command.h:22
-
core::Command::processCommand
virtual int processCommand(std::string request, TCPSession *session, std::stringstream &data)
Definition: Command.cpp:7
+
core::Command::check
virtual bool check(coreutils::ZString request)
Definition: Command.cpp:13
core::Object
Definition: Object.h:8
-
core::Command::setName
void setName(std::string name)
Definition: Command.cpp:21
+
core::Command::setName
void setName(std::string name)
Definition: Command.cpp:22
Generated by   diff --git a/html/ConsoleSession_8h_source.html b/html/ConsoleSession_8h_source.html index 89115e5..30fcb84 100644 --- a/html/ConsoleSession_8h_source.html +++ b/html/ConsoleSession_8h_source.html @@ -84,13 +84,13 @@ $(function() {
24  void writeLog(std::string data);
25 
26  protected:
-
27  void protocol(std::string data) override;
+
27  void protocol(coreutils::ZString data) override;
28 
29  private:
30  enum Status {WELCOME, LOGIN, WAIT_USER_PROFILE, PASSWORD, WAIT_PASSWORD, PROMPT, INPUT, PROCESS, DONE};
31  Status status = WELCOME;
-
32  void doCommand(std::string request);
-
33  std::string command;
+
32  void doCommand(coreutils::ZString request);
+
33  coreutils::ZString command;
34 
35  };
36 
@@ -100,7 +100,7 @@ $(function() {
core::EPoll
Definition: EPoll.h:31
core::ConsoleSession
Definition: ConsoleSession.h:18
-
core::ConsoleSession::protocol
void protocol(std::string data) override
Definition: ConsoleSession.cpp:12
+
core::ConsoleSession::protocol
void protocol(coreutils::ZString data) override
Definition: ConsoleSession.cpp:12
core::TCPServer
Definition: TCPServer.h:24
core::TerminalSession
Definition: TerminalSession.h:30
diff --git a/html/EPoll_8h_source.html b/html/EPoll_8h_source.html index 960a833..ae323df 100644 --- a/html/EPoll_8h_source.html +++ b/html/EPoll_8h_source.html @@ -112,7 +112,7 @@ $(function() {
104  void eventReceived(struct epoll_event event);
105 
112 
-
113  int processCommand(std::string command, TCPSession *session, std::stringstream &data) override;
+
113  int processCommand(coreutils::ZString command, TCPSession *session, std::stringstream &data) override;
114 
115  void resetSocket(Socket *socket);
116 
@@ -135,15 +135,15 @@ $(function() {
core::EPoll::isStopping
bool isStopping()
Returns a true if the stop command has been requested.
Definition: EPoll.cpp:67
core::EPoll::start
bool start(int numberOfThreads, int maxSockets)
Start the BMAEPoll processing.
Definition: EPoll.cpp:21
core::TCPSession
Definition: TCPSession.h:24
-
core::Socket
Definition: Socket.h:33
+
core::Socket
Definition: Socket.h:34
core::EPoll::unregisterSocket
bool unregisterSocket(Socket *socket)
Unregister a BMASocket from monitoring by BMAEPoll.
Definition: EPoll.cpp:77
core::EPoll
Definition: EPoll.h:31
core::EPoll::stop
bool stop()
Stop and shut down the BMAEPoll processing.
Definition: EPoll.cpp:47
core::EPoll::maxSockets
int maxSockets
The maximum number of socket allowed.
Definition: EPoll.h:98
core::Command
Definition: Command.h:22
core::EPoll::eventReceived
void eventReceived(struct epoll_event event)
Dispatch event to appropriate socket.
+
core::EPoll::processCommand
int processCommand(coreutils::ZString command, TCPSession *session, std::stringstream &data) override
Output the threads array to the console.
Definition: EPoll.cpp:87
core::EPoll::getDescriptor
int getDescriptor()
Return the descriptor for the ePoll socket.
Definition: EPoll.cpp:83
-
core::EPoll::processCommand
int processCommand(std::string command, TCPSession *session, std::stringstream &data) override
Output the threads array to the console.
Definition: EPoll.cpp:87
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:71
diff --git a/html/INotify_8h_source.html b/html/INotify_8h_source.html index 8f7a20c..0ee3ece 100644 --- a/html/INotify_8h_source.html +++ b/html/INotify_8h_source.html @@ -82,7 +82,7 @@ $(function() {
15  int addWatch(std::string watch);
16  void removeWatch(int wd);
17 
-
18  void onDataReceived(char *buffer, int len) override;
+
18  void onDataReceived(coreutils::ZString data) override;
19 
20  virtual void inAccess(std::string name) {}
21  virtual void inAttrib(std::string name) {}
@@ -103,7 +103,7 @@ $(function() {
36 
37 #endif
-
core::Socket
Definition: Socket.h:33
+
core::Socket
Definition: Socket.h:34
core::EPoll
Definition: EPoll.h:31
core::INotify
Definition: INotify.h:9
diff --git a/html/Socket_8h_source.html b/html/Socket_8h_source.html index 01a5e1b..a9c8b0b 100644 --- a/html/Socket_8h_source.html +++ b/html/Socket_8h_source.html @@ -70,117 +70,119 @@ $(function() {
3 
4 #include "includes"
5 #include "Object.h"
-
6 
-
7 namespace core {
-
8 
-
9  class EPoll;
-
10 
-
32 
-
33  class Socket : public core::Object {
-
34 
-
35  public:
-
36 
-
43 
-
44  Socket(EPoll &ePoll, std::string text = "");
-
45 
-
49 
-
50  ~Socket();
-
51 
-
57 
-
58  void shutdown(std::string text = "unknown");
-
59 
-
64 
-
65  void setDescriptor(int descriptor);
-
66 
-
67  int getDescriptor();
-
68 
-
78 
-
79  bool eventReceived(struct epoll_event event);
-
80 
-
84 
-
85  int write(std::string data);
-
86  void write(char *buffer, int length);
-
87 
-
88  void output(std::stringstream &out);
-
89 
-
96 
-
97  virtual void onRegister();
-
98  virtual void onRegistered();
-
99 
-
100  virtual void onUnregister();
-
101 
-
108 
-
109  virtual void onUnregistered();
-
110 
-
111  bool needsToWrite();
-
112 
-
113  bool reset = false;
-
114 
-
115  protected:
-
116 
-
117  EPoll &ePoll; // The EPoll control object.
-
118 
-
119  bool shutDown = false;
-
120 
-
121  void setBufferSize(int length);
-
122 
-
123  int getBufferSize();
-
124 
-
130 
-
131 // virtual void onConnected(); ///< Called when socket is open and ready to communicate.
-
132 
-
136 
-
137 // virtual void onDisconnected(); ///< Called when socket is closing and no longer ready to communicate.
-
138 
-
146 
-
147  virtual void onDataReceived(std::string data);
-
148 
-
149  virtual void onDataReceived(char *buffer, int len);
-
150 
-
155 
-
156  virtual void receiveData(char *buffer, int bufferLength);
-
157 
-
158  private:
-
159 
-
160  std::string text;
-
161  int descriptor = -1;
-
162  std::mutex lock;
-
163  std::mutex outlock;
-
164  bool readHangup = false;
-
165 
-
166 // struct epoll_event event; // Event selection construction structure.
-
167 
-
168  //-------------------------------------------------------------------------------------
-
169  // the writeSocket is called when epoll has received a write request for a socket.
-
170  // Writing data to this socket is queued in the streambuf and permission is requested
-
171  // to write to the socket. This routine handles the writing of the streambuf data
-
172  // buffer to the socket.
-
173  //-------------------------------------------------------------------------------------
-
174 
-
175  void writeSocket();
-
176 
-
177  // int_type underflow();
-
178 // int_type uflow();
-
179 // int_type pbackfail(int_type ch);
-
180 // streamsize showmanyc();
+
6 #include "ZString.h"
+
7 
+
8 namespace core {
+
9 
+
10  class EPoll;
+
11 
+
33 
+
34  class Socket : public core::Object {
+
35 
+
36  public:
+
37 
+
44 
+
45  Socket(EPoll &ePoll, std::string text = "");
+
46 
+
50 
+
51  ~Socket();
+
52 
+
58 
+
59  void shutdown(std::string text = "unknown");
+
60 
+
65 
+
66  void setDescriptor(int descriptor);
+
67 
+
68  int getDescriptor();
+
69 
+
79 
+
80  bool eventReceived(struct epoll_event event);
+
81 
+
85 
+
86  int write(std::string data);
+
87  void write(char *buffer, int length);
+
88 
+
89  void output(std::stringstream &out);
+
90 
+
97 
+
98  virtual void onRegister();
+
99  virtual void onRegistered();
+
100 
+
101  virtual void onUnregister();
+
102 
+
109 
+
110  virtual void onUnregistered();
+
111 
+
112  bool needsToWrite();
+
113 
+
114  bool reset = false;
+
115 
+
116  protected:
+
117 
+
118  EPoll &ePoll; // The EPoll control object.
+
119 
+
120  bool shutDown = false;
+
121 
+
122  void setBufferSize(int length);
+
123 
+
124  int getBufferSize();
+
125 
+
131 
+
132 // virtual void onConnected(); ///< Called when socket is open and ready to communicate.
+
133 
+
137 
+
138 // virtual void onDisconnected(); ///< Called when socket is closing and no longer ready to communicate.
+
139 
+
147 
+
148  virtual void onDataReceived(std::string data);
+
149 
+
153 
+
154  virtual void onDataReceived(coreutils::ZString data);
+
155 
+
160 
+
161  virtual void receiveData(coreutils::ZString buffer);
+
162 
+
163  private:
+
164 
+
165  std::string text;
+
166  int descriptor = -1;
+
167  std::mutex lock;
+
168  std::mutex outlock;
+
169  bool readHangup = false;
+
170 
+
171 // struct epoll_event event; // Event selection construction structure.
+
172 
+
173  //-------------------------------------------------------------------------------------
+
174  // the writeSocket is called when epoll has received a write request for a socket.
+
175  // Writing data to this socket is queued in the streambuf and permission is requested
+
176  // to write to the socket. This routine handles the writing of the streambuf data
+
177  // buffer to the socket.
+
178  //-------------------------------------------------------------------------------------
+
179 
+
180  void writeSocket();
181 
-
182  char *buffer; // This is a pointer to the managed buffer space.
-
183  int length; // This is the length of the buffer.
-
184 
-
185 // const char * const begin_;
-
186 // const char * const end_;
-
187 // const char * const current_;
-
188 
-
189  std::queue<std::string> fifo;
-
190 
-
191  };
-
192 
-
193 }
-
194 
-
195 #endif
-
196 
+
182  // int_type underflow();
+
183 // int_type uflow();
+
184 // int_type pbackfail(int_type ch);
+
185 // streamsize showmanyc();
+
186 
+
187  char *buffer; // This is a pointer to the managed buffer space.
+
188  int length; // This is the length of the buffer.
+
189 
+
190 // const char * const begin_;
+
191 // const char * const end_;
+
192 // const char * const current_;
+
193 
+
194  std::queue<std::string> fifo;
+
195 
+
196  };
+
197 
+
198 }
+
199 
+
200 #endif
+
201 
-
core::Socket
Definition: Socket.h:33
+
core::Socket
Definition: Socket.h:34
core::Socket::write
int write(std::string data)
Definition: Socket.cpp:155
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:55
@@ -189,8 +191,8 @@ $(function() {
core::Socket::shutdown
void shutdown(std::string text="unknown")
Definition: Socket.cpp:174
core::Socket::onRegister
virtual void onRegister()
Called before the socket has registered with the epoll processing.
Definition: Socket.cpp:53
core::Socket::eventReceived
bool eventReceived(struct epoll_event event)
Parse epoll event and call specified callbacks.
Definition: Socket.cpp:61
-
core::Socket::receiveData
virtual void receiveData(char *buffer, int bufferLength)
Definition: Socket.cpp:110
core::Socket::onUnregistered
virtual void onUnregistered()
Called when the socket has finished unregistering for the epoll processing.
Definition: Socket.cpp:59
+
core::Socket::receiveData
virtual void receiveData(coreutils::ZString buffer)
Definition: Socket.cpp:110
core::Object
Definition: Object.h:8
core::Socket::getDescriptor
int getDescriptor()
Get the descriptor for the socket.
Definition: Socket.cpp:40
core::Socket::~Socket
~Socket()
Definition: Socket.cpp:14
diff --git a/html/TCPServer_8h_source.html b/html/TCPServer_8h_source.html index 8fcf3f6..947add9 100644 --- a/html/TCPServer_8h_source.html +++ b/html/TCPServer_8h_source.html @@ -114,7 +114,7 @@ $(function() {
103  void onDataReceived(std::string data) override;
104 
111 
-
112  int processCommand(std::string command, TCPSession *session, std::stringstream &data) override;
+
112  int processCommand(coreutils::ZString command, TCPSession *session, std::stringstream &data) override;
113 
114  private:
115 
@@ -131,10 +131,10 @@ $(function() {
core::TCPSession
Definition: TCPSession.h:24
core::IPAddress
Definition: IPAddress.h:9
core::TCPServer::sessions
std::vector< TCPSession * > sessions
Definition: TCPServer.h:82
-
core::TCPServer::processCommand
int processCommand(std::string command, TCPSession *session, std::stringstream &data) override
Definition: TCPServer.cpp:71
core::TCPServer::onDataReceived
void onDataReceived(std::string data) override
Definition: TCPServer.cpp:25
core::TCPServer::TCPServer
TCPServer(EPoll &ePoll, IPAddress address, std::string text="")
Definition: TCPServer.cpp:9
core::EPoll
Definition: EPoll.h:31
+
core::TCPServer::processCommand
int processCommand(coreutils::ZString command, TCPSession *session, std::stringstream &data) override
Definition: TCPServer.cpp:71
core::Command
Definition: Command.h:22
core::TCPSocket
Definition: TCPSocket.h:20
core::TCPServer::whiteList
IPAddressList * whiteList
Definition: TCPServer.h:60
diff --git a/html/TCPSession_8h_source.html b/html/TCPSession_8h_source.html index dddc53d..48a5c9b 100644 --- a/html/TCPSession_8h_source.html +++ b/html/TCPSession_8h_source.html @@ -115,19 +115,19 @@ $(function() {
90  virtual void onRegistered() override;
91 
97 
-
98  virtual void onDataReceived(char *data, int len) override;
+
98  virtual void onDataReceived(coreutils::ZString data) override;
99 
106 
-
107  virtual void onLineReceived(std::string line);
+
107  virtual void onLineReceived(coreutils::ZString line);
108 
115 
-
116  virtual void onBlockReceived(std::string block);
+
116  virtual void onBlockReceived(coreutils::ZString block);
117 
123 
124  virtual void onConnected();
125 
135 
-
136  virtual void protocol(std::string data);
+
136  virtual void protocol(coreutils::ZString data);
137 
143 
144  void setBlockSize(int size = 0);
@@ -147,24 +147,24 @@ $(function() {
158 
159 #endif
-
core::TCPSession::send
void send()
Definition: TCPSession.cpp:98
+
core::TCPSession::send
void send()
Definition: TCPSession.cpp:97
core::SessionFilter
Definition: SessionFilter.h:10
-
core::TCPSession::onBlockReceived
virtual void onBlockReceived(std::string block)
Definition: TCPSession.cpp:77
core::TCPSession
Definition: TCPSession.h:24
-
core::TCPSession::protocol
virtual void protocol(std::string data)
Definition: TCPSession.cpp:18
-
core::TCPSession::onDataReceived
virtual void onDataReceived(char *data, int len) override
Definition: TCPSession.cpp:34
core::EPoll
Definition: EPoll.h:31
-
core::TCPSession::sendToAll
void sendToAll()
Definition: TCPSession.cpp:83
-
core::TCPSession::onLineReceived
virtual void onLineReceived(std::string line)
Definition: TCPSession.cpp:70
+
core::TCPSession::sendToAll
void sendToAll()
Definition: TCPSession.cpp:82
+
core::TCPSession::onDataReceived
virtual void onDataReceived(coreutils::ZString data) override
Definition: TCPSession.cpp:33
core::TCPSession::out
std::stringstream out
Definition: TCPSession.h:48
-
core::TCPSession::terminate
void terminate()
Definition: TCPSession.cpp:104
-
core::TCPSession::onRegistered
virtual void onRegistered() override
Called after the socket has been registered with epoll processing.
Definition: TCPSession.cpp:24
-
core::TCPSession::setBlockSize
void setBlockSize(int size=0)
Definition: TCPSession.cpp:66
+
core::TCPSession::terminate
void terminate()
Definition: TCPSession.cpp:103
+
core::TCPSession::onRegistered
virtual void onRegistered() override
Called after the socket has been registered with epoll processing.
Definition: TCPSession.cpp:23
+
core::TCPSession::protocol
virtual void protocol(coreutils::ZString data)
Definition: TCPSession.cpp:17
+
core::TCPSession::setBlockSize
void setBlockSize(int size=0)
Definition: TCPSession.cpp:65
core::Command
Definition: Command.h:22
core::TCPSocket
Definition: TCPSocket.h:20
-
core::TCPSession::output
virtual void output(std::stringstream &data)
Definition: TCPSession.cpp:14
-
core::TCPSession::onConnected
virtual void onConnected()
Definition: TCPSession.cpp:32
+
core::TCPSession::onLineReceived
virtual void onLineReceived(coreutils::ZString line)
Definition: TCPSession.cpp:69
+
core::TCPSession::output
virtual void output(std::stringstream &data)
Definition: TCPSession.cpp:13
+
core::TCPSession::onConnected
virtual void onConnected()
Definition: TCPSession.cpp:31
core::TCPServer
Definition: TCPServer.h:24
+
core::TCPSession::onBlockReceived
virtual void onBlockReceived(coreutils::ZString block)
Definition: TCPSession.cpp:76
Generated by   diff --git a/html/TCPSocket_8h_source.html b/html/TCPSocket_8h_source.html index 87cf87a..9c10af9 100644 --- a/html/TCPSocket_8h_source.html +++ b/html/TCPSocket_8h_source.html @@ -97,7 +97,7 @@ $(function() {
45 #endif
core::IPAddress
Definition: IPAddress.h:9
-
core::Socket
Definition: Socket.h:33
+
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:21
diff --git a/html/TLSSession_8h_source.html b/html/TLSSession_8h_source.html index 48ca98d..6aa3827 100644 --- a/html/TLSSession_8h_source.html +++ b/html/TLSSession_8h_source.html @@ -87,10 +87,10 @@ $(function() {
29 
36 
37  virtual void output(std::stringstream &out);
-
38  virtual void protocol(std::string data) override;
+
38  virtual void protocol(coreutils::ZString data) override;
39 
40  protected:
-
41  void receiveData(char *buffer, int bufferLength) override;
+
41  void receiveData(coreutils::ZString buffer) override;
42  void onRegister();
43  void onRegistered();
44 
@@ -104,15 +104,15 @@ $(function() {
52 
53 #endif
-
core::TLSSession::protocol
virtual void protocol(std::string data) override
Definition: TLSSession.cpp:83
+
core::TLSSession::receiveData
void receiveData(coreutils::ZString buffer) override
Definition: TLSSession.cpp:85
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::TCPSession::out
std::stringstream out
Definition: TCPSession.h:48
core::TLSSession
Definition: TLSSession.h:23
core::TCPServer
Definition: TCPServer.h:24
-
core::TLSSession::receiveData
void receiveData(char *buffer, int bufferLength) override
Definition: TLSSession.cpp:85
core::TLSSession::onRegister
void onRegister()
Called before the socket has registered with the epoll processing.
Definition: TLSSession.cpp:36
diff --git a/html/Timer_8h_source.html b/html/Timer_8h_source.html index 3145e90..e28eb3a 100644 --- a/html/Timer_8h_source.html +++ b/html/Timer_8h_source.html @@ -107,7 +107,7 @@ $(function() {
65 
66 #endif
-
core::Socket
Definition: Socket.h:33
+
core::Socket
Definition: Socket.h:34
core::EPoll
Definition: EPoll.h:31
core::Timer::getElapsed
double getElapsed()
Definition: Timer.cpp:47
core::Timer
Definition: Timer.h:18
diff --git a/html/UDPSocket_8h_source.html b/html/UDPSocket_8h_source.html index a1f2f33..8051b7d 100644 --- a/html/UDPSocket_8h_source.html +++ b/html/UDPSocket_8h_source.html @@ -88,7 +88,7 @@ $(function() {
21 #endif
core::UDPSocket
Definition: UDPSocket.h:8
-
core::Socket
Definition: Socket.h:33
+
core::Socket
Definition: Socket.h:34
core::EPoll
Definition: EPoll.h:31
diff --git a/html/classcore_1_1Command-members.html b/html/classcore_1_1Command-members.html index 6a7b630..7460f64 100644 --- a/html/classcore_1_1Command-members.html +++ b/html/classcore_1_1Command-members.html @@ -72,10 +72,10 @@ $(function() {

This is the complete list of members for core::Command, including all inherited members.

- + - +
check(std::string request)core::Commandvirtual
check(coreutils::ZString request)core::Commandvirtual
getName() (defined in core::Command)core::Command
output(Session *session)core::Commandvirtual
processCommand(std::string request, TCPSession *session, std::stringstream &data)core::Commandvirtual
processCommand(coreutils::ZString request, TCPSession *session, std::stringstream &data)core::Commandvirtual
setName(std::string name)core::Command
tag (defined in core::Object)core::Object
diff --git a/html/classcore_1_1Command.html b/html/classcore_1_1Command.html index 75cb6d6..5bd5aec 100644 --- a/html/classcore_1_1Command.html +++ b/html/classcore_1_1Command.html @@ -101,10 +101,10 @@ Collaboration diagram for core::Command: - - - - + + + + @@ -127,8 +127,8 @@ std::string 

Command

Use the Command object in combination with a CommandList object to maintain a list of functions that can be invoked as a result of processing a request.

Member Function Documentation

- -

◆ check()

+ +

◆ check()

@@ -139,7 +139,7 @@ std::string 
- + @@ -151,7 +151,7 @@ std::string 

Implement check method to provide a special check rule upon the request to see if the command should be processed.

-

The default rule is to verify that the first token in the request string matches the name given on the registration of the command to the CommandList. This can be overridden by implementing the check() method to perform the test and return the condition of the command.

+

The default rule is to verify that the first token in the request string matches the name given on the registration of the command to the CommandList. This can be overridden by implementing the check() method to perform the test and return the condition of the command.

Parameters

Public Member Functions

virtual bool check (std::string request)
 
virtual int processCommand (std::string request, TCPSession *session, std::stringstream &data)
 
virtual bool check (coreutils::ZString request)
 
virtual int processCommand (coreutils::ZString request, TCPSession *session, std::stringstream &data)
 
virtual void output (Session *session)
 
void setName (std::string name)
tag tag bool core::Command::check (std::string coreutils::ZString  request)
tag
@@ -195,8 +195,8 @@ std::string  - -

◆ processCommand()

+ +

◆ processCommand()

@@ -207,7 +207,7 @@ std::string 
- + @@ -244,7 +244,7 @@ std::string 
Returns
Returns 0 if execution of the command was successful. Otherwise returns a non-zero value indicating an error condition.
-

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

+

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

diff --git a/html/classcore_1_1CommandList-members.html b/html/classcore_1_1CommandList-members.html index 829d0f3..6c99424 100644 --- a/html/classcore_1_1CommandList-members.html +++ b/html/classcore_1_1CommandList-members.html @@ -73,17 +73,18 @@ $(function() {

This is the complete list of members for core::CommandList, including all inherited members.

requestThe request passed to the parser to check the rule.
tag tag int core::Command::processCommand (std::string coreutils::ZString  request,
tag
- + - - - - - + + + + + +
add(Command &command, std::string name="")core::CommandList
check(std::string request)core::Commandvirtual
check(coreutils::ZString request)core::Commandvirtual
clearGrab(TCPSession *session) (defined in core::CommandList)core::CommandList
commandscore::CommandListprotected
getName() (defined in core::Command)core::Command
grabInput(TCPSession *session, Command &command)core::CommandList
output(Session *session)core::Commandvirtual
processCommand(std::string request, TCPSession *session, std::stringstream &data)core::CommandListvirtual
processRequest(std::string request, TCPSession *session, std::stringstream &data)core::CommandList
remove(Command &command)core::CommandList
setName(std::string name)core::Command
tag (defined in core::Object)core::Object
processCommand(std::string request, TCPSession *session, std::stringstream &data) (defined in core::CommandList)core::CommandList
core::Command::processCommand(coreutils::ZString request, TCPSession *session, std::stringstream &data)core::Commandvirtual
processRequest(coreutils::ZString request, TCPSession *session, std::stringstream &data)core::CommandList
remove(Command &command)core::CommandList
setName(std::string name)core::Command
tag (defined in core::Object)core::Object
diff --git a/html/classcore_1_1CommandList.html b/html/classcore_1_1CommandList.html index d1419e8..137c713 100644 --- a/html/classcore_1_1CommandList.html +++ b/html/classcore_1_1CommandList.html @@ -102,18 +102,21 @@ Public Member Functions   void remove (Command &command)   -bool processRequest (std::string request, TCPSession *session, std::stringstream &data) -  +bool processRequest (coreutils::ZString request, TCPSession *session, std::stringstream &data) +  bool grabInput (TCPSession *session, Command &command)   void clearGrab (TCPSession *session)   -int processCommand (std::string request, TCPSession *session, std::stringstream &data) + +int processCommand (std::string request, TCPSession *session, std::stringstream &data)   - Public Member Functions inherited from core::Command -virtual bool check (std::string request) -  +virtual bool check (coreutils::ZString request) +  +virtual int processCommand (coreutils::ZString request, TCPSession *session, std::stringstream &data) +  virtual void output (Session *session)   void setName (std::string name) @@ -199,61 +202,8 @@ std::string tag - -

◆ processCommand()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
int core::CommandList::processCommand (std::string request,
TCPSession * session,
std::stringstream & data 
)
- 		-virtual
-
-

This method is used to implement the functionality of the requested command. This pure virtual function must be implemented in your inheriting object.

-
Parameters
- - - -
requestThe request that was entered by the user to invoke this command.
sessionSpecify the requesting session so that the execution of the command process can return its output to the session.
-
-
-
Returns
Returns 0 if execution of the command was successful. Otherwise returns a non-zero value indicating an error condition.
- -

Reimplemented from core::Command.

- -
-
- -

◆ processRequest()

+ +

◆ processRequest()

@@ -261,7 +211,7 @@ std::string tag bool core::CommandList::processRequest ( - std::string  + coreutils::ZString  request, @@ -283,7 +233,7 @@ std::string tag
-

Use this method to apply a parsed PString 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.

+

Use this method to apply a parsed PString 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.

diff --git a/html/classcore_1_1ConsoleServer-members.html b/html/classcore_1_1ConsoleServer-members.html index 0fa0828..fc0214f 100644 --- a/html/classcore_1_1ConsoleServer-members.html +++ b/html/classcore_1_1ConsoleServer-members.html @@ -73,7 +73,7 @@ $(function() {

This is the complete list of members for core::ConsoleServer, including all inherited members.

- + @@ -88,7 +88,7 @@ $(function() { - + @@ -96,8 +96,8 @@ $(function() { - - + + diff --git a/html/classcore_1_1ConsoleServer.html b/html/classcore_1_1ConsoleServer.html index 31f37db..686a46e 100644 --- a/html/classcore_1_1ConsoleServer.html +++ b/html/classcore_1_1ConsoleServer.html @@ -185,8 +185,8 @@ virtual void  - - + + @@ -224,8 +224,8 @@ std::string  - - + + @@ -233,11 +233,11 @@ void  - - - - + + + + diff --git a/html/classcore_1_1ConsoleSession-members.html b/html/classcore_1_1ConsoleSession-members.html index 5e5f673..b6e77e3 100644 --- a/html/classcore_1_1ConsoleSession-members.html +++ b/html/classcore_1_1ConsoleSession-members.html @@ -86,11 +86,11 @@ $(function() { - + - + - + @@ -98,8 +98,8 @@ $(function() { - - + + diff --git a/html/classcore_1_1ConsoleSession.html b/html/classcore_1_1ConsoleSession.html index 6cead49..a870a27 100644 --- a/html/classcore_1_1ConsoleSession.html +++ b/html/classcore_1_1ConsoleSession.html @@ -215,19 +215,19 @@ bool  - - + +
blackListcore::TCPServer
check(std::string request)core::Commandvirtual
check(coreutils::ZString request)core::Commandvirtual
commandscore::TCPServer
connect(IPAddress &address) (defined in core::TCPSocket)core::TCPSocket
ConsoleServer(EPoll &ePoll, IPAddress address) (defined in core::ConsoleServer)core::ConsoleServer
name (defined in core::Object)core::Object
needsToWrite() (defined in core::Socket)core::Socket
onDataReceived(std::string data) overridecore::TCPServerprotectedvirtual
onDataReceived(char *buffer, int len) (defined in core::Socket)core::Socketprotectedvirtual
onDataReceived(coreutils::ZString data) (defined in core::Socket)core::Socketprotectedvirtual
onRegister()core::Socketvirtual
onRegistered()core::Socketvirtual
onUnregister() (defined in core::Socket)core::Socketvirtual
output(TCPSession *session)core::TCPServer
core::TCPSocket::output(std::stringstream &out)core::TCPSocketvirtual
core::Command::output(Session *session)core::Commandvirtual
processCommand(std::string command, TCPSession *session, std::stringstream &data) overridecore::TCPServerprotectedvirtual
receiveData(char *buffer, int bufferLength)core::Socketprotectedvirtual
processCommand(coreutils::ZString command, TCPSession *session, std::stringstream &data) overridecore::TCPServerprotectedvirtual
receiveData(coreutils::ZString buffer)core::Socketprotectedvirtual
removeFromSessionList(TCPSession *session) (defined in core::TCPServer)core::TCPServer
reset (defined in core::Socket)core::Socket
sessionErrorHandler(std::string errorString, std::stringstream &out) (defined in core::TCPServer)core::TCPServervirtual
onUnregister< bool needsToWrite ()
 
- Public Member Functions inherited from core::Command
virtual bool check (std::string request)
 
virtual bool check (coreutils::ZString request)
 
virtual void output (Session *session)
 
void setName (std::string name)
tag- Protected Member Functions inherited from core::TCPServer
void onDataReceived (std::string data) override
 
int processCommand (std::string command, TCPSession *session, std::stringstream &data) override
 
int processCommand (coreutils::ZString command, TCPSession *session, std::stringstream &data) override
 
- Protected Member Functions inherited from core::Socket
void setBufferSize (int length)
setBufferSize (in
int getBufferSize ()
 
-virtual void onDataReceived (char *buffer, int len)
 
virtual void receiveData (char *buffer, int bufferLength)
 
+virtual void onDataReceived (coreutils::ZString data)
 
virtual void receiveData (coreutils::ZString buffer)
 
- Protected Attributes inherited from core::Socket
EPoll & ePoll
name (defined in core::Object)core::Object
needsToWrite() (defined in core::Socket)core::Socket
NextLine(int lines) (defined in core::TerminalSession)core::TerminalSession
onBlockReceived(std::string block)core::TCPSessionprotectedvirtual
onBlockReceived(coreutils::ZString block)core::TCPSessionprotectedvirtual
onConnected()core::TCPSessionprotectedvirtual
onDataReceived(char *data, int len) overridecore::TCPSessionprotectedvirtual
onDataReceived(coreutils::ZString data) overridecore::TCPSessionprotectedvirtual
core::TCPSocket::onDataReceived(std::string data)core::Socketprotectedvirtual
onLineReceived(std::string line)core::TCPSessionprotectedvirtual
onLineReceived(coreutils::ZString line)core::TCPSessionprotectedvirtual
onRegister()core::Socketvirtual
onRegistered() overridecore::TCPSessionprotectedvirtual
onUnregister() (defined in core::Socket)core::Socketvirtual
outcore::TCPSession
output(std::stringstream &data)core::TCPSessionvirtual
PreviousLine(int lines) (defined in core::TerminalSession)core::TerminalSession
protocol(std::string data) overridecore::ConsoleSessionprotectedvirtual
receiveData(char *buffer, int bufferLength)core::Socketprotectedvirtual
protocol(coreutils::ZString data) overridecore::ConsoleSessionprotectedvirtual
receiveData(coreutils::ZString buffer)core::Socketprotectedvirtual
reset (defined in core::Socket)core::Socket
restoreCursor() (defined in core::TerminalSession)core::TerminalSession
saveCursor() (defined in core::TerminalSession)core::TerminalSession
needsToWrite () - - + + - - - - - - + + + + + + @@ -242,8 +242,8 @@ int  - - + +

Protected Member Functions

void protocol (std::string data) override
 
void protocol (coreutils::ZString data) override
 
- Protected Member Functions inherited from core::TCPSession
virtual void onRegistered () override
 Called after the socket has been registered with epoll processing.
 
virtual void onDataReceived (char *data, int len) override
 
virtual void onLineReceived (std::string line)
 
virtual void onBlockReceived (std::string block)
 
virtual void onDataReceived (coreutils::ZString data) override
 
virtual void onLineReceived (coreutils::ZString line)
 
virtual void onBlockReceived (coreutils::ZString block)
 
virtual void onConnected ()
 
void setBlockSize (int size=0)
getBufferSize ()virtual void onDataReceived (std::string data)
 Called when data is received from the socket. More...
 
virtual void receiveData (char *buffer, int bufferLength)
 
virtual void receiveData (coreutils::ZString buffer)
 
@@ -281,10 +281,10 @@ bool 

Additional Inherited Members

shutDown = false<

Detailed Description

ConsoleSession

-

Extends the session parameters for this TCPSocket derived object. Extend the 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 TCPSocket derived object. Extend the protocol() method in order to define the behavior and protocol interaction for this socket which is a console session.

Member Function Documentation

- -

◆ protocol()

+ +

◆ protocol()

@@ -295,8 +295,8 @@ bool 
shutDown = false<
void core::ConsoleSession::protocol (std::string data = "")coreutils::ZString data)
@@ -309,7 +309,7 @@ bool shutDown = false<

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 'commands' added to the server object using the processRequest method on the session input.

When data is received within the session two modes are available to pass the data through the protocol method: LINE or BLOCK.

-

Reimplemented from core::TCPSession.

+

Reimplemented from core::TCPSession.

diff --git a/html/classcore_1_1EPoll-members.html b/html/classcore_1_1EPoll-members.html index b3f4c0e..bdbae36 100644 --- a/html/classcore_1_1EPoll-members.html +++ b/html/classcore_1_1EPoll-members.html @@ -72,7 +72,7 @@ $(function() {

This is the complete list of members for core::EPoll, including all inherited members.

- + @@ -80,7 +80,7 @@ $(function() { - + diff --git a/html/classcore_1_1EPoll.html b/html/classcore_1_1EPoll.html index 2db4d65..f35dd04 100644 --- a/html/classcore_1_1EPoll.html +++ b/html/classcore_1_1EPoll.html @@ -123,15 +123,15 @@ Public Member Functions - - - + + + - - + + @@ -259,8 +259,8 @@ std::string  - -

◆ processCommand()

+ +

◆ processCommand()

@@ -271,7 +271,7 @@ std::string 
- + @@ -300,7 +300,7 @@ std::string 

Output the threads array to the console.

-

The processCommand() method displays the thread array to the requesting console via the session passed as parameter.

+

The processCommand() method displays the thread array to the requesting console via the session passed as parameter.

Parameters
check(std::string request)core::Commandvirtual
check(coreutils::ZString request)core::Commandvirtual
EPoll()core::EPoll
eventReceived(struct epoll_event event)core::EPoll
getDescriptor()core::EPoll
isStopping()core::EPoll
maxSocketscore::EPoll
output(Session *session)core::Commandvirtual
processCommand(std::string command, TCPSession *session, std::stringstream &data) overridecore::EPollvirtual
processCommand(coreutils::ZString command, TCPSession *session, std::stringstream &data) overridecore::EPollvirtual
registerSocket(Socket *socket)core::EPoll
resetSocket(Socket *socket) (defined in core::EPoll)core::EPoll
setName(std::string name)core::Command
void eventReceived (struct epoll_event event)
 Dispatch event to appropriate socket. More...
 
int processCommand (std::string command, TCPSession *session, std::stringstream &data) override
 Output the threads array to the console. More...
 
int processCommand (coreutils::ZString command, TCPSession *session, std::stringstream &data) override
 Output the threads array to the console. More...
 
void resetSocket (Socket *socket)
 
- Public Member Functions inherited from core::Command
virtual bool check (std::string request)
 
virtual bool check (coreutils::ZString request)
 
virtual void output (Session *session)
 
void setName (std::string name)
tag tag int core::EPoll::processCommand (std::string coreutils::ZString  command,
tag
@@ -308,7 +308,7 @@ std::string  -

Reimplemented from core::Command.

+

Reimplemented from core::Command.

diff --git a/html/classcore_1_1INotify-members.html b/html/classcore_1_1INotify-members.html index 40cdcec..d9f3b5d 100644 --- a/html/classcore_1_1INotify-members.html +++ b/html/classcore_1_1INotify-members.html @@ -86,7 +86,7 @@ $(function() { - + diff --git a/html/classcore_1_1INotify.html b/html/classcore_1_1INotify.html index 49e8669..e158013 100644 --- a/html/classcore_1_1INotify.html +++ b/html/classcore_1_1INotify.html @@ -106,9 +106,9 @@ int  - - + + diff --git a/html/classcore_1_1Socket-members.html b/html/classcore_1_1Socket-members.html index 154c86f..99bf979 100644 --- a/html/classcore_1_1Socket-members.html +++ b/html/classcore_1_1Socket-members.html @@ -79,13 +79,13 @@ $(function() { - + - + diff --git a/html/classcore_1_1Socket.html b/html/classcore_1_1Socket.html index a07f9ac..ab1dc99 100644 --- a/html/classcore_1_1Socket.html +++ b/html/classcore_1_1Socket.html @@ -178,11 +178,11 @@ int  - - - - + + + +
sessionthe session to write the requested data to.
tag
inMoveSelf(std::string name) (defined in core::INotify)core::INotifyinlinevirtual
inOpen(std::string name) (defined in core::INotify)core::INotifyinlinevirtual
INotify(EPoll &ePoll) (defined in core::INotify)core::INotify
onDataReceived(char *buffer, int len) override (defined in core::INotify)core::INotifyvirtual
onDataReceived(coreutils::ZString data) override (defined in core::INotify)core::INotifyvirtual
core::Socket::onDataReceived(std::string data)core::Socketprivatevirtual
removeWatch(int wd) (defined in core::INotify)core::INotify
~INotify() (defined in core::INotify)core::INotify
addWatch (std::str
void removeWatch (int wd)
 
-void onDataReceived (char *buffer, int len) override
 
+void onDataReceived (coreutils::ZString data) override
 
virtual void inAccess (std::string name)
 
name (defined in core::Object)core::Object
needsToWrite() (defined in core::Socket)core::Socket
onDataReceived(std::string data)core::Socketprotectedvirtual
onDataReceived(char *buffer, int len) (defined in core::Socket)core::Socketprotectedvirtual
onDataReceived(coreutils::ZString data) (defined in core::Socket)core::Socketprotectedvirtual
onRegister()core::Socketvirtual
onRegistered()core::Socketvirtual
onUnregister() (defined in core::Socket)core::Socketvirtual
onUnregistered()core::Socketvirtual
output(std::stringstream &out) (defined in core::Socket)core::Socket
receiveData(char *buffer, int bufferLength)core::Socketprotectedvirtual
receiveData(coreutils::ZString buffer)core::Socketprotectedvirtual
reset (defined in core::Socket)core::Socket
setBufferSize(int length) (defined in core::Socket)core::Socketprotected
setDescriptor(int descriptor)core::Socket
getBufferSize ()virtual void onDataReceived (std::string data)
 Called when data is received from the socket. More...
 
-virtual void onDataReceived (char *buffer, int len)
 
virtual void receiveData (char *buffer, int bufferLength)
 
+virtual void onDataReceived (coreutils::ZString data)
 
virtual void receiveData (coreutils::ZString buffer)
 
@@ -374,8 +374,8 @@ bool  - - - - - + + - - - - - - -

Protected Attributes

shutDown = false< - -

◆ receiveData()

+ +

◆ receiveData()

@@ -386,19 +386,9 @@ bool 
shutDown = false<
void core::Socket::receiveData (char * buffer,
coreutils::ZString buffer) int bufferLength 
)
@@ -409,7 +399,7 @@ bool shutDown = false<

receiveData 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 core::TLSSession.

+

Reimplemented in core::TLSSession.

diff --git a/html/classcore_1_1TCPServer-members.html b/html/classcore_1_1TCPServer-members.html index d1e8ede..60a8487 100644 --- a/html/classcore_1_1TCPServer-members.html +++ b/html/classcore_1_1TCPServer-members.html @@ -73,7 +73,7 @@ $(function() {

This is the complete list of members for core::TCPServer, including all inherited members.

- + @@ -86,7 +86,7 @@ $(function() { - + @@ -94,8 +94,8 @@ $(function() { - - + + diff --git a/html/classcore_1_1TCPServer.html b/html/classcore_1_1TCPServer.html index 7a7b058..69c0055 100644 --- a/html/classcore_1_1TCPServer.html +++ b/html/classcore_1_1TCPServer.html @@ -180,8 +180,8 @@ virtual void  - - + + @@ -220,8 +220,8 @@ std::string  - - + + @@ -229,11 +229,11 @@ void  - - - - + + + +
blackListcore::TCPServer
check(std::string request)core::Commandvirtual
check(coreutils::ZString request)core::Commandvirtual
commandscore::TCPServer
connect(IPAddress &address) (defined in core::TCPSocket)core::TCPSocket
ePoll (defined in core::Socket)core::Socketprotected
name (defined in core::Object)core::Object
needsToWrite() (defined in core::Socket)core::Socket
onDataReceived(std::string data) overridecore::TCPServerprotectedvirtual
onDataReceived(char *buffer, int len) (defined in core::Socket)core::Socketprotectedvirtual
onDataReceived(coreutils::ZString data) (defined in core::Socket)core::Socketprotectedvirtual
onRegister()core::Socketvirtual
onRegistered()core::Socketvirtual
onUnregister() (defined in core::Socket)core::Socketvirtual
output(TCPSession *session)core::TCPServer
core::TCPSocket::output(std::stringstream &out)core::TCPSocketvirtual
core::Command::output(Session *session)core::Commandvirtual
processCommand(std::string command, TCPSession *session, std::stringstream &data) overridecore::TCPServerprotectedvirtual
receiveData(char *buffer, int bufferLength)core::Socketprotectedvirtual
processCommand(coreutils::ZString command, TCPSession *session, std::stringstream &data) overridecore::TCPServerprotectedvirtual
receiveData(coreutils::ZString buffer)core::Socketprotectedvirtual
removeFromSessionList(TCPSession *session) (defined in core::TCPServer)core::TCPServer
reset (defined in core::Socket)core::Socket
sessionErrorHandler(std::string errorString, std::stringstream &out) (defined in core::TCPServer)core::TCPServervirtual
onUnregister< bool needsToWrite ()
 
- Public Member Functions inherited from core::Command
virtual bool check (std::string request)
 
virtual bool check (coreutils::ZString request)
 
virtual void output (Session *session)
 
void setName (std::string name)
tag
void onDataReceived (std::string data) override
 
int processCommand (std::string command, TCPSession *session, std::stringstream &data) override
 
int processCommand (coreutils::ZString command, TCPSession *session, std::stringstream &data) override
 
- Protected Member Functions inherited from core::Socket
void setBufferSize (int length)
setBufferSize (in
int getBufferSize ()
 
-virtual void onDataReceived (char *buffer, int len)
 
virtual void receiveData (char *buffer, int bufferLength)
 
+virtual void onDataReceived (coreutils::ZString data)
 
virtual void receiveData (coreutils::ZString buffer)
 
@@ -380,8 +380,8 @@ bool  - + @@ -427,7 +427,7 @@ bool  - + - + - + - - + + diff --git a/html/classcore_1_1TCPSession.html b/html/classcore_1_1TCPSession.html index cbacc94..41e1bd8 100644 --- a/html/classcore_1_1TCPSession.html +++ b/html/classcore_1_1TCPSession.html @@ -204,16 +204,16 @@ Protected Member Functions virtual void  - - - - - - + + + + + + - - + + @@ -226,8 +226,8 @@ int  - - + +

Additional Inherited Members

shutDown = false< - -

◆ processCommand()

+ +

◆ processCommand()

@@ -392,7 +392,7 @@ bool 
shutDown = false<
int core::TCPServer::processCommand (std::string coreutils::ZString  command,
shutDown = false< -

Reimplemented from core::Command.

+

Reimplemented from core::Command.

diff --git a/html/classcore_1_1TCPSession-members.html b/html/classcore_1_1TCPSession-members.html index 9074e58..e4f6c07 100644 --- a/html/classcore_1_1TCPSession-members.html +++ b/html/classcore_1_1TCPSession-members.html @@ -81,19 +81,19 @@ $(function() {
ipAddress (defined in core::TCPSocket)core::TCPSocket
name (defined in core::Object)core::Object
needsToWrite() (defined in core::Socket)core::Socket
onBlockReceived(std::string block)core::TCPSessionprotectedvirtual
onBlockReceived(coreutils::ZString block)core::TCPSessionprotectedvirtual
onConnected()core::TCPSessionprotectedvirtual
onDataReceived(char *data, int len) overridecore::TCPSessionprotectedvirtual
onDataReceived(coreutils::ZString data) overridecore::TCPSessionprotectedvirtual
core::TCPSocket::onDataReceived(std::string data)core::Socketprotectedvirtual
onLineReceived(std::string line)core::TCPSessionprotectedvirtual
onLineReceived(coreutils::ZString line)core::TCPSessionprotectedvirtual
onRegister()core::Socketvirtual
onRegistered() overridecore::TCPSessionprotectedvirtual
onUnregister() (defined in core::Socket)core::Socketvirtual
onUnregistered()core::Socketvirtual
outcore::TCPSession
output(std::stringstream &data)core::TCPSessionvirtual
protocol(std::string data)core::TCPSessionprotectedvirtual
receiveData(char *buffer, int bufferLength)core::Socketprotectedvirtual
protocol(coreutils::ZString data)core::TCPSessionprotectedvirtual
receiveData(coreutils::ZString buffer)core::Socketprotectedvirtual
reset (defined in core::Socket)core::Socket
send()core::TCPSession
sendToAll()core::TCPSession
onRegistered () override
 Called after the socket has been registered with epoll processing.
 
virtual void onDataReceived (char *data, int len) override
 
virtual void onLineReceived (std::string line)
 
virtual void onBlockReceived (std::string block)
 
virtual void onDataReceived (coreutils::ZString data) override
 
virtual void onLineReceived (coreutils::ZString line)
 
virtual void onBlockReceived (coreutils::ZString block)
 
virtual void onConnected ()
 
virtual void protocol (std::string data)
 
virtual void protocol (coreutils::ZString data)
 
void setBlockSize (int size=0)
 
- Protected Member Functions inherited from core::Socket
getBufferSize ()virtual void onDataReceived (std::string data)
 Called when data is received from the socket. More...
 
virtual void receiveData (char *buffer, int bufferLength)
 
virtual void receiveData (coreutils::ZString buffer)
 
@@ -243,8 +243,8 @@ bool  - + @@ -296,8 +296,8 @@ bool  - - - - - + + - - - - - - -

Additional Inherited Members

shutDown = false<

TCPSession

TCPSession defines the nature of the interaction with the client and stores persistent data for a defined session. TCPSession objects are not sockets but instead provide a communications control mechanism. Protocol conversations are provided through extensions from this object.

Member Function Documentation

- -

◆ onBlockReceived()

+ +

◆ onBlockReceived()

@@ -255,7 +255,7 @@ bool 
shutDown = false<
void core::TCPSession::onBlockReceived (std::string coreutils::ZString  block)
shutDown = false< - -

◆ onDataReceived()

+ +

◆ onDataReceived()

@@ -308,19 +308,9 @@ bool 
shutDown = false<
void core::TCPSession::onDataReceived (char * data,
coreutils::ZString data) int len 
)
@@ -335,8 +325,8 @@ bool shutDown = false< - -

◆ onLineReceived()

+ +

◆ onLineReceived()

@@ -347,7 +337,7 @@ bool shutDown = false< void core::TCPSession::onLineReceived ( - std::string  + coreutils::ZString  line) @@ -393,8 +383,8 @@ bool shutDown = false<
- -

◆ protocol()

+ +

◆ protocol()

@@ -405,8 +395,8 @@ bool shutDown = false< void core::TCPSession::protocol ( - std::string  - data = "") + coreutils::ZString  + data) @@ -419,7 +409,7 @@ bool shutDown = false<

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 'commands' added to the server object using the processRequest method on the session input.

When data is received within the session two modes are available to pass the data through the protocol method: LINE or BLOCK.

-

Reimplemented in core::TLSSession, and core::ConsoleSession.

+

Reimplemented in core::TLSSession, and core::ConsoleSession.

diff --git a/html/classcore_1_1TCPSocket-members.html b/html/classcore_1_1TCPSocket-members.html index 5fbb1fc..2d8cbaa 100644 --- a/html/classcore_1_1TCPSocket-members.html +++ b/html/classcore_1_1TCPSocket-members.html @@ -81,13 +81,13 @@ $(function() { name (defined in core::Object)core::Object needsToWrite() (defined in core::Socket)core::Socket onDataReceived(std::string data)core::Socketprotectedvirtual - onDataReceived(char *buffer, int len) (defined in core::Socket)core::Socketprotectedvirtual + onDataReceived(coreutils::ZString data) (defined in core::Socket)core::Socketprotectedvirtual onRegister()core::Socketvirtual onRegistered()core::Socketvirtual onUnregister() (defined in core::Socket)core::Socketvirtual onUnregistered()core::Socketvirtual output(std::stringstream &out)core::TCPSocketvirtual - receiveData(char *buffer, int bufferLength)core::Socketprotectedvirtual + receiveData(coreutils::ZString buffer)core::Socketprotectedvirtual reset (defined in core::Socket)core::Socket setBufferSize(int length) (defined in core::Socket)core::Socketprotected setDescriptor(int descriptor)core::Socket diff --git a/html/classcore_1_1TCPSocket.html b/html/classcore_1_1TCPSocket.html index 45f10a8..4beab67 100644 --- a/html/classcore_1_1TCPSocket.html +++ b/html/classcore_1_1TCPSocket.html @@ -191,11 +191,11 @@ int getBufferSize ()virtual void onDataReceived (std::string data)  Called when data is received from the socket. More...
  - -virtual void onDataReceived (char *buffer, int len) -  -virtual void receiveData (char *buffer, int bufferLength) -  + +virtual void onDataReceived (coreutils::ZString data) +  +virtual void receiveData (coreutils::ZString buffer) +  - Protected Attributes inherited from core::Socket EPoll & ePoll diff --git a/html/classcore_1_1TLSServer-members.html b/html/classcore_1_1TLSServer-members.html index 5042247..cdc2421 100644 --- a/html/classcore_1_1TLSServer-members.html +++ b/html/classcore_1_1TLSServer-members.html @@ -73,7 +73,7 @@ $(function() {

This is the complete list of members for core::TLSServer, including all inherited members.

- + @@ -88,7 +88,7 @@ $(function() { - + @@ -96,8 +96,8 @@ $(function() { - - + + diff --git a/html/classcore_1_1TLSServer.html b/html/classcore_1_1TLSServer.html index 974028f..b728594 100644 --- a/html/classcore_1_1TLSServer.html +++ b/html/classcore_1_1TLSServer.html @@ -187,8 +187,8 @@ virtual void  - - + + @@ -232,8 +232,8 @@ Additional Inherited Members - - + + @@ -241,11 +241,11 @@ void  - - - - + + + + diff --git a/html/classcore_1_1TLSSession-members.html b/html/classcore_1_1TLSSession-members.html index 2ab9414..9ecf94c 100644 --- a/html/classcore_1_1TLSSession-members.html +++ b/html/classcore_1_1TLSSession-members.html @@ -81,19 +81,19 @@ $(function() { - + - + - + - - + + diff --git a/html/classcore_1_1TLSSession.html b/html/classcore_1_1TLSSession.html index e9d2773..13e5777 100644 --- a/html/classcore_1_1TLSSession.html +++ b/html/classcore_1_1TLSSession.html @@ -113,8 +113,8 @@ Public Member Functions - - + + @@ -175,8 +175,8 @@ bool  @@ -369,7 +359,7 @@ bool  - + - + - + @@ -97,8 +97,8 @@ $(function() { - - + + diff --git a/html/classcore_1_1TerminalSession.html b/html/classcore_1_1TerminalSession.html index 5db14f1..eadcabc 100644 --- a/html/classcore_1_1TerminalSession.html +++ b/html/classcore_1_1TerminalSession.html @@ -233,16 +233,16 @@ std::string  - - - - - - + + + + + + - - + + @@ -255,8 +255,8 @@ int  - - + + diff --git a/html/classcore_1_1Timer-members.html b/html/classcore_1_1Timer-members.html index af392a8..bb05b01 100644 --- a/html/classcore_1_1Timer-members.html +++ b/html/classcore_1_1Timer-members.html @@ -75,7 +75,7 @@ $(function() { - + diff --git a/html/classcore_1_1UDPServerSocket-members.html b/html/classcore_1_1UDPServerSocket-members.html index 743f06e..df6c3a8 100644 --- a/html/classcore_1_1UDPServerSocket-members.html +++ b/html/classcore_1_1UDPServerSocket-members.html @@ -72,7 +72,7 @@ $(function() {

This is the complete list of members for core::UDPServerSocket, including all inherited members.

blackListcore::TCPServer
check(std::string request)core::Commandvirtual
check(coreutils::ZString request)core::Commandvirtual
commandscore::TCPServer
connect(IPAddress &address) (defined in core::TCPSocket)core::TCPSocket
ctx (defined in core::TLSServer)core::TLSServer
name (defined in core::Object)core::Object
needsToWrite() (defined in core::Socket)core::Socket
onDataReceived(std::string data) overridecore::TCPServerprotectedvirtual
onDataReceived(char *buffer, int len) (defined in core::Socket)core::Socketprotectedvirtual
onDataReceived(coreutils::ZString data) (defined in core::Socket)core::Socketprotectedvirtual
onRegister()core::Socketvirtual
onRegistered()core::Socketvirtual
onUnregister() (defined in core::Socket)core::Socketvirtual
output(TCPSession *session)core::TCPServer
core::TCPSocket::output(std::stringstream &out)core::TCPSocketvirtual
core::Command::output(Session *session)core::Commandvirtual
processCommand(std::string command, TCPSession *session, std::stringstream &data) overridecore::TCPServerprotectedvirtual
receiveData(char *buffer, int bufferLength)core::Socketprotectedvirtual
processCommand(coreutils::ZString command, TCPSession *session, std::stringstream &data) overridecore::TCPServerprotectedvirtual
receiveData(coreutils::ZString buffer)core::Socketprotectedvirtual
removeFromSessionList(TCPSession *session) (defined in core::TCPServer)core::TCPServer
reset (defined in core::Socket)core::Socket
sessionErrorHandler(std::string errorString, std::stringstream &out) (defined in core::TCPServer)core::TCPServervirtual
onUnregister< bool needsToWrite ()
 
- Public Member Functions inherited from core::Command
virtual bool check (std::string request)
 
virtual bool check (coreutils::ZString request)
 
virtual void output (Session *session)
 
void setName (std::string name)
- Protected Member Functions inherited from core::TCPServer
void onDataReceived (std::string data) override
 
int processCommand (std::string command, TCPSession *session, std::stringstream &data) override
 
int processCommand (coreutils::ZString command, TCPSession *session, std::stringstream &data) override
 
- Protected Member Functions inherited from core::Socket
void setBufferSize (int length)
setBufferSize (in
int getBufferSize ()
 
-virtual void onDataReceived (char *buffer, int len)
 
virtual void receiveData (char *buffer, int bufferLength)
 
+virtual void onDataReceived (coreutils::ZString data)
 
virtual void receiveData (coreutils::ZString buffer)
 
- Protected Attributes inherited from core::Socket
EPoll & ePoll
ipAddress (defined in core::TCPSocket)core::TCPSocket
name (defined in core::Object)core::Object
needsToWrite() (defined in core::Socket)core::Socket
onBlockReceived(std::string block)core::TCPSessionprotectedvirtual
onBlockReceived(coreutils::ZString block)core::TCPSessionprotectedvirtual
onConnected()core::TCPSessionprotectedvirtual
onDataReceived(char *data, int len) overridecore::TCPSessionprotectedvirtual
onDataReceived(coreutils::ZString data) overridecore::TCPSessionprotectedvirtual
core::TCPSocket::onDataReceived(std::string data)core::Socketprotectedvirtual
onLineReceived(std::string line)core::TCPSessionprotectedvirtual
onLineReceived(coreutils::ZString line)core::TCPSessionprotectedvirtual
onRegister()core::TLSSessionprotectedvirtual
onRegistered()core::TLSSessionprotectedvirtual
onUnregister() (defined in core::Socket)core::Socketvirtual
onUnregistered()core::Socketvirtual
outcore::TCPSession
output(std::stringstream &out)core::TLSSessionvirtual
protocol(std::string data) overridecore::TLSSessionvirtual
receiveData(char *buffer, int bufferLength) overridecore::TLSSessionprotectedvirtual
protocol(coreutils::ZString data) overridecore::TLSSessionvirtual
receiveData(coreutils::ZString buffer) overridecore::TLSSessionprotectedvirtual
reset (defined in core::Socket)core::Socket
send()core::TCPSession
sendToAll()core::TCPSession
 
virtual void output (std::stringstream &out)
 
virtual void protocol (std::string data) override
 
virtual void protocol (coreutils::ZString data) override
 
- Public Member Functions inherited from core::TCPSession
 TCPSession (EPoll &ePoll, TCPServer &server, std::string text="")
needsToWrite () - - + + @@ -185,12 +185,12 @@ void  - - - - - - + + + + + + @@ -304,8 +304,8 @@ bool  - + @@ -330,12 +330,12 @@ bool  - - - - - + + - - - - - - -

Protected Member Functions

void receiveData (char *buffer, int bufferLength) override
 
void receiveData (coreutils::ZString buffer) override
 
void onRegister ()
 Called before the socket has registered with the epoll processing. More...
 
 Called after the socket has been registered with epoll processing.
 
- Protected Member Functions inherited from core::TCPSession
virtual void onDataReceived (char *data, int len) override
 
virtual void onLineReceived (std::string line)
 
virtual void onBlockReceived (std::string block)
 
virtual void onDataReceived (coreutils::ZString data) override
 
virtual void onLineReceived (coreutils::ZString line)
 
virtual void onBlockReceived (coreutils::ZString block)
 
virtual void onConnected ()
 
void setBlockSize (int size=0)
shutDown = false< - -

◆ protocol()

+ +

◆ protocol()

@@ -316,7 +316,7 @@ bool 
shutDown = false<
void core::TLSSession::protocol (std::string coreutils::ZString  data)
shutDown = false<

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 'commands' added to the server object using the processRequest method on the session input.

When data is received within the session two modes are available to pass the data through the protocol method: LINE or BLOCK.

-

Reimplemented from core::TCPSession.

+

Reimplemented from core::TCPSession.

- -

◆ receiveData()

+ +

◆ receiveData()

@@ -346,19 +346,9 @@ bool 
shutDown = false<
void core::TLSSession::receiveData (char * buffer,
coreutils::ZString buffer) int bufferLength 
)
shutDown = false<

receiveData 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 core::Socket.

+

Reimplemented from core::Socket.

diff --git a/html/classcore_1_1TerminalSession-members.html b/html/classcore_1_1TerminalSession-members.html index 6c03e34..0999c39 100644 --- a/html/classcore_1_1TerminalSession-members.html +++ b/html/classcore_1_1TerminalSession-members.html @@ -85,11 +85,11 @@ $(function() {
name (defined in core::Object)core::Object
needsToWrite() (defined in core::Socket)core::Socket
NextLine(int lines) (defined in core::TerminalSession)core::TerminalSession
onBlockReceived(std::string block)core::TCPSessionprotectedvirtual
onBlockReceived(coreutils::ZString block)core::TCPSessionprotectedvirtual
onConnected()core::TCPSessionprotectedvirtual
onDataReceived(char *data, int len) overridecore::TCPSessionprotectedvirtual
onDataReceived(coreutils::ZString data) overridecore::TCPSessionprotectedvirtual
core::TCPSocket::onDataReceived(std::string data)core::Socketprotectedvirtual
onLineReceived(std::string line)core::TCPSessionprotectedvirtual
onLineReceived(coreutils::ZString line)core::TCPSessionprotectedvirtual
onRegister()core::Socketvirtual
onRegistered() overridecore::TCPSessionprotectedvirtual
onUnregister() (defined in core::Socket)core::Socketvirtual
outcore::TCPSession
output(std::stringstream &data)core::TCPSessionvirtual
PreviousLine(int lines) (defined in core::TerminalSession)core::TerminalSession
protocol(std::string data)core::TCPSessionprotectedvirtual
receiveData(char *buffer, int bufferLength)core::Socketprotectedvirtual
protocol(coreutils::ZString data)core::TCPSessionprotectedvirtual
receiveData(coreutils::ZString buffer)core::Socketprotectedvirtual
reset (defined in core::Socket)core::Socket
restoreCursor() (defined in core::TerminalSession)core::TerminalSession
saveCursor() (defined in core::TerminalSession)core::TerminalSession
tagonRegistered () override
 Called after the socket has been registered with epoll processing.
 
virtual void onDataReceived (char *data, int len) override
 
virtual void onLineReceived (std::string line)
 
virtual void onBlockReceived (std::string block)
 
virtual void onDataReceived (coreutils::ZString data) override
 
virtual void onLineReceived (coreutils::ZString line)
 
virtual void onBlockReceived (coreutils::ZString block)
 
virtual void onConnected ()
 
virtual void protocol (std::string data)
 
virtual void protocol (coreutils::ZString data)
 
void setBlockSize (int size=0)
 
- Protected Member Functions inherited from core::Socket
getBufferSize ()virtual void onDataReceived (std::string data)
 Called when data is received from the socket. More...
 
virtual void receiveData (char *buffer, int bufferLength)
 
virtual void receiveData (coreutils::ZString buffer)
 
- Protected Attributes inherited from core::Socket
EPoll & ePoll
clearTimer()core::Timer
getElapsed()core::Timer
getEpoch() (defined in core::Timer)core::Timer
onDataReceived(char *buffer, int len) (defined in core::Socket)core::Socketprivatevirtual
onDataReceived(coreutils::ZString data) (defined in core::Socket)core::Socketprivatevirtual
onTimeout()=0core::Timerprotectedpure virtual
setTimer(double delay)core::Timer
Timer(EPoll &ePoll) (defined in core::Timer)core::Timer
- + @@ -81,7 +81,7 @@ $(function() { - + @@ -89,8 +89,8 @@ $(function() { - - + + diff --git a/html/classcore_1_1UDPServerSocket.html b/html/classcore_1_1UDPServerSocket.html index 2f8afd3..e028bc1 100644 --- a/html/classcore_1_1UDPServerSocket.html +++ b/html/classcore_1_1UDPServerSocket.html @@ -154,10 +154,10 @@ virtual void  - - - - + + + + @@ -181,11 +181,11 @@ void  - - - - + + + +
check(std::string request)core::Commandvirtual
check(coreutils::ZString request)core::Commandvirtual
ePoll (defined in core::Socket)core::Socketprotected
eventReceived(struct epoll_event event)core::Socket
getBufferSize() (defined in core::Socket)core::Socketprotected
name (defined in core::Object)core::Object
needsToWrite() (defined in core::Socket)core::Socket
onDataReceived(std::string data) overridecore::UDPServerSocketprotectedvirtual
onDataReceived(char *buffer, int len) (defined in core::Socket)core::Socketprotectedvirtual
onDataReceived(coreutils::ZString data) (defined in core::Socket)core::Socketprotectedvirtual
onRegister()core::Socketvirtual
onRegistered()core::Socketvirtual
onUnregister() (defined in core::Socket)core::Socketvirtual
output(std::stringstream &out) (defined in core::Socket)core::Socket
core::Command::output(Session *session)core::Commandvirtual
processCommand(std::string request, std::stringstream &data) (defined in core::UDPServerSocket)core::UDPServerSocketprotected
core::Command::processCommand(std::string request, TCPSession *session, std::stringstream &data)core::Commandvirtual
receiveData(char *buffer, int bufferLength)core::Socketprotectedvirtual
core::Command::processCommand(coreutils::ZString request, TCPSession *session, std::stringstream &data)core::Commandvirtual
receiveData(coreutils::ZString buffer)core::Socketprotectedvirtual
reset (defined in core::Socket)core::Socket
sessions (defined in core::UDPServerSocket)core::UDPServerSocketprotected
setBufferSize(int length) (defined in core::Socket)core::Socketprotected
onUnregister< bool needsToWrite ()
 
- Public Member Functions inherited from core::Command
virtual bool check (std::string request)
 
virtual int processCommand (std::string request, TCPSession *session, std::stringstream &data)
 
virtual bool check (coreutils::ZString request)
 
virtual int processCommand (coreutils::ZString request, TCPSession *session, std::stringstream &data)
 
virtual void output (Session *session)
 
void setName (std::string name)
setBufferSize (in
int getBufferSize ()
 
-virtual void onDataReceived (char *buffer, int len)
 
virtual void receiveData (char *buffer, int bufferLength)
 
+virtual void onDataReceived (coreutils::ZString data)
 
virtual void receiveData (coreutils::ZString buffer)
 
diff --git a/html/classcore_1_1UDPSocket-members.html b/html/classcore_1_1UDPSocket-members.html index bebe9b5..68c899a 100644 --- a/html/classcore_1_1UDPSocket-members.html +++ b/html/classcore_1_1UDPSocket-members.html @@ -79,13 +79,13 @@ $(function() { - + - + diff --git a/html/classcore_1_1UDPSocket.html b/html/classcore_1_1UDPSocket.html index 62634c9..4cb45dd 100644 --- a/html/classcore_1_1UDPSocket.html +++ b/html/classcore_1_1UDPSocket.html @@ -167,11 +167,11 @@ int  - - - - + + + + diff --git a/html/functions.html b/html/functions.html index 8c3c68e..ed81b8e 100644 --- a/html/functions.html +++ b/html/functions.html @@ -79,7 +79,7 @@ $(function() {

- c -

  • check() -: core::Command +: core::Command
  • clear() : core::TerminalSession @@ -151,7 +151,7 @@ $(function() {

    - o -

    • onBlockReceived() -: core::TCPSession +: core::TCPSession
    • onConnected() : core::TCPSession @@ -159,11 +159,11 @@ $(function() {
    • onDataReceived() : core::Socket , core::TCPServer -, core::TCPSession +, core::TCPSession , core::UDPServerSocket
    • onLineReceived() -: core::TCPSession +: core::TCPSession
    • onRegister() : core::Socket @@ -195,26 +195,25 @@ $(function() {

      - p -

      - r -

      • receiveData() -: core::Socket -, core::TLSSession +: core::Socket +, core::TLSSession
      • registerSocket() : core::EPoll diff --git a/html/functions_func.html b/html/functions_func.html index e90bf91..f4ae7e2 100644 --- a/html/functions_func.html +++ b/html/functions_func.html @@ -72,7 +72,7 @@ $(function() {

        - c -

        • check() -: core::Command +: core::Command
        • clear() : core::TerminalSession @@ -133,7 +133,7 @@ $(function() {

          - o -

          • onBlockReceived() -: core::TCPSession +: core::TCPSession
          • onConnected() : core::TCPSession @@ -141,11 +141,11 @@ $(function() {
          • onDataReceived() : core::Socket , core::TCPServer -, core::TCPSession +, core::TCPSession , core::UDPServerSocket
          • onLineReceived() -: core::TCPSession +: core::TCPSession
          • onRegister() : core::Socket @@ -174,26 +174,25 @@ $(function() {

            - p -

            - r -

            • receiveData() -: core::Socket -, core::TLSSession +: core::Socket +, core::TLSSession
            • registerSocket() : core::EPoll diff --git a/html/search/all_2.js b/html/search/all_2.js index 6d4f29d..7439c14 100644 --- a/html/search/all_2.js +++ b/html/search/all_2.js @@ -1,6 +1,6 @@ var searchData= [ - ['check_2',['check',['../classcore_1_1Command.html#abdc0d7a4693a7f7940bbae20c4a667c0',1,'core::Command']]], + ['check_2',['check',['../classcore_1_1Command.html#af9b8d8b3a6d6566f86e0abcb0d10f905',1,'core::Command']]], ['clear_3',['clear',['../classcore_1_1TerminalSession.html#a42bb06857891220a831da04248233935',1,'core::TerminalSession']]], ['cleareol_4',['clearEOL',['../classcore_1_1TerminalSession.html#aa660768eed03b0b996a749e8a146446c',1,'core::TerminalSession']]], ['cleartimer_5',['clearTimer',['../classcore_1_1Timer.html#a8e063f46e89dac04364871e909ab940a',1,'core::Timer']]], diff --git a/html/search/all_7.js b/html/search/all_7.js index 622230f..ae229a5 100644 --- a/html/search/all_7.js +++ b/html/search/all_7.js @@ -1,10 +1,10 @@ var searchData= [ ['object_25',['Object',['../classcore_1_1Object.html',1,'core']]], - ['onblockreceived_26',['onBlockReceived',['../classcore_1_1TCPSession.html#a4403ef0a92b119dfa2e74667788e4ba1',1,'core::TCPSession']]], + ['onblockreceived_26',['onBlockReceived',['../classcore_1_1TCPSession.html#ada0eb595b5c506ae2f74851fd1588512',1,'core::TCPSession']]], ['onconnected_27',['onConnected',['../classcore_1_1TCPSession.html#a8719952f7bb00bf7239ec40aa2868626',1,'core::TCPSession']]], - ['ondatareceived_28',['onDataReceived',['../classcore_1_1Socket.html#ac8d6a2c54696eb6fc2024cf6bcf6b4e5',1,'core::Socket::onDataReceived()'],['../classcore_1_1TCPServer.html#a276ccbc8cb9b4380ebd78807b97f0159',1,'core::TCPServer::onDataReceived()'],['../classcore_1_1TCPSession.html#ac2c3ffef9ded12a8867e3d27902b001a',1,'core::TCPSession::onDataReceived()'],['../classcore_1_1UDPServerSocket.html#a41933ca153c854a800e3d047ab18313e',1,'core::UDPServerSocket::onDataReceived()']]], - ['onlinereceived_29',['onLineReceived',['../classcore_1_1TCPSession.html#a0f209620e9f11e70bfde54852b5c5460',1,'core::TCPSession']]], + ['ondatareceived_28',['onDataReceived',['../classcore_1_1Socket.html#ac8d6a2c54696eb6fc2024cf6bcf6b4e5',1,'core::Socket::onDataReceived()'],['../classcore_1_1TCPServer.html#a276ccbc8cb9b4380ebd78807b97f0159',1,'core::TCPServer::onDataReceived()'],['../classcore_1_1TCPSession.html#a6683cc5b39d3e47adc9ead3f3e3d7587',1,'core::TCPSession::onDataReceived()'],['../classcore_1_1UDPServerSocket.html#a41933ca153c854a800e3d047ab18313e',1,'core::UDPServerSocket::onDataReceived()']]], + ['onlinereceived_29',['onLineReceived',['../classcore_1_1TCPSession.html#a018d0458806811b98e4aa30da27a1a2d',1,'core::TCPSession']]], ['onregister_30',['onRegister',['../classcore_1_1Socket.html#a81e5ee3e17834166d97c6e8b7dfe0da0',1,'core::Socket::onRegister()'],['../classcore_1_1TLSSession.html#a76cec7cf4851eb27abe77a2339344c6d',1,'core::TLSSession::onRegister()']]], ['onregistered_31',['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()']]], ['ontimeout_32',['onTimeout',['../classcore_1_1Timer.html#ae51704ff08d985bbc30e3ff4c9b3c6ca',1,'core::Timer']]], diff --git a/html/search/all_8.js b/html/search/all_8.js index ce6cf40..7944a2c 100644 --- a/html/search/all_8.js +++ b/html/search/all_8.js @@ -1,6 +1,6 @@ var searchData= [ - ['processcommand_36',['processCommand',['../classcore_1_1Command.html#a068ebc22f7a067cf23ed2c17f95b06e9',1,'core::Command::processCommand()'],['../classcore_1_1CommandList.html#a98939555ca061b445019a841726e3ef6',1,'core::CommandList::processCommand()'],['../classcore_1_1EPoll.html#a0c2d7fdaec43d0a15abab0399d5727df',1,'core::EPoll::processCommand()'],['../classcore_1_1TCPServer.html#a93f64f81bc63f145799af91138a064dc',1,'core::TCPServer::processCommand()']]], - ['processrequest_37',['processRequest',['../classcore_1_1CommandList.html#a589f3eba55beebad94a5978970e0650d',1,'core::CommandList']]], - ['protocol_38',['protocol',['../classcore_1_1ConsoleSession.html#a830cc1e1e0c3fe3b066f0a9f7f469490',1,'core::ConsoleSession::protocol()'],['../classcore_1_1TCPSession.html#ae90dc64e2d3c4b3239117923145edb3f',1,'core::TCPSession::protocol()'],['../classcore_1_1TLSSession.html#a547c436ab69f75307f065eca8cfcd109',1,'core::TLSSession::protocol()']]] + ['processcommand_36',['processCommand',['../classcore_1_1Command.html#ad8eecee5b179a0030d2f34bcfa30d4f4',1,'core::Command::processCommand()'],['../classcore_1_1EPoll.html#a5cb8a89fb45922c8c88472ec3eae7858',1,'core::EPoll::processCommand()'],['../classcore_1_1TCPServer.html#ad08e04a2ff44c9c40419cdc6bd0e4b79',1,'core::TCPServer::processCommand()']]], + ['processrequest_37',['processRequest',['../classcore_1_1CommandList.html#a4d0150f59f832c65f113a6a575f45c19',1,'core::CommandList']]], + ['protocol_38',['protocol',['../classcore_1_1ConsoleSession.html#a72cd8a1ed55112b7245d889a9424fd64',1,'core::ConsoleSession::protocol()'],['../classcore_1_1TCPSession.html#a4a2a34c9b1252664e93c576a27c30720',1,'core::TCPSession::protocol()'],['../classcore_1_1TLSSession.html#a2ff61cfcb3ffd3593b1bf7b39343ee56',1,'core::TLSSession::protocol()']]] ]; diff --git a/html/search/all_9.js b/html/search/all_9.js index f11b54b..57b63cf 100644 --- a/html/search/all_9.js +++ b/html/search/all_9.js @@ -1,6 +1,6 @@ var searchData= [ - ['receivedata_39',['receiveData',['../classcore_1_1Socket.html#af455ec6f793473f529507af26aa54695',1,'core::Socket::receiveData()'],['../classcore_1_1TLSSession.html#a1822cb21de545dc1a183ec0bac6cc4f0',1,'core::TLSSession::receiveData()']]], + ['receivedata_39',['receiveData',['../classcore_1_1Socket.html#a481b3b3874a6862f8d97030297cc6f32',1,'core::Socket::receiveData()'],['../classcore_1_1TLSSession.html#a4b3c2d871d83150974bba48435eaf6cf',1,'core::TLSSession::receiveData()']]], ['registersocket_40',['registerSocket',['../classcore_1_1EPoll.html#a3d813c7bbf0da70ebc8e3cb6aeeacfb4',1,'core::EPoll']]], ['remove_41',['remove',['../classcore_1_1CommandList.html#aaac684effb9ecf5238d23ca60d3fffaa',1,'core::CommandList']]] ]; diff --git a/html/search/functions_1.js b/html/search/functions_1.js index 21bed4a..79834f6 100644 --- a/html/search/functions_1.js +++ b/html/search/functions_1.js @@ -1,6 +1,6 @@ var searchData= [ - ['check_95',['check',['../classcore_1_1Command.html#abdc0d7a4693a7f7940bbae20c4a667c0',1,'core::Command']]], + ['check_95',['check',['../classcore_1_1Command.html#af9b8d8b3a6d6566f86e0abcb0d10f905',1,'core::Command']]], ['clear_96',['clear',['../classcore_1_1TerminalSession.html#a42bb06857891220a831da04248233935',1,'core::TerminalSession']]], ['cleareol_97',['clearEOL',['../classcore_1_1TerminalSession.html#aa660768eed03b0b996a749e8a146446c',1,'core::TerminalSession']]], ['cleartimer_98',['clearTimer',['../classcore_1_1Timer.html#a8e063f46e89dac04364871e909ab940a',1,'core::Timer']]] diff --git a/html/search/functions_5.js b/html/search/functions_5.js index 42e08e6..d02a1b8 100644 --- a/html/search/functions_5.js +++ b/html/search/functions_5.js @@ -1,9 +1,9 @@ var searchData= [ - ['onblockreceived_109',['onBlockReceived',['../classcore_1_1TCPSession.html#a4403ef0a92b119dfa2e74667788e4ba1',1,'core::TCPSession']]], + ['onblockreceived_109',['onBlockReceived',['../classcore_1_1TCPSession.html#ada0eb595b5c506ae2f74851fd1588512',1,'core::TCPSession']]], ['onconnected_110',['onConnected',['../classcore_1_1TCPSession.html#a8719952f7bb00bf7239ec40aa2868626',1,'core::TCPSession']]], - ['ondatareceived_111',['onDataReceived',['../classcore_1_1Socket.html#ac8d6a2c54696eb6fc2024cf6bcf6b4e5',1,'core::Socket::onDataReceived()'],['../classcore_1_1TCPServer.html#a276ccbc8cb9b4380ebd78807b97f0159',1,'core::TCPServer::onDataReceived()'],['../classcore_1_1TCPSession.html#ac2c3ffef9ded12a8867e3d27902b001a',1,'core::TCPSession::onDataReceived()'],['../classcore_1_1UDPServerSocket.html#a41933ca153c854a800e3d047ab18313e',1,'core::UDPServerSocket::onDataReceived()']]], - ['onlinereceived_112',['onLineReceived',['../classcore_1_1TCPSession.html#a0f209620e9f11e70bfde54852b5c5460',1,'core::TCPSession']]], + ['ondatareceived_111',['onDataReceived',['../classcore_1_1Socket.html#ac8d6a2c54696eb6fc2024cf6bcf6b4e5',1,'core::Socket::onDataReceived()'],['../classcore_1_1TCPServer.html#a276ccbc8cb9b4380ebd78807b97f0159',1,'core::TCPServer::onDataReceived()'],['../classcore_1_1TCPSession.html#a6683cc5b39d3e47adc9ead3f3e3d7587',1,'core::TCPSession::onDataReceived()'],['../classcore_1_1UDPServerSocket.html#a41933ca153c854a800e3d047ab18313e',1,'core::UDPServerSocket::onDataReceived()']]], + ['onlinereceived_112',['onLineReceived',['../classcore_1_1TCPSession.html#a018d0458806811b98e4aa30da27a1a2d',1,'core::TCPSession']]], ['onregister_113',['onRegister',['../classcore_1_1Socket.html#a81e5ee3e17834166d97c6e8b7dfe0da0',1,'core::Socket::onRegister()'],['../classcore_1_1TLSSession.html#a76cec7cf4851eb27abe77a2339344c6d',1,'core::TLSSession::onRegister()']]], ['onregistered_114',['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()']]], ['ontimeout_115',['onTimeout',['../classcore_1_1Timer.html#ae51704ff08d985bbc30e3ff4c9b3c6ca',1,'core::Timer']]], diff --git a/html/search/functions_6.js b/html/search/functions_6.js index fc761e0..2098b8d 100644 --- a/html/search/functions_6.js +++ b/html/search/functions_6.js @@ -1,6 +1,6 @@ var searchData= [ - ['processcommand_118',['processCommand',['../classcore_1_1Command.html#a068ebc22f7a067cf23ed2c17f95b06e9',1,'core::Command::processCommand()'],['../classcore_1_1CommandList.html#a98939555ca061b445019a841726e3ef6',1,'core::CommandList::processCommand()'],['../classcore_1_1EPoll.html#a0c2d7fdaec43d0a15abab0399d5727df',1,'core::EPoll::processCommand()'],['../classcore_1_1TCPServer.html#a93f64f81bc63f145799af91138a064dc',1,'core::TCPServer::processCommand()']]], - ['processrequest_119',['processRequest',['../classcore_1_1CommandList.html#a589f3eba55beebad94a5978970e0650d',1,'core::CommandList']]], - ['protocol_120',['protocol',['../classcore_1_1ConsoleSession.html#a830cc1e1e0c3fe3b066f0a9f7f469490',1,'core::ConsoleSession::protocol()'],['../classcore_1_1TCPSession.html#ae90dc64e2d3c4b3239117923145edb3f',1,'core::TCPSession::protocol()'],['../classcore_1_1TLSSession.html#a547c436ab69f75307f065eca8cfcd109',1,'core::TLSSession::protocol()']]] + ['processcommand_118',['processCommand',['../classcore_1_1Command.html#ad8eecee5b179a0030d2f34bcfa30d4f4',1,'core::Command::processCommand()'],['../classcore_1_1EPoll.html#a5cb8a89fb45922c8c88472ec3eae7858',1,'core::EPoll::processCommand()'],['../classcore_1_1TCPServer.html#ad08e04a2ff44c9c40419cdc6bd0e4b79',1,'core::TCPServer::processCommand()']]], + ['processrequest_119',['processRequest',['../classcore_1_1CommandList.html#a4d0150f59f832c65f113a6a575f45c19',1,'core::CommandList']]], + ['protocol_120',['protocol',['../classcore_1_1ConsoleSession.html#a72cd8a1ed55112b7245d889a9424fd64',1,'core::ConsoleSession::protocol()'],['../classcore_1_1TCPSession.html#a4a2a34c9b1252664e93c576a27c30720',1,'core::TCPSession::protocol()'],['../classcore_1_1TLSSession.html#a2ff61cfcb3ffd3593b1bf7b39343ee56',1,'core::TLSSession::protocol()']]] ]; diff --git a/html/search/functions_7.js b/html/search/functions_7.js index 89c7740..6c5ca65 100644 --- a/html/search/functions_7.js +++ b/html/search/functions_7.js @@ -1,6 +1,6 @@ var searchData= [ - ['receivedata_121',['receiveData',['../classcore_1_1Socket.html#af455ec6f793473f529507af26aa54695',1,'core::Socket::receiveData()'],['../classcore_1_1TLSSession.html#a1822cb21de545dc1a183ec0bac6cc4f0',1,'core::TLSSession::receiveData()']]], + ['receivedata_121',['receiveData',['../classcore_1_1Socket.html#a481b3b3874a6862f8d97030297cc6f32',1,'core::Socket::receiveData()'],['../classcore_1_1TLSSession.html#a4b3c2d871d83150974bba48435eaf6cf',1,'core::TLSSession::receiveData()']]], ['registersocket_122',['registerSocket',['../classcore_1_1EPoll.html#a3d813c7bbf0da70ebc8e3cb6aeeacfb4',1,'core::EPoll']]], ['remove_123',['remove',['../classcore_1_1CommandList.html#aaac684effb9ecf5238d23ca60d3fffaa',1,'core::CommandList']]] ]; diff --git a/latex/classcore_1_1Command.tex b/latex/classcore_1_1Command.tex index 19ed8a1..5b3a182 100644 --- a/latex/classcore_1_1Command.tex +++ b/latex/classcore_1_1Command.tex @@ -25,9 +25,9 @@ Collaboration diagram for core\+::Command\+:\nopagebreak \doxysubsection*{Public Member Functions} \begin{DoxyCompactItemize} \item -virtual bool \mbox{\hyperlink{classcore_1_1Command_abdc0d7a4693a7f7940bbae20c4a667c0}{check}} (std\+::string request) +virtual bool \mbox{\hyperlink{classcore_1_1Command_af9b8d8b3a6d6566f86e0abcb0d10f905}{check}} (coreutils\+::\+Z\+String request) \item -virtual int \mbox{\hyperlink{classcore_1_1Command_a068ebc22f7a067cf23ed2c17f95b06e9}{process\+Command}} (std\+::string request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session, std\+::stringstream \&data) +virtual int \mbox{\hyperlink{classcore_1_1Command_ad8eecee5b179a0030d2f34bcfa30d4f4}{process\+Command}} (coreutils\+::\+Z\+String request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session, std\+::stringstream \&data) \item virtual void \mbox{\hyperlink{classcore_1_1Command_a314aef05f78aacb802097f8ae0875291}{output}} (Session $\ast$session) \item @@ -45,15 +45,15 @@ std\+::string {\bfseries get\+Name} () Use the \mbox{\hyperlink{classcore_1_1Command}{Command}} object in combination with a \mbox{\hyperlink{classcore_1_1CommandList}{Command\+List}} object to maintain a list of functions that can be invoked as a result of processing a request. \doxysubsection{Member Function Documentation} -\mbox{\Hypertarget{classcore_1_1Command_abdc0d7a4693a7f7940bbae20c4a667c0}\label{classcore_1_1Command_abdc0d7a4693a7f7940bbae20c4a667c0}} +\mbox{\Hypertarget{classcore_1_1Command_af9b8d8b3a6d6566f86e0abcb0d10f905}\label{classcore_1_1Command_af9b8d8b3a6d6566f86e0abcb0d10f905}} \index{core::Command@{core::Command}!check@{check}} \index{check@{check}!core::Command@{core::Command}} \doxysubsubsection{\texorpdfstring{check()}{check()}} -{\footnotesize\ttfamily bool core\+::\+Command\+::check (\begin{DoxyParamCaption}\item[{std\+::string}]{request }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} +{\footnotesize\ttfamily bool core\+::\+Command\+::check (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String}]{request }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} Implement check method to provide a special check rule upon the request to see if the command should be processed. -The default rule is to verify that the first token in the request string matches the name given on the registration of the command to the \mbox{\hyperlink{classcore_1_1CommandList}{Command\+List}}. This can be overridden by implementing the \mbox{\hyperlink{classcore_1_1Command_abdc0d7a4693a7f7940bbae20c4a667c0}{check()}} method to perform the test and return the condition of the command. +The default rule is to verify that the first token in the request string matches the name given on the registration of the command to the \mbox{\hyperlink{classcore_1_1CommandList}{Command\+List}}. This can be overridden by implementing the \mbox{\hyperlink{classcore_1_1Command_af9b8d8b3a6d6566f86e0abcb0d10f905}{check()}} method to perform the test and return the condition of the command. \begin{DoxyParams}{Parameters} @@ -76,11 +76,11 @@ Specify the output that will occur to the specified session. {\em session} & The session that will receive the output. \\ \hline \end{DoxyParams} -\mbox{\Hypertarget{classcore_1_1Command_a068ebc22f7a067cf23ed2c17f95b06e9}\label{classcore_1_1Command_a068ebc22f7a067cf23ed2c17f95b06e9}} +\mbox{\Hypertarget{classcore_1_1Command_ad8eecee5b179a0030d2f34bcfa30d4f4}\label{classcore_1_1Command_ad8eecee5b179a0030d2f34bcfa30d4f4}} \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[{std\+::string}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$}]{session, }\item[{std\+::stringstream \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} +{\footnotesize\ttfamily int core\+::\+Command\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$}]{session, }\item[{std\+::stringstream \&}]{data }\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. @@ -96,7 +96,7 @@ Returns 0 if execution of the command was successful. Otherwise returns a non-\/ \end{DoxyReturn} -Reimplemented in \mbox{\hyperlink{classcore_1_1CommandList_a98939555ca061b445019a841726e3ef6}{core\+::\+Command\+List}}, \mbox{\hyperlink{classcore_1_1EPoll_a0c2d7fdaec43d0a15abab0399d5727df}{core\+::\+E\+Poll}}, and \mbox{\hyperlink{classcore_1_1TCPServer_a93f64f81bc63f145799af91138a064dc}{core\+::\+T\+C\+P\+Server}}. +Reimplemented in \mbox{\hyperlink{classcore_1_1EPoll_a5cb8a89fb45922c8c88472ec3eae7858}{core\+::\+E\+Poll}}, and \mbox{\hyperlink{classcore_1_1TCPServer_ad08e04a2ff44c9c40419cdc6bd0e4b79}{core\+::\+T\+C\+P\+Server}}. \mbox{\Hypertarget{classcore_1_1Command_ad8b0321c64838f4d5c8f93461b97cfef}\label{classcore_1_1Command_ad8b0321c64838f4d5c8f93461b97cfef}} \index{core::Command@{core::Command}!setName@{setName}} diff --git a/latex/classcore_1_1CommandList.tex b/latex/classcore_1_1CommandList.tex index ebdaec6..580ce33 100644 --- a/latex/classcore_1_1CommandList.tex +++ b/latex/classcore_1_1CommandList.tex @@ -29,14 +29,15 @@ 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_a589f3eba55beebad94a5978970e0650d}{process\+Request}} (std\+::string request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session, std\+::stringstream \&data) +bool \mbox{\hyperlink{classcore_1_1CommandList_a4d0150f59f832c65f113a6a575f45c19}{process\+Request}} (coreutils\+::\+Z\+String request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session, std\+::stringstream \&data) \item bool \mbox{\hyperlink{classcore_1_1CommandList_a40211d843807cd65f6614c17efcb00e4}{grab\+Input}} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session, \mbox{\hyperlink{classcore_1_1Command}{Command}} \&command) \item \mbox{\Hypertarget{classcore_1_1CommandList_a2bf14022331b23e0878aa9d676a90110}\label{classcore_1_1CommandList_a2bf14022331b23e0878aa9d676a90110}} void {\bfseries clear\+Grab} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session) \item -int \mbox{\hyperlink{classcore_1_1CommandList_a98939555ca061b445019a841726e3ef6}{process\+Command}} (std\+::string request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session, std\+::stringstream \&data) +\mbox{\Hypertarget{classcore_1_1CommandList_a98939555ca061b445019a841726e3ef6}\label{classcore_1_1CommandList_a98939555ca061b445019a841726e3ef6}} +int {\bfseries process\+Command} (std\+::string request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session, std\+::stringstream \&data) \end{DoxyCompactItemize} \doxysubsection*{Protected Attributes} \begin{DoxyCompactItemize} @@ -64,35 +65,13 @@ Add a new command to the command list and assign a default search value. \mbox{\ \doxysubsubsection{\texorpdfstring{grabInput()}{grabInput()}} {\footnotesize\ttfamily bool core\+::\+Command\+List\+::grab\+Input (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$}]{session, }\item[{\mbox{\hyperlink{classcore_1_1Command}{Command}} \&}]{command }\end{DoxyParamCaption})} -Use \mbox{\hyperlink{classcore_1_1CommandList_a40211d843807cd65f6614c17efcb00e4}{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_a98939555ca061b445019a841726e3ef6}\label{classcore_1_1CommandList_a98939555ca061b445019a841726e3ef6}} -\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[{std\+::string}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$}]{session, }\item[{std\+::stringstream \&}]{data }\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. - - -\begin{DoxyParams}{Parameters} -{\em request} & The request that was entered by the user to invoke this command. \\ -\hline -{\em session} & Specify the requesting session so that the execution of the command process can return its output to the session. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Returns 0 if execution of the command was successful. Otherwise returns a non-\/zero value indicating an error condition. -\end{DoxyReturn} - - -Reimplemented from \mbox{\hyperlink{classcore_1_1Command_a068ebc22f7a067cf23ed2c17f95b06e9}{core\+::\+Command}}. - -\mbox{\Hypertarget{classcore_1_1CommandList_a589f3eba55beebad94a5978970e0650d}\label{classcore_1_1CommandList_a589f3eba55beebad94a5978970e0650d}} +Use \mbox{\hyperlink{classcore_1_1CommandList_a40211d843807cd65f6614c17efcb00e4}{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_a4d0150f59f832c65f113a6a575f45c19}\label{classcore_1_1CommandList_a4d0150f59f832c65f113a6a575f45c19}} \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[{std\+::string}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$}]{session, }\item[{std\+::stringstream \&}]{data }\end{DoxyParamCaption})} +{\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}} $\ast$}]{session, }\item[{std\+::stringstream \&}]{data }\end{DoxyParamCaption})} -Use this method to apply a parsed P\+String to the command set and execute the matching parameter. The selected command will return a true on a call to \mbox{\hyperlink{classcore_1_1Command_abdc0d7a4693a7f7940bbae20c4a667c0}{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 P\+String to the command set and execute the matching parameter. The selected command will return a true on a call to \mbox{\hyperlink{classcore_1_1Command_af9b8d8b3a6d6566f86e0abcb0d10f905}{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_1ConsoleSession.tex b/latex/classcore_1_1ConsoleSession.tex index f5c843d..3b96960 100644 --- a/latex/classcore_1_1ConsoleSession.tex +++ b/latex/classcore_1_1ConsoleSession.tex @@ -34,7 +34,7 @@ void {\bfseries write\+Log} (std\+::string data) \doxysubsection*{Protected Member Functions} \begin{DoxyCompactItemize} \item -void \mbox{\hyperlink{classcore_1_1ConsoleSession_a830cc1e1e0c3fe3b066f0a9f7f469490}{protocol}} (std\+::string data) override +void \mbox{\hyperlink{classcore_1_1ConsoleSession_a72cd8a1ed55112b7245d889a9424fd64}{protocol}} (coreutils\+::\+Z\+String data) override \end{DoxyCompactItemize} \doxysubsection*{Additional Inherited Members} @@ -42,20 +42,20 @@ void \mbox{\hyperlink{classcore_1_1ConsoleSession_a830cc1e1e0c3fe3b066f0a9f7f469 \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_a830cc1e1e0c3fe3b066f0a9f7f469490}{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}{T\+C\+P\+Socket}} derived object. Extend the \mbox{\hyperlink{classcore_1_1ConsoleSession_a72cd8a1ed55112b7245d889a9424fd64}{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_a830cc1e1e0c3fe3b066f0a9f7f469490}\label{classcore_1_1ConsoleSession_a830cc1e1e0c3fe3b066f0a9f7f469490}} +\mbox{\Hypertarget{classcore_1_1ConsoleSession_a72cd8a1ed55112b7245d889a9424fd64}\label{classcore_1_1ConsoleSession_a72cd8a1ed55112b7245d889a9424fd64}} \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[{std\+::string}]{data = {\ttfamily \char`\"{}\char`\"{}} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}} +{\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]}} 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. -Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_ae90dc64e2d3c4b3239117923145edb3f}{core\+::\+T\+C\+P\+Session}}. +Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_a4a2a34c9b1252664e93c576a27c30720}{core\+::\+T\+C\+P\+Session}}. diff --git a/latex/classcore_1_1EPoll.tex b/latex/classcore_1_1EPoll.tex index c520670..0ee4a2f 100644 --- a/latex/classcore_1_1EPoll.tex +++ b/latex/classcore_1_1EPoll.tex @@ -43,7 +43,7 @@ int \mbox{\hyperlink{classcore_1_1EPoll_a1e52017e1deae15c1c87c6b6a099e1ed}{get\+ \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_a0c2d7fdaec43d0a15abab0399d5727df}{process\+Command}} (std\+::string command, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session, std\+::stringstream \&data) override +int \mbox{\hyperlink{classcore_1_1EPoll_a5cb8a89fb45922c8c88472ec3eae7858}{process\+Command}} (coreutils\+::\+Z\+String command, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session, std\+::stringstream \&data) 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) @@ -114,17 +114,17 @@ Use this method to obtain the current descriptor socket number for the epoll fun Returns a true if the stop command has been requested. -This method returns a true if the \mbox{\hyperlink{classcore_1_1EPoll_a0c2865acd31d14fbf19dbc42cc084ddc}{stop()}} method has been called and the epoll system is shutting. \mbox{\Hypertarget{classcore_1_1EPoll_a0c2d7fdaec43d0a15abab0399d5727df}\label{classcore_1_1EPoll_a0c2d7fdaec43d0a15abab0399d5727df}} +This method returns a true if the \mbox{\hyperlink{classcore_1_1EPoll_a0c2865acd31d14fbf19dbc42cc084ddc}{stop()}} method has been called and the epoll system is shutting. \mbox{\Hypertarget{classcore_1_1EPoll_a5cb8a89fb45922c8c88472ec3eae7858}\label{classcore_1_1EPoll_a5cb8a89fb45922c8c88472ec3eae7858}} \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[{std\+::string}]{command, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$}]{session, }\item[{std\+::stringstream \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}} +{\footnotesize\ttfamily int core\+::\+E\+Poll\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String}]{command, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$}]{session, }\item[{std\+::stringstream \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}} Output the threads array to the console. -The \mbox{\hyperlink{classcore_1_1EPoll_a0c2d7fdaec43d0a15abab0399d5727df}{process\+Command()}} method displays the thread array to the requesting console via the session passed as parameter. +The \mbox{\hyperlink{classcore_1_1EPoll_a5cb8a89fb45922c8c88472ec3eae7858}{process\+Command()}} method displays the thread array to the requesting console via the session passed as parameter. \begin{DoxyParams}{Parameters} @@ -133,7 +133,7 @@ The \mbox{\hyperlink{classcore_1_1EPoll_a0c2d7fdaec43d0a15abab0399d5727df}{proce \end{DoxyParams} -Reimplemented from \mbox{\hyperlink{classcore_1_1Command_a068ebc22f7a067cf23ed2c17f95b06e9}{core\+::\+Command}}. +Reimplemented from \mbox{\hyperlink{classcore_1_1Command_ad8eecee5b179a0030d2f34bcfa30d4f4}{core\+::\+Command}}. \mbox{\Hypertarget{classcore_1_1EPoll_a3d813c7bbf0da70ebc8e3cb6aeeacfb4}\label{classcore_1_1EPoll_a3d813c7bbf0da70ebc8e3cb6aeeacfb4}} \index{core::EPoll@{core::EPoll}!registerSocket@{registerSocket}} diff --git a/latex/classcore_1_1INotify.tex b/latex/classcore_1_1INotify.tex index ddff04d..8aa82f2 100644 --- a/latex/classcore_1_1INotify.tex +++ b/latex/classcore_1_1INotify.tex @@ -30,8 +30,8 @@ int {\bfseries add\+Watch} (std\+::string watch) \mbox{\Hypertarget{classcore_1_1INotify_a5ce2a1bbfd69f5a88ef807f7ed439c06}\label{classcore_1_1INotify_a5ce2a1bbfd69f5a88ef807f7ed439c06}} void {\bfseries remove\+Watch} (int wd) \item -\mbox{\Hypertarget{classcore_1_1INotify_abb1608d7ee7fe3d96cea7f83078786eb}\label{classcore_1_1INotify_abb1608d7ee7fe3d96cea7f83078786eb}} -void {\bfseries on\+Data\+Received} (char $\ast$buffer, int len) override +\mbox{\Hypertarget{classcore_1_1INotify_a934781c449fbd9171f47c34db6cac4e9}\label{classcore_1_1INotify_a934781c449fbd9171f47c34db6cac4e9}} +void {\bfseries on\+Data\+Received} (coreutils\+::\+Z\+String data) override \item \mbox{\Hypertarget{classcore_1_1INotify_a172949023698fc486d690d3b6d3d6f17}\label{classcore_1_1INotify_a172949023698fc486d690d3b6d3d6f17}} virtual void {\bfseries in\+Access} (std\+::string name) diff --git a/latex/classcore_1_1Socket.tex b/latex/classcore_1_1Socket.tex index 0867043..190a7c9 100644 --- a/latex/classcore_1_1Socket.tex +++ b/latex/classcore_1_1Socket.tex @@ -77,10 +77,10 @@ int {\bfseries get\+Buffer\+Size} () \item 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_af6c06db2441633ae9979affe72930abc}\label{classcore_1_1Socket_af6c06db2441633ae9979affe72930abc}} -virtual void {\bfseries on\+Data\+Received} (char $\ast$buffer, int len) +\mbox{\Hypertarget{classcore_1_1Socket_aa1b212533877a49c965a3aaa05f22d03}\label{classcore_1_1Socket_aa1b212533877a49c965a3aaa05f22d03}} +virtual void {\bfseries on\+Data\+Received} (coreutils\+::\+Z\+String data) \item -virtual void \mbox{\hyperlink{classcore_1_1Socket_af455ec6f793473f529507af26aa54695}{receive\+Data}} (char $\ast$buffer, int buffer\+Length) +virtual void \mbox{\hyperlink{classcore_1_1Socket_a481b3b3874a6862f8d97030297cc6f32}{receive\+Data}} (coreutils\+::\+Z\+String buffer) \end{DoxyCompactItemize} \doxysubsection*{Protected Attributes} \begin{DoxyCompactItemize} @@ -189,15 +189,15 @@ Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a76cec7cf4851eb27abe77 Called when the socket has finished unregistering for the epoll processing. -The on\+Unregistered method is called whenever the socket is unregistered with e\+Poll and socket communcation events will be stopped. The default method will close the socket and clean up the connection. If this is overridden by an extended object then the object should call this method to clean the socket up. \mbox{\Hypertarget{classcore_1_1Socket_af455ec6f793473f529507af26aa54695}\label{classcore_1_1Socket_af455ec6f793473f529507af26aa54695}} +The on\+Unregistered method is called whenever the socket is unregistered with e\+Poll and socket communcation events will be stopped. The default method will close the socket and clean up the connection. If this is overridden by an extended object then the object should call this method to clean the socket up. \mbox{\Hypertarget{classcore_1_1Socket_a481b3b3874a6862f8d97030297cc6f32}\label{classcore_1_1Socket_a481b3b3874a6862f8d97030297cc6f32}} \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[{char $\ast$}]{buffer, }\item[{int}]{buffer\+Length }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}} +{\footnotesize\ttfamily void core\+::\+Socket\+::receive\+Data (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String}]{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. -Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a1822cb21de545dc1a183ec0bac6cc4f0}{core\+::\+T\+L\+S\+Session}}. +Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a4b3c2d871d83150974bba48435eaf6cf}{core\+::\+T\+L\+S\+Session}}. \mbox{\Hypertarget{classcore_1_1Socket_ac44f6ae3196a8a3e09a6a85fcf495762}\label{classcore_1_1Socket_ac44f6ae3196a8a3e09a6a85fcf495762}} \index{core::Socket@{core::Socket}!setDescriptor@{setDescriptor}} diff --git a/latex/classcore_1_1TCPServer.tex b/latex/classcore_1_1TCPServer.tex index 9d5ac0f..32d375d 100644 --- a/latex/classcore_1_1TCPServer.tex +++ b/latex/classcore_1_1TCPServer.tex @@ -56,7 +56,7 @@ 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_a93f64f81bc63f145799af91138a064dc}{process\+Command}} (std\+::string command, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session, std\+::stringstream \&data) override +int \mbox{\hyperlink{classcore_1_1TCPServer_ad08e04a2ff44c9c40419cdc6bd0e4b79}{process\+Command}} (coreutils\+::\+Z\+String command, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session, std\+::stringstream \&data) override \end{DoxyCompactItemize} \doxysubsection*{Additional Inherited Members} @@ -131,11 +131,11 @@ Override the virtual data\+Received since for the server these are requests to a Reimplemented from \mbox{\hyperlink{classcore_1_1Socket_ac8d6a2c54696eb6fc2024cf6bcf6b4e5}{core\+::\+Socket}}. -\mbox{\Hypertarget{classcore_1_1TCPServer_a93f64f81bc63f145799af91138a064dc}\label{classcore_1_1TCPServer_a93f64f81bc63f145799af91138a064dc}} +\mbox{\Hypertarget{classcore_1_1TCPServer_ad08e04a2ff44c9c40419cdc6bd0e4b79}\label{classcore_1_1TCPServer_ad08e04a2ff44c9c40419cdc6bd0e4b79}} \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[{std\+::string}]{command, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$}]{session, }\item[{std\+::stringstream \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}} +{\footnotesize\ttfamily int core\+::\+T\+C\+P\+Server\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String}]{command, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$}]{session, }\item[{std\+::stringstream \&}]{data }\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. @@ -146,7 +146,7 @@ This method is called when the \mbox{\hyperlink{classcore_1_1Command}{Command}} \end{DoxyParams} -Reimplemented from \mbox{\hyperlink{classcore_1_1Command_a068ebc22f7a067cf23ed2c17f95b06e9}{core\+::\+Command}}. +Reimplemented from \mbox{\hyperlink{classcore_1_1Command_ad8eecee5b179a0030d2f34bcfa30d4f4}{core\+::\+Command}}. diff --git a/latex/classcore_1_1TCPSession.tex b/latex/classcore_1_1TCPSession.tex index 9902bc9..c7b5e74 100644 --- a/latex/classcore_1_1TCPSession.tex +++ b/latex/classcore_1_1TCPSession.tex @@ -55,15 +55,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_ac2c3ffef9ded12a8867e3d27902b001a}{on\+Data\+Received}} (char $\ast$data, int len) override +virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a6683cc5b39d3e47adc9ead3f3e3d7587}{on\+Data\+Received}} (coreutils\+::\+Z\+String data) override \item -virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a0f209620e9f11e70bfde54852b5c5460}{on\+Line\+Received}} (std\+::string line) +virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a018d0458806811b98e4aa30da27a1a2d}{on\+Line\+Received}} (coreutils\+::\+Z\+String line) \item -virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a4403ef0a92b119dfa2e74667788e4ba1}{on\+Block\+Received}} (std\+::string block) +virtual void \mbox{\hyperlink{classcore_1_1TCPSession_ada0eb595b5c506ae2f74851fd1588512}{on\+Block\+Received}} (coreutils\+::\+Z\+String block) \item virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a8719952f7bb00bf7239ec40aa2868626}{on\+Connected}} () \item -virtual void \mbox{\hyperlink{classcore_1_1TCPSession_ae90dc64e2d3c4b3239117923145edb3f}{protocol}} (std\+::string data) +virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a4a2a34c9b1252664e93c576a27c30720}{protocol}} (coreutils\+::\+Z\+String data) \item void \mbox{\hyperlink{classcore_1_1TCPSession_a836fb3fd5ee543ebc93262a980ae88b5}{set\+Block\+Size}} (int size=0) \end{DoxyCompactItemize} @@ -76,11 +76,11 @@ void \mbox{\hyperlink{classcore_1_1TCPSession_a836fb3fd5ee543ebc93262a980ae88b5} \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. \doxysubsection{Member Function Documentation} -\mbox{\Hypertarget{classcore_1_1TCPSession_a4403ef0a92b119dfa2e74667788e4ba1}\label{classcore_1_1TCPSession_a4403ef0a92b119dfa2e74667788e4ba1}} +\mbox{\Hypertarget{classcore_1_1TCPSession_ada0eb595b5c506ae2f74851fd1588512}\label{classcore_1_1TCPSession_ada0eb595b5c506ae2f74851fd1588512}} \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[{std\+::string}]{block }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}} +{\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]}} 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}} @@ -88,21 +88,21 @@ Override the on\+Block\+Received method to receive a string of characters that r \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]}} -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_ac2c3ffef9ded12a8867e3d27902b001a}\label{classcore_1_1TCPSession_ac2c3ffef9ded12a8867e3d27902b001a}} +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_a6683cc5b39d3e47adc9ead3f3e3d7587}\label{classcore_1_1TCPSession_a6683cc5b39d3e47adc9ead3f3e3d7587}} \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[{char $\ast$}]{data, }\item[{int}]{len }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}} +{\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]}} 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. Reimplemented from \mbox{\hyperlink{classcore_1_1Socket}{core\+::\+Socket}}. -\mbox{\Hypertarget{classcore_1_1TCPSession_a0f209620e9f11e70bfde54852b5c5460}\label{classcore_1_1TCPSession_a0f209620e9f11e70bfde54852b5c5460}} +\mbox{\Hypertarget{classcore_1_1TCPSession_a018d0458806811b98e4aa30da27a1a2d}\label{classcore_1_1TCPSession_a018d0458806811b98e4aa30da27a1a2d}} \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[{std\+::string}]{line }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}} +{\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]}} 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}} \index{core::TCPSession@{core::TCPSession}!output@{output}} @@ -118,17 +118,17 @@ Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSocket_afacf7528ff3c9ac077d7 Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_ae55de8a035d1ddc560cf619b2030af43}{core\+::\+T\+L\+S\+Session}}. -\mbox{\Hypertarget{classcore_1_1TCPSession_ae90dc64e2d3c4b3239117923145edb3f}\label{classcore_1_1TCPSession_ae90dc64e2d3c4b3239117923145edb3f}} +\mbox{\Hypertarget{classcore_1_1TCPSession_a4a2a34c9b1252664e93c576a27c30720}\label{classcore_1_1TCPSession_a4a2a34c9b1252664e93c576a27c30720}} \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[{std\+::string}]{data = {\ttfamily \char`\"{}\char`\"{}} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}} +{\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]}} 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. -Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a547c436ab69f75307f065eca8cfcd109}{core\+::\+T\+L\+S\+Session}}, and \mbox{\hyperlink{classcore_1_1ConsoleSession_a830cc1e1e0c3fe3b066f0a9f7f469490}{core\+::\+Console\+Session}}. +Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a2ff61cfcb3ffd3593b1bf7b39343ee56}{core\+::\+T\+L\+S\+Session}}, and \mbox{\hyperlink{classcore_1_1ConsoleSession_a72cd8a1ed55112b7245d889a9424fd64}{core\+::\+Console\+Session}}. \mbox{\Hypertarget{classcore_1_1TCPSession_a2b09eeafef5e44009a77d9da43e3b889}\label{classcore_1_1TCPSession_a2b09eeafef5e44009a77d9da43e3b889}} \index{core::TCPSession@{core::TCPSession}!send@{send}} diff --git a/latex/classcore_1_1TLSSession.tex b/latex/classcore_1_1TLSSession.tex index 2b40e21..7010f2a 100644 --- a/latex/classcore_1_1TLSSession.tex +++ b/latex/classcore_1_1TLSSession.tex @@ -30,12 +30,12 @@ Collaboration diagram for core\+::T\+L\+S\+Session\+:\nopagebreak \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_a547c436ab69f75307f065eca8cfcd109}{protocol}} (std\+::string data) override +virtual void \mbox{\hyperlink{classcore_1_1TLSSession_a2ff61cfcb3ffd3593b1bf7b39343ee56}{protocol}} (coreutils\+::\+Z\+String data) override \end{DoxyCompactItemize} \doxysubsection*{Protected Member Functions} \begin{DoxyCompactItemize} \item -void \mbox{\hyperlink{classcore_1_1TLSSession_a1822cb21de545dc1a183ec0bac6cc4f0}{receive\+Data}} (char $\ast$buffer, int buffer\+Length) override +void \mbox{\hyperlink{classcore_1_1TLSSession_a4b3c2d871d83150974bba48435eaf6cf}{receive\+Data}} (coreutils\+::\+Z\+String 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 @@ -77,27 +77,27 @@ The output method is called by a socket session (Session) and will output the de Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}{core\+::\+T\+C\+P\+Session}}. -\mbox{\Hypertarget{classcore_1_1TLSSession_a547c436ab69f75307f065eca8cfcd109}\label{classcore_1_1TLSSession_a547c436ab69f75307f065eca8cfcd109}} +\mbox{\Hypertarget{classcore_1_1TLSSession_a2ff61cfcb3ffd3593b1bf7b39343ee56}\label{classcore_1_1TLSSession_a2ff61cfcb3ffd3593b1bf7b39343ee56}} \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[{std\+::string}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}} +{\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]}} 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. -Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_ae90dc64e2d3c4b3239117923145edb3f}{core\+::\+T\+C\+P\+Session}}. +Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_a4a2a34c9b1252664e93c576a27c30720}{core\+::\+T\+C\+P\+Session}}. -\mbox{\Hypertarget{classcore_1_1TLSSession_a1822cb21de545dc1a183ec0bac6cc4f0}\label{classcore_1_1TLSSession_a1822cb21de545dc1a183ec0bac6cc4f0}} +\mbox{\Hypertarget{classcore_1_1TLSSession_a4b3c2d871d83150974bba48435eaf6cf}\label{classcore_1_1TLSSession_a4b3c2d871d83150974bba48435eaf6cf}} \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[{char $\ast$}]{buffer, }\item[{int}]{buffer\+Length }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}} +{\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]}} 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. -Reimplemented from \mbox{\hyperlink{classcore_1_1Socket_af455ec6f793473f529507af26aa54695}{core\+::\+Socket}}. +Reimplemented from \mbox{\hyperlink{classcore_1_1Socket_a481b3b3874a6862f8d97030297cc6f32}{core\+::\+Socket}}. diff --git a/servercore.code-workspace b/servercore.code-workspace new file mode 100644 index 0000000..876a149 --- /dev/null +++ b/servercore.code-workspace @@ -0,0 +1,8 @@ +{ + "folders": [ + { + "path": "." + } + ], + "settings": {} +} \ No newline at end of file

Protected Attributes

name (defined in core::Object)core::Object
needsToWrite() (defined in core::Socket)core::Socket
onDataReceived(std::string data)core::Socketprotectedvirtual
onDataReceived(char *buffer, int len) (defined in core::Socket)core::Socketprotectedvirtual
onDataReceived(coreutils::ZString data) (defined in core::Socket)core::Socketprotectedvirtual
onRegister()core::Socketvirtual
onRegistered()core::Socketvirtual
onUnregister() (defined in core::Socket)core::Socketvirtual
onUnregistered()core::Socketvirtual
output(std::stringstream &out) (defined in core::Socket)core::Socket
receiveData(char *buffer, int bufferLength)core::Socketprotectedvirtual
receiveData(coreutils::ZString buffer)core::Socketprotectedvirtual
reset (defined in core::Socket)core::Socket
setBufferSize(int length) (defined in core::Socket)core::Socketprotected
setDescriptor(int descriptor)core::Socket
getBufferSize ()virtual void onDataReceived (std::string data)
 Called when data is received from the socket. More...
 
-virtual void onDataReceived (char *buffer, int len)
 
virtual void receiveData (char *buffer, int bufferLength)
 
+virtual void onDataReceived (coreutils::ZString data)
 
virtual void receiveData (coreutils::ZString buffer)
 
- Protected Attributes inherited from core::Socket
EPoll & ePoll