core::ConsoleSession Class Reference

#include <ConsoleSession.h>

Inheritance diagram for core::ConsoleSession:

Collaboration diagram for core::ConsoleSession:

Public Member Functions
	ConsoleSession (EPoll &ePoll, TCPServer &server)
void	writeLog (std::string data)
Public Member Functions inherited from core::TerminalSession
	TerminalSession (EPoll &ePoll, TCPServer &server)
int	getLines ()
void	clear ()
void	clearEOL ()
void	setCursorLocation (int x, int y)
void	setColor (int color)
void	setBackColor (int color)
void	saveCursor ()
void	restoreCursor ()
void	NextLine (int lines)
void	PreviousLine (int lines)
void	scrollArea (int start, int end)
Public Member Functions inherited from core::TLSSession
	TLSSession (EPoll &ePoll, TCPServer &server)
virtual void	output (std::stringstream &out)
Public Member Functions inherited from core::TCPSession
	TCPSession (EPoll &ePoll, TCPServer &server)
	TCPSession (EPoll &ePoll, TCPServer &server, std::string text)
void	send (std::string data)
void	sendToAll (std::string data)
void	sendToAll (SessionFilter filter, std::string data)
Public Member Functions inherited from core::TCPSocket
	TCPSocket (EPoll &ePoll)
	TCPSocket (EPoll &ePoll, std::string text)
void	connect (IPAddress &address)
Public Member Functions inherited from core::Socket
	Socket (EPoll &ePoll)
	Socket (EPoll &ePoll, std::string text)
void	shutdown (std::string text="unknown")
void	setDescriptor (int descriptor)
	Set the descriptor for the socket. More...
int	getDescriptor ()
	Get the descriptor for the socket.
bool	eventReceived (struct epoll_event event)
	Parse epoll event and call specified callbacks. More...
int	write (std::string data)
void	write (char *buffer, int length)
void	output (std::stringstream &out)
virtual void	onUnregister ()
	Called when the socket has finished unregistering for the epoll processing. More...
bool	needsToWrite ()

Protected Member Functions
void	protocol (std::stringstream &out, std::string data) override
Protected Member Functions inherited from core::TLSSession
void	receiveData (char *buffer, int bufferLength) override
void	onRegister ()
	Called when the socket has finished registering with the epoll processing. More...
void	onRegistered ()
Protected Member Functions inherited from core::TCPSession
virtual void	onDataReceived (std::string data) override
	Called when data is received from the socket. More...
virtual void	onConnected (std::stringstream &out)
Protected Member Functions inherited from core::Socket
void	setBufferSize (int length)
virtual void	onDataReceived (char *buffer, int len)

Additional Inherited Members
Public Attributes inherited from core::TerminalSession
std::stringstream	out
Public Attributes inherited from core::TCPSession
Command *	grab = NULL
TCPServer &	server
Public Attributes inherited from core::TCPSocket
IPAddress	ipAddress
Public Attributes inherited from core::Socket
class {
}	bufferSize
bool	active = false
Public Attributes inherited from core::Object
std::string	name
std::string	tag
Protected Attributes inherited from core::Socket
EPoll &	ePoll
bool	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.

Member Function Documentation

protocol()

void core::ConsoleSession::protocol ( std::stringstream &  out, std::string  data = ""  )

overrideprotectedvirtual

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.

Reimplemented from core::TLSSession.

---

The documentation for this class was generated from the following files:

• ConsoleSession.h
• ConsoleSession.cpp