This class implements a Shell command. More...

Detailed Description

This class implements a Shell command.

#include <Threads.h>

Inheritance diagram for Cpl::TShell::Cmd::Threads:

Collaboration diagram for Cpl::TShell::Cmd::Threads:

Public Member Functions
const char *	getUsage () const noexcept
	See Cpl::TShell::Command.

const char *	getHelp () const noexcept
	See Cpl::TShell::Command.

	Threads (Cpl::Container::Map< Cpl::TShell::Command > &commandList, Security::Permission_T minPermLevel=OPTION_TSHELL_CMD_COMMAND_DEFAULT_PERMISSION_LEVEL) noexcept
	Constructor.

Cpl::TShell::Command::Result_T	execute (Cpl::TShell::Context_ &context, char *cmdString, Cpl::Io::Output &outfd) noexcept
	See Cpl::TShell::Command.

Cpl::Type::Traverser::Status_T	item (Cpl::System::Thread &nextThread)
	See Cpl::System::Thread::Traverser.

Public Member Functions inherited from Cpl::TShell::Cmd::Command
const char *	getVerb () const noexcept
	See Cpl::TShell::Command.

Security::Permission_T	getMinPermissionRequired () const noexcept
	See Cpl::TShell::Command.

Public Member Functions inherited from Cpl::TShell::Command
virtual	~Command ()
	Virtual destructor.

Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.

bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.

Public Member Functions inherited from Cpl::System::Thread::Traverser
virtual	~Traverser ()
	Virtual Destructor.

Static Public Attributes
static constexpr const char *	verb = "threads"
	The command verb/identifier.

static constexpr const char *	usage = "threads"
	The command usage string.

static constexpr const char *	detailedHelp = " Displays the list of threads."
	The command detailed help string (recommended that lines do not exceed 80 chars) 1 2 3 4 5 6 7 8 12345678901234567890123456789012345678901234567890123456789012345678901234567890.

Protected Member Functions
virtual void	hookHeader1 (Cpl::Text::String &text)
	Hook when generating list header1 (i.e. subclass appends to the String)

virtual void	hookHeader2 (Cpl::Text::String &text)
	Hook when generating list header2 (i.e. subclass appends to the String)

virtual void	hookThreadEntry (Cpl::Text::String &text, Cpl::System::Thread &currentThread)
	Hook when generating a thread row entry (i.e. subclass appends to the String)

Protected Member Functions inherited from Cpl::TShell::Cmd::Command
	Command (Cpl::Container::Map< Cpl::TShell::Command > &commandList, const char *verb, Security::Permission_T minPermLevel=OPTION_TSHELL_CMD_COMMAND_DEFAULT_PERMISSION_LEVEL) noexcept
	Constructor.

const Cpl::Container::Key &	getKey () const noexcept
	See Cpl::Container::Key.

Protected Member Functions inherited from Cpl::TShell::Command
	Command ()
	Constructor.

Protected Member Functions inherited from Cpl::Container::MapItem
	MapItem ()
	Constructor.

	MapItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor -->special constructor to allow a Map to be statically allocated.

void	initialize (MapItem *parent)
	Initialize the node when being inserted in the tree.

MapItem *	getParent () const
	Get tree connection/pointer.

void	setParent (MapItem *n)
	Set tree connection/pointer.

MapItem *	getLeft () const
	Get tree connection/pointer.

void	setLeft (MapItem *n)
	Set tree connection/pointer.

MapItem *	getRight () const
	Get tree connection/pointer.

void	setRight (MapItem *n)
	Set tree connection/pointer.

Protected Member Functions inherited from Cpl::Container::DictItem
	DictItem ()
	Constructor.

	DictItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Protected Member Functions inherited from Cpl::Container::ExtendedItem
	ExtendedItem ()
	Constructor.

	ExtendedItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.

	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Protected Attributes
Cpl::TShell::Context_ *	m_contextPtr
	Cache my Processor/Shell context when traversing the thread list.

unsigned	m_count
	Count of threads.

bool	m_io
	Cache IO status/errors.

Protected Attributes inherited from Cpl::TShell::Cmd::Command
Cpl::Container::KeyLiteralString	m_mapKey
	Command.

Security::Permission_T	m_minPermissionLevel
	Minimum required user permission need to execute me.

Protected Attributes inherited from Cpl::Container::MapItem
void *	m_parentPtr_
	Link field to the parent node.

bool	m_is_NOT_root_
	I am the root node.

Balance_T	m_balance_
	Balance status.

Protected Attributes inherited from Cpl::Container::DictItem
unsigned int	m_hashCode_
	Remember which hash bucket I am stored in.

