Generic input/output device. More...

#include <io_device.h>

Inheritance diagram for IODevice:

[legend]

Public Member Functions
	IODevice (const char *const STR_DbgName, const bool B_AutoDelete)
	Constructor. More...

virtual	~IODevice (void)
	Destructor. More...

virtual const KEY	GetKey (void) const =0
	Input key capture handler. More...

virtual const ResourceString	GetLocation (void) const
	Input location accessor. More...

virtual const bool	WouldInput (const IODevice &CLI_Device) const
	Stack overflow protection. More...

Public Member Functions inherited from OutputDevice
const tk::String	GetDebugName (void) const
	Debug name accessor. More...

const int	UseInstance (const CallInfo &CLI_CallInfo)
	Ensures instance validity. More...

const int	FreeInstance (const CallInfo &CLI_CallInfo)
	Releases the instance. More...

const int	GetInstanceUsers (void) const
	Instance user count accessor. More...

const bool	OpenUp (const CallInfo &CLI_CallInfo)
	Checks the device is opened. More...

const bool	CloseDown (const CallInfo &CLI_CallInfo)
	Indicates the device the client does not need the device to opened anymore. More...

const int	GetOpenUsers (void) const
	Open state user count accessor. More...

const OutputDevice &	operator<< (const std::string &STR_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const tk::String &STR_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const char *const STR_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const char C_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const KEY E_Key) const
	Output operator. More...

const OutputDevice &	operator<< (const uint8_t UI8_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const int16_t I16_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const uint16_t UI16_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const int32_t I32_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const uint32_t UI32_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const int64_t I64_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const uint64_t UI64_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const float F_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const double D_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const void *const PV_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const IOEndl &CLI_IOEndl) const
	Output operator. More...

const ResourceString	GetLastError (void) const
	Last error accessor. More...

virtual void	PutString (const char *const STR_Out) const =0
	Output handler. More...

virtual void	Beep (void) const
	Beep handler. More...

virtual void	CleanScreen (void) const
	Clean screen. More...

virtual const ScreenInfo	GetScreenInfo (void) const
	Screen info accessor. More...

virtual const bool	WouldOutput (const OutputDevice &CLI_Device) const
	Stack overflow protection. More...

Public Member Functions inherited from Object
virtual	~Object (void)=0
	Pure virtual destructor. More...

Static Public Member Functions
static IODevice &	GetNullDevice (void)
	Null device singleton. More...

static IODevice &	GetStdIn (void)
	Standard input device singleton. More...

Static Public Member Functions inherited from OutputDevice
static OutputDevice &	GetNullDevice (void)
	Null device singleton. More...

static OutputDevice &	GetStdOut (void)
	Standard output device singleton. More...

static OutputDevice &	GetStdErr (void)
	Standard error device singleton. More...

Protected Member Functions
const KEY	Char2Key (const int I_Char) const
	Common char translation. More...

Protected Member Functions inherited from OutputDevice
	OutputDevice (const char *const STR_DbgName, const bool B_AutoDelete)
	Constructor. More...

virtual	~OutputDevice (void)
	Destructor. More...

virtual const bool	OpenDevice (void)=0
	Device opening handler. More...

virtual const bool	CloseDevice (void)=0
	Device closure handler. More...

Protected Member Functions inherited from Object
	Object (void)
	Default constructor only available to sub-classes. More...

Additional Inherited Members
Protected Attributes inherited from OutputDevice
ResourceString	m_cliLastError

Detailed Description

Generic input/output device.

See also: endl

Definition at line 581 of file io_device.h.

Constructor & Destructor Documentation

◆ IODevice()

IODevice::IODevice	(	const char *const	STR_DbgName,
		const bool	B_AutoDelete
	)

explicit

Constructor.

Parameters

STR_DbgName	Debug name.
B_AutoDelete	Auto-deletion flag.

◆ ~IODevice()

virtual IODevice::~IODevice ( void )

virtual

Destructor.

Member Function Documentation

◆ Char2Key()

const KEY IODevice::Char2Key ( const int I_Char ) const

protected

Common char translation.

Returns: KEY code corresponding to the given common char, FEED_MORE when the character has been analyzed as part of a sequence, and the end of the sequence should be given to determine the actual KEY.

Note: Routine explicitely renamed in order to cause compilation errors due to the addition of the FEED_MORE return code.

Parameters

I_Char Common char to translate.

◆ GetKey()

virtual const KEY IODevice::GetKey ( void ) const

pure virtual

Input key capture handler.

Warning: Blocking call.

Returns: KEY code captured.

Implemented in TelnetConnection, IOMux, InputFileDevice, SingleCommand, NonBlockingIODevice, and Console.

◆ GetLocation()

virtual const ResourceString IODevice::GetLocation ( void ) const

virtual

Input location accessor.

Returns: Input location resource string.

Reimplemented in IOMux, and InputFileDevice.

◆ GetNullDevice()

static IODevice& IODevice::GetNullDevice ( void )

static

Null device singleton.

Returns: Null device reference.

◆ GetStdIn()

static IODevice& IODevice::GetStdIn ( void )

static

Standard input device singleton.

Returns: Standard input device reference.

◆ WouldInput()

virtual const bool IODevice::WouldInput ( const IODevice & CLI_Device ) const

virtual

Stack overflow protection.

Parameters

CLI_Device Other device that the callee device should check it would input characters from.

Returns: true if the callee device would redirect input to the given device for reading.

Determines whether the current device would input the given device in any ways. Default implementation checks whether CLI_Device is the self device.

Reimplemented in IOMux.

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

io_device.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IODevice()

◆ ~IODevice()

Member Function Documentation

◆ Char2Key()

◆ GetKey()

◆ GetLocation()

◆ GetNullDevice()

◆ GetStdIn()

◆ WouldInput()