NonBlockingIODevice Class Reference

Non-blocking input device. More...

#include <non_blocking_io_device.h>

Inheritance diagram for NonBlockingIODevice:

Public Member Functions
	NonBlockingIODevice (const char *const STR_DbgName, const bool B_AutoDelete)
	Main constructor. More...
virtual	~NonBlockingIODevice (void)
	Destructor. More...
virtual const KEY	GetKey (void) const
	Input key capture handler. More...
virtual void	OnKey (const KEY E_Key) const
	Handler to call when a key is received. More...
Public Member Functions inherited from IODevice
	IODevice (const char *const STR_DbgName, const bool B_AutoDelete)
	Constructor. More...
virtual	~IODevice (void)
	Destructor. 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...

Protected Member Functions
const ExecutionContext *const	GetExecutionContext (void) const
	Returns the current execution context. More...
Protected Member Functions inherited from IODevice
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
Static Public Member Functions inherited from IODevice
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 Attributes inherited from OutputDevice
ResourceString	m_cliLastError

Detailed Description

Non-blocking input device.

Definition at line 50 of file non_blocking_io_device.h.

Constructor & Destructor Documentation

NonBlockingIODevice()

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

explicit

Main constructor.

Parameters

STR_DbgName	Debug name.
B_AutoDelete	Auto-deletion flag.

~NonBlockingIODevice()

virtual NonBlockingIODevice::~NonBlockingIODevice ( void  )

virtual

Destructor.

Member Function Documentation

GetExecutionContext()

const ExecutionContext* const NonBlockingIODevice::GetExecutionContext ( void  ) const

protected

Returns the current execution context.

Returns

Current execution context if any, NULL otherwise.

GetKey()

virtual const KEY NonBlockingIODevice::GetKey ( void  ) const

virtual

Input key capture handler.

Warning

Blocking call.

Returns

KEY code captured.

Implements IODevice.

Reimplemented in TelnetConnection.

OnKey()

virtual void NonBlockingIODevice::OnKey ( const KEY  E_Key ) const

virtual

Handler to call when a key is received.

Parameters

E_Key

Input key.

Reimplemented in TelnetConnection.

---

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

• non_blocking_io_device.h