diff --git a/html/CommandList_8h_source.html b/html/CommandList_8h_source.html index 98510bb..39abef4 100644 --- a/html/CommandList_8h_source.html +++ b/html/CommandList_8h_source.html @@ -109,7 +109,7 @@ $(function() {
75 #endif
core::CommandList::grabInput
bool grabInput(TCPSession *session, Command &command)
Definition: CommandList.cpp:28
-
core::TCPSession
Definition: TCPSession.h:26
+
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
diff --git a/html/Command_8h_source.html b/html/Command_8h_source.html index f6fd1be..8c0cfd2 100644 --- a/html/Command_8h_source.html +++ b/html/Command_8h_source.html @@ -107,7 +107,7 @@ $(function() {
82 
83 #endif
-
core::TCPSession
Definition: TCPSession.h:26
+
core::TCPSession
Definition: TCPSession.h:24
core::Command::check
virtual bool check(std::string request)
Definition: Command.cpp:13
core::Command::output
virtual void output(Session *session)
Definition: Command.cpp:11
core::Command
Definition: Command.h:22
diff --git a/html/ConsoleServer_8h_source.html b/html/ConsoleServer_8h_source.html index b8908d7..a592609 100644 --- a/html/ConsoleServer_8h_source.html +++ b/html/ConsoleServer_8h_source.html @@ -104,7 +104,7 @@ $(function() {
40 
41 #endif
-
core::TCPSession
Definition: TCPSession.h:26
+
core::TCPSession
Definition: TCPSession.h:24
core::IPAddress
Definition: IPAddress.h:9
core::EPoll
Definition: EPoll.h:31
core::ConsoleServer
Definition: ConsoleServer.h:19
diff --git a/html/EPoll_8h_source.html b/html/EPoll_8h_source.html index ae2eee1..960a833 100644 --- a/html/EPoll_8h_source.html +++ b/html/EPoll_8h_source.html @@ -134,7 +134,7 @@ $(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:26
+
core::TCPSession
Definition: TCPSession.h:24
core::Socket
Definition: Socket.h:33
core::EPoll::unregisterSocket
bool unregisterSocket(Socket *socket)
Unregister a BMASocket from monitoring by BMAEPoll.
Definition: EPoll.cpp:77
core::EPoll
Definition: EPoll.h:31
diff --git a/html/IPAddressList_8h_source.html b/html/IPAddressList_8h_source.html index 87697f0..a3efba1 100644 --- a/html/IPAddressList_8h_source.html +++ b/html/IPAddressList_8h_source.html @@ -77,17 +77,17 @@ $(function() {
10 
11  public:
12  IPAddressList();
-
13 
+
13 
14  std::map<std::string, IPAddress> getList();
15  void add(IPAddress ipAddress);
16  bool remove(IPAddress ipAddress);
17  bool contains(std::string ipAddress);
-
18 
+
18 
19  private:
20  std::map<std::string, IPAddress> list;
-
21  std::map<std::string, IPAddress>::iterator it = list.begin();
+
21  std::map<std::string, IPAddress>::iterator it = list.begin();
22  };
-
23 
+
23 
24 }
25 
26 #endif
diff --git a/html/SessionFilter_8h_source.html b/html/SessionFilter_8h_source.html index 14d631f..e073f04 100644 --- a/html/SessionFilter_8h_source.html +++ b/html/SessionFilter_8h_source.html @@ -88,7 +88,7 @@ $(function() {
21 #endif
core::SessionFilter
Definition: SessionFilter.h:10
-
core::TCPSession
Definition: TCPSession.h:26
+
core::TCPSession
Definition: TCPSession.h:24
core::Object
Definition: Object.h:8
diff --git a/html/TCPServer_8h_source.html b/html/TCPServer_8h_source.html index b32927f..8fcf3f6 100644 --- a/html/TCPServer_8h_source.html +++ b/html/TCPServer_8h_source.html @@ -75,63 +75,63 @@ $(function() {
8 #include "CommandList.h"
9 
10 namespace core {
-
11 
-
23 
+
11 
+
23 
24  class TCPServer : public TCPSocket, public Command {
-
25 
+
25 
26  public:
-
27 
-
37 
+
27 
+
37 
38  TCPServer(EPoll &ePoll, IPAddress address, std::string text = "");
-
39 
-
43 
+
39 
+
43 
44  ~TCPServer();
-
45 
-
51 
-
52  IPAddressList *blackList;
+
45 
+
51 
+
52  IPAddressList *blackList;
53 
-
59 
+
59 
60  IPAddressList *whiteList;
61 
62  void removeFromSessionList(TCPSession *session);
63 
-
64  virtual void sessionErrorHandler(std::string errorString, std::stringstream &out);
-
65 
-
73 
+
64  virtual void sessionErrorHandler(std::string errorString, std::stringstream &out);
+
65 
+
73 
74  virtual TCPSession * getSocketAccept(EPoll &epoll);
75 
76  void output(TCPSession *session);
-
77 
-
81 
+
77 
+
81 
82  std::vector<TCPSession *> sessions;
-
83 
-
88 
+
83 
+
88 
89  CommandList commands;
-
90 
+
90 
91  protected:
-
92 
-
102 
-
103  void onDataReceived(std::string data) override;
-
104 
-
111 
+
92 
+
102 
+
103  void onDataReceived(std::string data) override;
+
104 
+
111 
112  int processCommand(std::string command, TCPSession *session, std::stringstream &data) override;
-
113 
+
113 
114  private:
115 
116  TCPSession * accept();
117  std::mutex lock;
-
118 
+
118 
119  };
-
120 
+
120 
121 }
122 
123 #endif
core::TCPServer::blackList
IPAddressList * blackList
Definition: TCPServer.h:52
-
core::TCPSession
Definition: TCPSession.h:26
+
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:73
+
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
@@ -143,8 +143,8 @@ $(function() {
core::TCPServer::~TCPServer
~TCPServer()
Definition: TCPServer.cpp:20
core::TCPServer
Definition: TCPServer.h:24
core::TCPServer::commands
CommandList commands
Definition: TCPServer.h:89
-
core::TCPServer::getSocketAccept
virtual TCPSession * getSocketAccept(EPoll &epoll)
Definition: TCPServer.cpp:63
-
core::TCPServer::output
void output(TCPSession *session)
Output the consoles array to the console.
Definition: TCPServer.cpp:67
+
core::TCPServer::getSocketAccept
virtual TCPSession * getSocketAccept(EPoll &epoll)
Definition: TCPServer.cpp:61
+
core::TCPServer::output
void output(TCPSession *session)
Output the consoles array to the console.
Definition: TCPServer.cpp:65
Generated by   diff --git a/html/TCPSession_8h_source.html b/html/TCPSession_8h_source.html index f3d81ec..dddc53d 100644 --- a/html/TCPSession_8h_source.html +++ b/html/TCPSession_8h_source.html @@ -74,98 +74,92 @@ $(function() {
7 namespace core {
8 
9  class Command;
-
10  enum Mode {LINE, BLOCK, PACKET};
-
11 
-
12  class TCPServer;
-
13 
-
25 
-
26  class TCPSession : public TCPSocket {
-
27 
-
28  public:
-
29 
-
33 
-
34  TCPSession(EPoll &ePoll, TCPServer &server, std::string text = "");
-
35 
-
39 
-
40  ~TCPSession();
-
41 
-
42  Command *grab = NULL;
-
43 
-
44  virtual void output(std::stringstream &data);
-
45 
-
49 
-
50  std::stringstream out;
-
51 
-
56 
-
57  void send();
-
58 
-
63 
-
64  void sendToAll();
-
65 
-
71 
-
72  void sendToAll(SessionFilter filter);
-
73 
-
77 
-
78  void terminate();
-
79 
-
83 
-
84  TCPServer &server;
+
10  class TCPServer;
+
11 
+
23 
+
24  class TCPSession : public TCPSocket {
+
25 
+
26  public:
+
27 
+
31 
+
32  TCPSession(EPoll &ePoll, TCPServer &server, std::string text = "");
+
33 
+
37 
+
38  ~TCPSession();
+
39 
+
40  Command *grab = NULL;
+
41 
+
42  virtual void output(std::stringstream &data);
+
43 
+
47 
+
48  std::stringstream out;
+
49 
+
54 
+
55  void send();
+
56 
+
61 
+
62  void sendToAll();
+
63 
+
69 
+
70  void sendToAll(SessionFilter filter);
+
71 
+
75 
+
76  void terminate();
+
77 
+
81 
+
82  TCPServer &server;
+
83 
+
84  protected:
85 
-
90 
-
91 // enum Mode {LINE, BLOCK};
-
92 
-
93  protected:
-
94 
-
98 
-
99  virtual void onRegistered() override;
-
100 
-
106 
-
107  virtual void onDataReceived(char *data, int len) override;
-
108 
-
115 
-
116  virtual void onLineReceived(std::string line);
-
117 
-
124 
-
125  virtual void onBlockReceived(std::string block);
-
126 
-
132 
-
133  virtual void onConnected();
-
134 
-
144 
-
145  virtual void protocol(std::string data);
-
146 
-
153 
-
154  void setMode(core::Mode mode, int size = 0);
-
155 
-
156  private:
-
157  char *lineBuffer = NULL;
-
158  int lineBufferSize = 0;
-
159  int lineLength = 0;
-
160  int blockLength = 0;
-
161  std::mutex mtx;
-
162  bool term = false;
-
163  core::Mode mode = LINE;
-
164  int blockSize;
-
165 
-
166  };
-
167 
-
168 }
-
169 
-
170 #endif
+
89 
+
90  virtual void onRegistered() override;
+
91 
+
97 
+
98  virtual void onDataReceived(char *data, int len) override;
+
99 
+
106 
+
107  virtual void onLineReceived(std::string line);
+
108 
+
115 
+
116  virtual void onBlockReceived(std::string block);
+
117 
+
123 
+
124  virtual void onConnected();
+
125 
+
135 
+
136  virtual void protocol(std::string data);
+
137 
+
143 
+
144  void setBlockSize(int size = 0);
+
145 
+
146  private:
+
147  char *lineBuffer = NULL;
+
148  int lineBufferSize = 0;
+
149  int lineLength = 0;
+
150  int blockLength = 0;
+
151  std::mutex mtx;
+
152  bool term = false;
+
153  int blockSize = 0;
+
154 
+
155  };
+
156 
+
157 }
+
158 
+
159 #endif
-
core::TCPSession::send
void send()
Definition: TCPSession.cpp:101
+
core::TCPSession::send
void send()
Definition: TCPSession.cpp:98
core::SessionFilter
Definition: SessionFilter.h:10
-
core::TCPSession::onBlockReceived
virtual void onBlockReceived(std::string block)
Definition: TCPSession.cpp:82
-
core::TCPSession
Definition: TCPSession.h:26
+
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:86
-
core::TCPSession::onLineReceived
virtual void onLineReceived(std::string line)
Definition: TCPSession.cpp:74
-
core::TCPSession::setMode
void setMode(core::Mode mode, int size=0)
Definition: TCPSession.cpp:69
-
core::TCPSession::out
std::stringstream out
Definition: TCPSession.h:50
-
core::TCPSession::terminate
void terminate()
Definition: TCPSession.cpp:107
-
core::TCPSession::onRegistered
virtual void onRegistered() override
Definition: TCPSession.cpp:24
+
core::TCPSession::sendToAll
void sendToAll()
Definition: TCPSession.cpp:83
+
core::TCPSession::onLineReceived
virtual void onLineReceived(std::string line)
Definition: TCPSession.cpp:70
+
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::Command
Definition: Command.h:22
core::TCPSocket
Definition: TCPSocket.h:20
core::TCPSession::output
virtual void output(std::stringstream &data)
Definition: TCPSession.cpp:14
diff --git a/html/TCPSocket_8h_source.html b/html/TCPSocket_8h_source.html index cb17c19..87cf87a 100644 --- a/html/TCPSocket_8h_source.html +++ b/html/TCPSocket_8h_source.html @@ -89,7 +89,7 @@ $(function() {
31 
38 
39  virtual void output(std::stringstream &out);
-
40 
+
40 
41  };
42 
43 }
diff --git a/html/TLSServer_8h_source.html b/html/TLSServer_8h_source.html index ec7a6fe..cb56e87 100644 --- a/html/TLSServer_8h_source.html +++ b/html/TLSServer_8h_source.html @@ -103,7 +103,7 @@ $(function() {
53 
54 #endif
-
core::TCPSession
Definition: TCPSession.h:26
+
core::TCPSession
Definition: TCPSession.h:24
core::IPAddress
Definition: IPAddress.h:9
core::EPoll
Definition: EPoll.h:31
core::TLSServer
Definition: TLSServer.h:19
diff --git a/html/TLSSession_8h_source.html b/html/TLSSession_8h_source.html index 1f9dd7e..48ca98d 100644 --- a/html/TLSSession_8h_source.html +++ b/html/TLSSession_8h_source.html @@ -106,10 +106,10 @@ $(function() {
core::TLSSession::protocol
virtual void protocol(std::string data) override
Definition: TLSSession.cpp:83
core::TLSSession::output
virtual void output(std::stringstream &out)
Definition: TLSSession.cpp:118
-
core::TCPSession
Definition: TCPSession.h:26
-
core::TLSSession::onRegistered
void onRegistered()
Definition: TLSSession.cpp:58
+
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::TCPSession::out
std::stringstream out
Definition: TCPSession.h:50
+
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
diff --git a/html/TerminalSession_8h_source.html b/html/TerminalSession_8h_source.html index f3a0c68..524c078 100644 --- a/html/TerminalSession_8h_source.html +++ b/html/TerminalSession_8h_source.html @@ -125,7 +125,7 @@ $(function() {
67 #endif
core::TerminalSession::clearEOL
void clearEOL()
Definition: TerminalSession.cpp:21
-
core::TCPSession
Definition: TCPSession.h:26
+
core::TCPSession
Definition: TCPSession.h:24
core::TerminalSession::setCursorLocation
void setCursorLocation(int x, int y)
Definition: TerminalSession.cpp:25
core::TerminalSession::clear
void clear()
Definition: TerminalSession.cpp:17
core::EPoll
Definition: EPoll.h:31
diff --git a/html/classcore_1_1ConsoleSession-members.html b/html/classcore_1_1ConsoleSession-members.html index 9f5612c..5e5f673 100644 --- a/html/classcore_1_1ConsoleSession-members.html +++ b/html/classcore_1_1ConsoleSession-members.html @@ -109,11 +109,11 @@ $(function() { sendToAll(SessionFilter filter)core::TCPSession server (defined in core::TCPSession)core::TCPSession setBackColor(int color) (defined in core::TerminalSession)core::TerminalSession - setBufferSize(int length) (defined in core::Socket)core::Socketprotected - setColor(int color) (defined in core::TerminalSession)core::TerminalSession - setCursorLocation(int x, int y)core::TerminalSession - setDescriptor(int descriptor)core::Socket - setMode(core::Mode mode, int size=0)core::TCPSessionprotected + setBlockSize(int size=0)core::TCPSessionprotected + setBufferSize(int length) (defined in core::Socket)core::Socketprotected + setColor(int color) (defined in core::TerminalSession)core::TerminalSession + setCursorLocation(int x, int y)core::TerminalSession + setDescriptor(int descriptor)core::Socket shutdown(std::string text="unknown")core::Socket shutDown (defined in core::Socket)core::Socketprotected Socket(EPoll &ePoll, std::string text="")core::Socket diff --git a/html/classcore_1_1ConsoleSession.html b/html/classcore_1_1ConsoleSession.html index eb9b8f6..6cead49 100644 --- a/html/classcore_1_1ConsoleSession.html +++ b/html/classcore_1_1ConsoleSession.html @@ -218,7 +218,9 @@ Protected Member Functions void protocol (std::string data) override   - Protected Member Functions inherited from core::TCPSession -virtual void onRegistered () override + +virtual void onRegistered () override + Called after the socket has been registered with epoll processing.
  virtual void onDataReceived (char *data, int len) override   @@ -228,8 +230,8 @@ Protected Member Functions   virtual void onConnected ()   -void setMode (core::Mode mode, int size=0) -  +void setBlockSize (int size=0) +  - Protected Member Functions inherited from core::Socket void setBufferSize (int length) diff --git a/html/classcore_1_1TCPSession-members.html b/html/classcore_1_1TCPSession-members.html index c097af0..9074e58 100644 --- a/html/classcore_1_1TCPSession-members.html +++ b/html/classcore_1_1TCPSession-members.html @@ -99,9 +99,9 @@ $(function() { sendToAll()core::TCPSession sendToAll(SessionFilter filter)core::TCPSession server (defined in core::TCPSession)core::TCPSession - setBufferSize(int length) (defined in core::Socket)core::Socketprotected - setDescriptor(int descriptor)core::Socket - setMode(core::Mode mode, int size=0)core::TCPSessionprotected + setBlockSize(int size=0)core::TCPSessionprotected + setBufferSize(int length) (defined in core::Socket)core::Socketprotected + setDescriptor(int descriptor)core::Socket shutDown (defined in core::Socket)core::Socketprotected shutdown(std::string text="unknown")core::Socket Socket(EPoll &ePoll, std::string text="")core::Socket diff --git a/html/classcore_1_1TCPSession.html b/html/classcore_1_1TCPSession.html index de07f7e..cbacc94 100644 --- a/html/classcore_1_1TCPSession.html +++ b/html/classcore_1_1TCPSession.html @@ -200,7 +200,9 @@ std::string tag - + + @@ -212,8 +214,8 @@ Protected Member Functions - - + + @@ -239,8 +241,7 @@ bool 

Protected Member Functions

virtual void onRegistered () override
+virtual void onRegistered () override
 Called after the socket has been registered with epoll processing.
 
virtual void onDataReceived (char *data, int len) override
 
 
virtual void protocol (std::string data)
 
void setMode (core::Mode mode, int size=0)
 
void setBlockSize (int size=0)
 
- Protected Member Functions inherited from core::Socket
void setBufferSize (int length)
shutDown = false<

Detailed Description

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.
-

+

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()

@@ -359,36 +360,6 @@ bool shutDown = false<

Override the onLineReceived method to receive a string of characters that represents a single line of data terminated by a LF or CRLF. If onDataReceived was overriden this method will not be called unless the onDataReceived calls this method explicitly using the class and member name.

-
- - -

◆ onRegistered()

- -
-
- - - - - -
- - - - - - - -
void core::TCPSession::onRegistered ()
- 		-overrideprotectedvirtual
-
-

Set this value to control the next read event coming from this socket.

- -

Reimplemented from core::Socket.

- -

Reimplemented in core::TLSSession.

-
@@ -414,7 +385,7 @@ bool shutDown = false<
-

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

+

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

Reimplemented from core::TCPSocket.

@@ -507,8 +478,8 @@ bool shutDown = false<
- -

◆ setMode()

+ +

◆ setBlockSize()

@@ -517,21 +488,11 @@ bool shutDown = false< - + - - - - - - - - - + - -
void core::TCPSession::setMode void core::TCPSession::setBlockSize (core::Mode mode,
int size = 0 
size = 0) )
@@ -540,7 +501,7 @@ bool shutDown = false<
-

Use the setMode method to set the receiving mode for the data on this socket. Data can be received in LINE mode, which will receive data from the socket one line at a time, or BLOCK mode where a certain specified data block is received before calling the onBlockReceived method.

+

Use setBlockSize to set the amount of data that should be read at once from the session data buffer. If this value is set to 0 then the data will be retrieved

diff --git a/html/classcore_1_1TCPSocket.html b/html/classcore_1_1TCPSocket.html index d2e5aea..45f10a8 100644 --- a/html/classcore_1_1TCPSocket.html +++ b/html/classcore_1_1TCPSocket.html @@ -232,7 +232,7 @@ bool shutDown = false<
-

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

+

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

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

diff --git a/html/classcore_1_1TLSSession-members.html b/html/classcore_1_1TLSSession-members.html index 84c5894..2ab9414 100644 --- a/html/classcore_1_1TLSSession-members.html +++ b/html/classcore_1_1TLSSession-members.html @@ -99,11 +99,11 @@ $(function() { sendToAll()core::TCPSession sendToAll(SessionFilter filter)core::TCPSession server (defined in core::TCPSession)core::TCPSession - setBufferSize(int length) (defined in core::Socket)core::Socketprotected - setDescriptor(int descriptor)core::Socket - setMode(core::Mode mode, int size=0)core::TCPSessionprotected - shutDown (defined in core::Socket)core::Socketprotected - shutdown(std::string text="unknown")core::Socket + setBlockSize(int size=0)core::TCPSessionprotected + setBufferSize(int length) (defined in core::Socket)core::Socketprotected + setDescriptor(int descriptor)core::Socket + shutdown(std::string text="unknown")core::Socket + shutDown (defined in core::Socket)core::Socketprotected Socket(EPoll &ePoll, std::string text="")core::Socket tag (defined in core::Object)core::Object TCPSession(EPoll &ePoll, TCPServer &server, std::string text="") (defined in core::TCPSession)core::TCPSession diff --git a/html/classcore_1_1TLSSession.html b/html/classcore_1_1TLSSession.html index 5ee6091..e9d2773 100644 --- a/html/classcore_1_1TLSSession.html +++ b/html/classcore_1_1TLSSession.html @@ -180,7 +180,9 @@ Protected Member Functions void onRegister ()  Called before the socket has registered with the epoll processing. More...
  -void onRegistered () + +void onRegistered () + 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 @@ -191,8 +193,8 @@ Protected Member Functions   virtual void onConnected ()   -void setMode (core::Mode mode, int size=0) -  +void setBlockSize (int size=0) +  - Protected Member Functions inherited from core::Socket void setBufferSize (int length) @@ -271,34 +273,6 @@ bool shutDown = false<

Reimplemented from core::Socket.

-
- - -

◆ onRegistered()

- -
-
- - - - - -
- - - - - - - -
void core::TLSSession::onRegistered ()
- 		-protectedvirtual
-
-

Set this value to control the next read event coming from this socket.

- -

Reimplemented from core::TCPSession.

-
diff --git a/html/classcore_1_1TerminalSession-members.html b/html/classcore_1_1TerminalSession-members.html index 75bd75b..6c03e34 100644 --- a/html/classcore_1_1TerminalSession-members.html +++ b/html/classcore_1_1TerminalSession-members.html @@ -108,13 +108,13 @@ $(function() { sendToAll(SessionFilter filter)core::TCPSession server (defined in core::TCPSession)core::TCPSession setBackColor(int color) (defined in core::TerminalSession)core::TerminalSession - setBufferSize(int length) (defined in core::Socket)core::Socketprotected - setColor(int color) (defined in core::TerminalSession)core::TerminalSession - setCursorLocation(int x, int y)core::TerminalSession - setDescriptor(int descriptor)core::Socket - setMode(core::Mode mode, int size=0)core::TCPSessionprotected - shutDown (defined in core::Socket)core::Socketprotected - shutdown(std::string text="unknown")core::Socket + setBlockSize(int size=0)core::TCPSessionprotected + setBufferSize(int length) (defined in core::Socket)core::Socketprotected + setColor(int color) (defined in core::TerminalSession)core::TerminalSession + setCursorLocation(int x, int y)core::TerminalSession + setDescriptor(int descriptor)core::Socket + shutdown(std::string text="unknown")core::Socket + shutDown (defined in core::Socket)core::Socketprotected Socket(EPoll &ePoll, std::string text="")core::Socket tag (defined in core::Object)core::Object TCPSession(EPoll &ePoll, TCPServer &server, std::string text="") (defined in core::TCPSession)core::TCPSession diff --git a/html/classcore_1_1TerminalSession.html b/html/classcore_1_1TerminalSession.html index 3508d6a..5db14f1 100644 --- a/html/classcore_1_1TerminalSession.html +++ b/html/classcore_1_1TerminalSession.html @@ -229,7 +229,9 @@ std::string name< std::string tag   - Protected Member Functions inherited from core::TCPSession -virtual void onRegistered () override + +virtual void onRegistered () override + Called after the socket has been registered with epoll processing.
  virtual void onDataReceived (char *data, int len) override   @@ -241,8 +243,8 @@ std::string tag  virtual void protocol (std::string data)   -void setMode (core::Mode mode, int size=0) -  +void setBlockSize (int size=0) +  - Protected Member Functions inherited from core::Socket void setBufferSize (int length) diff --git a/html/functions.html b/html/functions.html index ae6d31a..8c3c68e 100644 --- a/html/functions.html +++ b/html/functions.html @@ -235,15 +235,15 @@ $(function() {
  • sessions : core::TCPServer
    • +
  • setBlockSize() +: core::TCPSession +
  • setCursorLocation() : core::TerminalSession
  • setDescriptor() : core::Socket
    • -
  • setMode() -: core::TCPSession -
  • setName() : core::Command
    • diff --git a/html/functions_func.html b/html/functions_func.html index ebfd7af..e90bf91 100644 --- a/html/functions_func.html +++ b/html/functions_func.html @@ -211,15 +211,15 @@ $(function() {
  • sendToAll() : core::TCPSession
    • +
  • setBlockSize() +: core::TCPSession +
  • setCursorLocation() : core::TerminalSession
  • setDescriptor() : core::Socket
    • -
  • setMode() -: core::TCPSession -
  • setName() : core::Command
    • diff --git a/html/search/all_a.js b/html/search/all_a.js index a60eb56..fe0403a 100644 --- a/html/search/all_a.js +++ b/html/search/all_a.js @@ -4,9 +4,9 @@ var searchData= ['sendtoall_43',['sendToAll',['../classcore_1_1TCPSession.html#afdfe135694c6689f5365fac6c090ec33',1,'core::TCPSession::sendToAll()'],['../classcore_1_1TCPSession.html#a05c489dcd2ebd74f527864759929e351',1,'core::TCPSession::sendToAll(SessionFilter filter)']]], ['sessionfilter_44',['SessionFilter',['../classcore_1_1SessionFilter.html',1,'core']]], ['sessions_45',['sessions',['../classcore_1_1TCPServer.html#aeed1bc55d099667ccda51cd682bfc633',1,'core::TCPServer']]], - ['setcursorlocation_46',['setCursorLocation',['../classcore_1_1TerminalSession.html#aa9939cbe36c08e1a0b8413a96ca251fa',1,'core::TerminalSession']]], - ['setdescriptor_47',['setDescriptor',['../classcore_1_1Socket.html#ac44f6ae3196a8a3e09a6a85fcf495762',1,'core::Socket']]], - ['setmode_48',['setMode',['../classcore_1_1TCPSession.html#afde7a264edac9e91b509f13eb4192038',1,'core::TCPSession']]], + ['setblocksize_46',['setBlockSize',['../classcore_1_1TCPSession.html#a836fb3fd5ee543ebc93262a980ae88b5',1,'core::TCPSession']]], + ['setcursorlocation_47',['setCursorLocation',['../classcore_1_1TerminalSession.html#aa9939cbe36c08e1a0b8413a96ca251fa',1,'core::TerminalSession']]], + ['setdescriptor_48',['setDescriptor',['../classcore_1_1Socket.html#ac44f6ae3196a8a3e09a6a85fcf495762',1,'core::Socket']]], ['setname_49',['setName',['../classcore_1_1Command.html#ad8b0321c64838f4d5c8f93461b97cfef',1,'core::Command']]], ['settimer_50',['setTimer',['../classcore_1_1Timer.html#ac0a642cdcb76b7f995137162050d3d0b',1,'core::Timer']]], ['shutdown_51',['shutdown',['../classcore_1_1Socket.html#af2d1b6de7a64a9d446b0305b6ec47b31',1,'core::Socket']]], diff --git a/html/search/functions_8.js b/html/search/functions_8.js index 076dc8a..0086795 100644 --- a/html/search/functions_8.js +++ b/html/search/functions_8.js @@ -2,9 +2,9 @@ var searchData= [ ['send_124',['send',['../classcore_1_1TCPSession.html#a2b09eeafef5e44009a77d9da43e3b889',1,'core::TCPSession']]], ['sendtoall_125',['sendToAll',['../classcore_1_1TCPSession.html#afdfe135694c6689f5365fac6c090ec33',1,'core::TCPSession::sendToAll()'],['../classcore_1_1TCPSession.html#a05c489dcd2ebd74f527864759929e351',1,'core::TCPSession::sendToAll(SessionFilter filter)']]], - ['setcursorlocation_126',['setCursorLocation',['../classcore_1_1TerminalSession.html#aa9939cbe36c08e1a0b8413a96ca251fa',1,'core::TerminalSession']]], - ['setdescriptor_127',['setDescriptor',['../classcore_1_1Socket.html#ac44f6ae3196a8a3e09a6a85fcf495762',1,'core::Socket']]], - ['setmode_128',['setMode',['../classcore_1_1TCPSession.html#afde7a264edac9e91b509f13eb4192038',1,'core::TCPSession']]], + ['setblocksize_126',['setBlockSize',['../classcore_1_1TCPSession.html#a836fb3fd5ee543ebc93262a980ae88b5',1,'core::TCPSession']]], + ['setcursorlocation_127',['setCursorLocation',['../classcore_1_1TerminalSession.html#aa9939cbe36c08e1a0b8413a96ca251fa',1,'core::TerminalSession']]], + ['setdescriptor_128',['setDescriptor',['../classcore_1_1Socket.html#ac44f6ae3196a8a3e09a6a85fcf495762',1,'core::Socket']]], ['setname_129',['setName',['../classcore_1_1Command.html#ad8b0321c64838f4d5c8f93461b97cfef',1,'core::Command']]], ['settimer_130',['setTimer',['../classcore_1_1Timer.html#ac0a642cdcb76b7f995137162050d3d0b',1,'core::Timer']]], ['shutdown_131',['shutdown',['../classcore_1_1Socket.html#af2d1b6de7a64a9d446b0305b6ec47b31',1,'core::Socket']]], diff --git a/html/search/variables_6.html b/html/search/variables_6.html new file mode 100644 index 0000000..ce4a906 --- /dev/null +++ b/html/search/variables_6.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/html/search/variables_6.js b/html/search/variables_6.js new file mode 100644 index 0000000..ae6ad50 --- /dev/null +++ b/html/search/variables_6.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['whitelist_151',['whiteList',['../classcore_1_1TCPServer.html#abad6300b6234ca8b69cef9128755342e',1,'core::TCPServer']]] +]; diff --git a/latex/classcore_1_1TCPSession.tex b/latex/classcore_1_1TCPSession.tex index 7b9e291..9902bc9 100644 --- a/latex/classcore_1_1TCPSession.tex +++ b/latex/classcore_1_1TCPSession.tex @@ -52,8 +52,9 @@ std\+::stringstream \mbox{\hyperlink{classcore_1_1TCPSession_abb302bbb3d7e7bc754 \doxysubsection*{Protected Member Functions} \begin{DoxyCompactItemize} \item +\mbox{\Hypertarget{classcore_1_1TCPSession_aed4ed499b978bcea57a8efefe929fc98}\label{classcore_1_1TCPSession_aed4ed499b978bcea57a8efefe929fc98}} virtual void \mbox{\hyperlink{classcore_1_1TCPSession_aed4ed499b978bcea57a8efefe929fc98}{on\+Registered}} () override -\item +\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 \item virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a0f209620e9f11e70bfde54852b5c5460}{on\+Line\+Received}} (std\+::string line) @@ -64,7 +65,7 @@ virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a8719952f7bb00bf7239ec40aa \item virtual void \mbox{\hyperlink{classcore_1_1TCPSession_ae90dc64e2d3c4b3239117923145edb3f}{protocol}} (std\+::string data) \item -void \mbox{\hyperlink{classcore_1_1TCPSession_afde7a264edac9e91b509f13eb4192038}{set\+Mode}} (core\+::\+Mode mode, int size=0) +void \mbox{\hyperlink{classcore_1_1TCPSession_a836fb3fd5ee543ebc93262a980ae88b5}{set\+Block\+Size}} (int size=0) \end{DoxyCompactItemize} \doxysubsection*{Additional Inherited Members} @@ -72,8 +73,7 @@ void \mbox{\hyperlink{classcore_1_1TCPSession_afde7a264edac9e91b509f13eb4192038} \doxysubsection{Detailed Description} \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} -\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. ~\newline - +\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}} @@ -104,27 +104,13 @@ Reimplemented from \mbox{\hyperlink{classcore_1_1Socket}{core\+::\+Socket}}. \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]}} -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_aed4ed499b978bcea57a8efefe929fc98}\label{classcore_1_1TCPSession_aed4ed499b978bcea57a8efefe929fc98}} -\index{core::TCPSession@{core::TCPSession}!onRegistered@{onRegistered}} -\index{onRegistered@{onRegistered}!core::TCPSession@{core::TCPSession}} -\doxysubsubsection{\texorpdfstring{onRegistered()}{onRegistered()}} -{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::on\+Registered (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}} - -Set this value to control the next read event coming from this socket. - -Reimplemented from \mbox{\hyperlink{classcore_1_1Socket_a23b9824653bbe4652a716acb828665b1}{core\+::\+Socket}}. - - - -Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a8e26fdc9e8a6c573b5a504a1f1b137a9}{core\+::\+T\+L\+S\+Session}}. - -\mbox{\Hypertarget{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}\label{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}} +Override the on\+Line\+Received method to receive a string of characters that represents a single line of data terminated by a LF or 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}} \index{output@{output}!core::TCPSession@{core::TCPSession}} \doxysubsubsection{\texorpdfstring{output()}{output()}} {\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::output (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} -The output method is called by a socket session (B\+M\+A\+Session) and will output the detail information for the client socket. When extending B\+M\+A\+T\+C\+P\+Socket or B\+M\+A\+Session you can override the method to add attributes to the list. +The output method is called by a socket session (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}}) and will output the detail information for the client socket. When extending B\+M\+A\+T\+C\+P\+Socket or B\+M\+A\+Session you can override the method to add attributes to the list. Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSocket_afacf7528ff3c9ac077d7b5a49e2116fd}{core\+::\+T\+C\+P\+Socket}}. @@ -162,13 +148,13 @@ Use this send\+To\+All method to output the contents of the out stream to all th \doxysubsubsection{\texorpdfstring{sendToAll()}{sendToAll()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::send\+To\+All (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1SessionFilter}{Session\+Filter}}}]{filter }\end{DoxyParamCaption})} -Use this send\+To\+All method to output the contents of the out stream to all the connections on the server excluding the sender session and the entries identified by the passed in filter object. \mbox{\Hypertarget{classcore_1_1TCPSession_afde7a264edac9e91b509f13eb4192038}\label{classcore_1_1TCPSession_afde7a264edac9e91b509f13eb4192038}} -\index{core::TCPSession@{core::TCPSession}!setMode@{setMode}} -\index{setMode@{setMode}!core::TCPSession@{core::TCPSession}} -\doxysubsubsection{\texorpdfstring{setMode()}{setMode()}} -{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::set\+Mode (\begin{DoxyParamCaption}\item[{core\+::\+Mode}]{mode, }\item[{int}]{size = {\ttfamily 0} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}} +Use this send\+To\+All method to output the contents of the out stream to all the connections on the server excluding the sender session and the entries identified by the passed in filter object. \mbox{\Hypertarget{classcore_1_1TCPSession_a836fb3fd5ee543ebc93262a980ae88b5}\label{classcore_1_1TCPSession_a836fb3fd5ee543ebc93262a980ae88b5}} +\index{core::TCPSession@{core::TCPSession}!setBlockSize@{setBlockSize}} +\index{setBlockSize@{setBlockSize}!core::TCPSession@{core::TCPSession}} +\doxysubsubsection{\texorpdfstring{setBlockSize()}{setBlockSize()}} +{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::set\+Block\+Size (\begin{DoxyParamCaption}\item[{int}]{size = {\ttfamily 0} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}} -Use the set\+Mode method to set the receiving mode for the data on this socket. Data can be received in L\+I\+NE mode, which will receive data from the socket one line at a time, or B\+L\+O\+CK mode where a certain specified data block is received before calling the on\+Block\+Received method. \mbox{\Hypertarget{classcore_1_1TCPSession_a34936745e8d7669d5400e78d353a56d3}\label{classcore_1_1TCPSession_a34936745e8d7669d5400e78d353a56d3}} +Use set\+Block\+Size to set the amount of data that should be read at once from the session data buffer. If this value is set to 0 then the data will be retrieved \mbox{\Hypertarget{classcore_1_1TCPSession_a34936745e8d7669d5400e78d353a56d3}\label{classcore_1_1TCPSession_a34936745e8d7669d5400e78d353a56d3}} \index{core::TCPSession@{core::TCPSession}!terminate@{terminate}} \index{terminate@{terminate}!core::TCPSession@{core::TCPSession}} \doxysubsubsection{\texorpdfstring{terminate()}{terminate()}} diff --git a/latex/classcore_1_1TCPSocket.tex b/latex/classcore_1_1TCPSocket.tex index f942aca..d981c59 100644 --- a/latex/classcore_1_1TCPSocket.tex +++ b/latex/classcore_1_1TCPSocket.tex @@ -59,7 +59,7 @@ For accessing T\+CP network functions use this object. The connection oriented n \doxysubsubsection{\texorpdfstring{output()}{output()}} {\footnotesize\ttfamily void core\+::\+T\+C\+P\+Socket\+::output (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} -The output method is called by a socket session (B\+M\+A\+Session) and will output the detail information for the client socket. When extending B\+M\+A\+T\+C\+P\+Socket or B\+M\+A\+Session you can override the method to add attributes to the list. +The output method is called by a socket session (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}}) and will output the detail information for the client socket. When extending B\+M\+A\+T\+C\+P\+Socket or B\+M\+A\+Session you can override the method to add attributes to the list. Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_ae55de8a035d1ddc560cf619b2030af43}{core\+::\+T\+L\+S\+Session}}, and \mbox{\hyperlink{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}{core\+::\+T\+C\+P\+Session}}. diff --git a/latex/classcore_1_1TLSSession.tex b/latex/classcore_1_1TLSSession.tex index 336cac9..2b40e21 100644 --- a/latex/classcore_1_1TLSSession.tex +++ b/latex/classcore_1_1TLSSession.tex @@ -39,8 +39,9 @@ void \mbox{\hyperlink{classcore_1_1TLSSession_a1822cb21de545dc1a183ec0bac6cc4f0} \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 +\mbox{\Hypertarget{classcore_1_1TLSSession_a8e26fdc9e8a6c573b5a504a1f1b137a9}\label{classcore_1_1TLSSession_a8e26fdc9e8a6c573b5a504a1f1b137a9}} void \mbox{\hyperlink{classcore_1_1TLSSession_a8e26fdc9e8a6c573b5a504a1f1b137a9}{on\+Registered}} () -\end{DoxyCompactItemize} +\begin{DoxyCompactList}\small\item\em Called after the socket has been registered with epoll processing. \end{DoxyCompactList}\end{DoxyCompactItemize} \doxysubsection*{Additional Inherited Members} @@ -66,16 +67,6 @@ The on\+Register method is called before the socket is registered with e\+Poll s Reimplemented from \mbox{\hyperlink{classcore_1_1Socket_a81e5ee3e17834166d97c6e8b7dfe0da0}{core\+::\+Socket}}. -\mbox{\Hypertarget{classcore_1_1TLSSession_a8e26fdc9e8a6c573b5a504a1f1b137a9}\label{classcore_1_1TLSSession_a8e26fdc9e8a6c573b5a504a1f1b137a9}} -\index{core::TLSSession@{core::TLSSession}!onRegistered@{onRegistered}} -\index{onRegistered@{onRegistered}!core::TLSSession@{core::TLSSession}} -\doxysubsubsection{\texorpdfstring{onRegistered()}{onRegistered()}} -{\footnotesize\ttfamily void core\+::\+T\+L\+S\+Session\+::on\+Registered (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}} - -Set this value to control the next read event coming from this socket. - -Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_aed4ed499b978bcea57a8efefe929fc98}{core\+::\+T\+C\+P\+Session}}. - \mbox{\Hypertarget{classcore_1_1TLSSession_ae55de8a035d1ddc560cf619b2030af43}\label{classcore_1_1TLSSession_ae55de8a035d1ddc560cf619b2030af43}} \index{core::TLSSession@{core::TLSSession}!output@{output}} \index{output@{output}!core::TLSSession@{core::TLSSession}}