Cpl::TShell::Socket Class Reference

This concrete class provides a socket listener/server and 'threading wrapper' for running a TShell Command Processor. More...

Detailed Description

This concrete class provides a socket listener/server and 'threading wrapper' for running a TShell Command Processor.

Only one socket connection is allowed at any given time to the Shell.

NOTE: This class dynamically allocates memory and dynamically creates a Thread!

#include <Socket.h>

Inheritance diagram for Cpl::TShell::Socket:

Collaboration diagram for Cpl::TShell::Socket:

Public Member Functions
	Socket (ProcessorApi &shell, Cpl::Io::Socket::Listener &listener, const char *threadName="TShell", int threadPriority=CPL_SYSTEM_THREAD_PRIORITY_NORMAL+CPL_SYSTEM_THREAD_PRIORITY_LOWER, bool thisIsAStaticInstance=true) noexcept
	Constructor.
	~Socket ()
	Destructor. Note: the referenced 'listener' is NOT destroyed/clean-up since it was NOT created by me.
void	launch (int portNumToListenOn) noexcept
	This method starts the Processor.
bool	newConnection (Cpl::Io::Descriptor newFd, const char *rawConnectionInfo)
	See Cpl::Io::Socket::Listener::Client.
Public Member Functions inherited from Cpl::Io::Socket::Listener::Client
virtual	~Client ()
	Virtual destructor.

Protected Attributes
ProcessorApi &	m_shell
	Command Processor to run.
Cpl::System::Thread *	m_threadPtr
	Thread that the shell runs in.
int	m_priority
	Thread priority to run the shell.
const char *	m_name
	Thread name for the shell.
Cpl::Io::Socket::Listener &	m_listener
	Socket Listener (is ASSUMED to be a runnable instance)
Cpl::Io::Socket::InputOutput	m_stream
	Socket stream.
bool	m_staticInstance
	How I was created.

Constructor & Destructor Documentation

Socket()

Cpl::TShell::Socket::Socket ( ProcessorApi &  shell, Cpl::Io::Socket::Listener &  listener, const char *  threadName = "TShell", int  threadPriority = CPL_SYSTEM_THREAD_PRIORITY_NORMAL+CPL_SYSTEM_THREAD_PRIORITY_LOWER, bool  thisIsAStaticInstance = true  )

noexcept

Constructor.

The 'thisIsAStaticInstance' argument is to inform the instance being create that it is being created statically (i.e. before main() is entered) - which is the intended typically behavior. This knowledge is used to inhibit delete/destroy-thread actions in the instance's destructor. This is necessary because there is no guaranteed order to when static destructor fire and as such the state of the CPL Libraries static resources (e.g. mutexes) are unknown which your application will crash/behavior poorly on exit.

~Socket()

Cpl::TShell::Socket::~Socket

(

)

Destructor. Note: the referenced 'listener' is NOT destroyed/clean-up since it was NOT created by me.

Member Function Documentation

launch()

void Cpl::TShell::Socket::launch ( int  portNumToListenOn )

noexcept

This method starts the Processor.

It is thread safe in that it runs in the context of the calling thread - and spawns a new thread for Shell/Command Processor to executing in.

newConnection()

bool Cpl::TShell::Socket::newConnection ( Cpl::Io::Descriptor  newFd, const char *  rawConnectionInfo  )

virtual

See Cpl::Io::Socket::Listener::Client.

Implements Cpl::Io::Socket::Listener::Client.

Member Data Documentation

m_listener

Cpl::Io::Socket::Listener& Cpl::TShell::Socket::m_listener

protected

Socket Listener (is ASSUMED to be a runnable instance)

m_name

const char* Cpl::TShell::Socket::m_name

protected

Thread name for the shell.

m_priority

int Cpl::TShell::Socket::m_priority

protected

Thread priority to run the shell.

m_shell

ProcessorApi& Cpl::TShell::Socket::m_shell

protected

Command Processor to run.

m_staticInstance

bool Cpl::TShell::Socket::m_staticInstance

protected

How I was created.

m_stream

Cpl::Io::Socket::InputOutput Cpl::TShell::Socket::m_stream

protected

Socket stream.

m_threadPtr

Cpl::System::Thread* Cpl::TShell::Socket::m_threadPtr

protected

Thread that the shell runs in.

---

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

• Cpl/TShell/Socket.h