Additional Inherited Members
Public Types inherited from Cpl::TShell::Command
enum	Result_T { eSUCCESS = 0 , eERROR_BAD_SYNTAX = 1 , eERROR_INVALID_CMD = 2 , eERROR_IO = 3 , eERROR_MISSING_ARGS = 4 , eERROR_EXTRA_ARGS = 5 , eERROR_INVALID_ARGS = 6 , eERROR_FAILED = 7 }
	Possible result codes when executing a command. More...

Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.

Public Attributes inherited from Cpl::Container::ExtendedItem
void *	m_prevPtr_
	The previous link field.

Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.

void *	m_inListPtr_
	Debug field.

Protected Types inherited from Cpl::TShell::Cmd::Command
enum	CondResult_T { eFALSE , eTRUE , eERROR }
	Result when processing a conditional statement. More...

Protected Types inherited from Cpl::Container::MapItem
enum	Balance_T { eLEFT_ =-1 , eEVEN_ =0 , eRIGHT_ =1 }
	Magic values for balance status. More...

Constructor & Destructor Documentation

◆ Threads()

Cpl::TShell::Cmd::Threads::Threads	(	Cpl::Container::Map< Cpl::TShell::Command > &	commandList,
		Security::Permission_T	minPermLevel = `OPTION_TSHELL_CMD_COMMAND_DEFAULT_PERMISSION_LEVEL`
	)

noexcept

Constructor.

Member Function Documentation

◆ execute()

Cpl::TShell::Command::Result_T Cpl::TShell::Cmd::Threads::execute	(	Cpl::TShell::Context_ &	context,
		char *	cmdString,
		Cpl::Io::Output &	outfd
	)

virtualnoexcept

See Cpl::TShell::Command.

Implements Cpl::TShell::Command.

◆ getHelp()

const char * Cpl::TShell::Cmd::Threads::getHelp ( ) const

inlinevirtualnoexcept

See Cpl::TShell::Command.

Implements Cpl::TShell::Command.

◆ getUsage()

const char * Cpl::TShell::Cmd::Threads::getUsage ( ) const

inlinevirtualnoexcept

See Cpl::TShell::Command.

Implements Cpl::TShell::Command.

◆ hookHeader1()

virtual void Cpl::TShell::Cmd::Threads::hookHeader1 ( Cpl::Text::String & text )

protectedvirtual

Hook when generating list header1 (i.e. subclass appends to the String)

Reimplemented in Cpl::TShell::Cmd::FreeRTOS::Threads, and Cpl::TShell::Cmd::Win32::Threads.

◆ hookHeader2()

virtual void Cpl::TShell::Cmd::Threads::hookHeader2 ( Cpl::Text::String & text )

protectedvirtual

Hook when generating list header2 (i.e. subclass appends to the String)

Reimplemented in Cpl::TShell::Cmd::FreeRTOS::Threads, and Cpl::TShell::Cmd::Win32::Threads.

◆ hookThreadEntry()

virtual void Cpl::TShell::Cmd::Threads::hookThreadEntry	(	Cpl::Text::String &	text,
		Cpl::System::Thread &	currentThread
	)

protectedvirtual

Hook when generating a thread row entry (i.e. subclass appends to the String)

Reimplemented in Cpl::TShell::Cmd::FreeRTOS::Threads, and Cpl::TShell::Cmd::Win32::Threads.

◆ item()

Cpl::Type::Traverser::Status_T Cpl::TShell::Cmd::Threads::item ( Cpl::System::Thread & nextThread )

virtual

See Cpl::System::Thread::Traverser.

Implements Cpl::System::Thread::Traverser.

Member Data Documentation

◆ detailedHelp

constexpr const char* Cpl::TShell::Cmd::Threads::detailedHelp = " Displays the list of threads."

staticconstexpr

The command detailed help string (recommended that lines do not exceed 80 chars) 1 2 3 4 5 6 7 8 12345678901234567890123456789012345678901234567890123456789012345678901234567890.

◆ m_contextPtr

Cpl::TShell::Context_* Cpl::TShell::Cmd::Threads::m_contextPtr

protected

Cache my Processor/Shell context when traversing the thread list.

◆ m_count

unsigned Cpl::TShell::Cmd::Threads::m_count

protected

Count of threads.

◆ m_io

bool Cpl::TShell::Cmd::Threads::m_io

protected

Cache IO status/errors.

◆ usage

constexpr const char* Cpl::TShell::Cmd::Threads::usage = "threads"

staticconstexpr

The command usage string.

◆ verb

constexpr const char* Cpl::TShell::Cmd::Threads::verb = "threads"

staticconstexpr

The command verb/identifier.

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

Cpl/TShell/Cmd/Threads.h

Detailed Description

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Threads()

Member Function Documentation

◆ execute()

◆ getHelp()

◆ getUsage()

◆ hookHeader1()

◆ hookHeader2()

◆ hookThreadEntry()

◆ item()

Member Data Documentation

◆ detailedHelp

◆ m_contextPtr

◆ m_count

◆ m_io

◆ usage

◆ verb