This class defines an I/O channel that communicates via a console. More...

#include <conchan.h>

Inheritance diagram for PConsoleChannel:

Collaboration diagram for PConsoleChannel:

Public Types
enum	ConsoleType { StandardInput, StandardOutput, StandardError }

enum	{ KeyLeft = 0x10000, KeyRight, KeyUp, KeyDown, KeyPageUp, KeyPageDown, KeyHome, KeyEnd, KeyBackSpace, KeyDelete, KeyInsert, KeyFuncBase = 0x10100, KeyF1 = KeyFuncBase+1, KeyF2, KeyF3, KeyF4, KeyF5, KeyF6, KeyF7, KeyF8, KeyF9, KeyF10, KeyF11, KeyF12, MouseEvent = 0x40000000, MouseButton1 = 1, MouseButton2 = 2, MouseButton3 = 4, MouseButton4 = 8, MouseClickShift = 4, MouseDoubleClick = 0x80, MouseShiftKey = 0x100, MouseCtrlKey = 0x100, MouseAltKey = 0x200, MouseRowShift = 20, MouseColShift = 12 }
	Special retrun codes from console input. More...

Public Types inherited from PChannel
enum	PXBlockType { PXReadBlock, PXWriteBlock, PXAcceptBlock, PXConnectBlock }

enum	Errors { NoError, NotFound, FileExists, DiskFull, AccessDenied, DeviceInUse, BadParameter, NoMemory, NotOpen, Timeout, Interrupted, BufferTooSmall, Miscellaneous, ProtocolFailure, Unavailable, NumNormalisedErrors }
	Normalised error codes. More...

enum	ErrorGroup { LastReadError, LastWriteError, LastGeneralError, NumErrorGroups }
	Error groups. More...

typedef PNotifierTemplate < PChannel::AsyncContext & >	AsyncNotifier

enum	ShutdownValue { ShutdownRead = 0, ShutdownWrite = 1, ShutdownReadAndWrite = 2 }

Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the `Compare()` function. More...

Public Member Functions
Construction
	PConsoleChannel ()
	Create a new console channel object, leaving it unopen. More...

	PConsoleChannel (ConsoleType type)
	Create a new console channel object, connecting to the I/O stream. More...

	~PConsoleChannel ()
	Make sure dtor closes channel. More...

Overrides from PChannel
virtual PString	GetName () const
	Get the platform and I/O channel type name of the channel. More...

virtual PBoolean	Close ()
	Close the channel, shutting down the link to the data source. More...

virtual int	ReadChar ()
	Read a single 8 bit byte from the channel. More...

virtual bool	SetLocalEcho (bool localEcho)
	Set local echo mode. More...

virtual bool	SetLineBuffered (bool lineBuffered)
	Set line buffered mode. More...

New functions
virtual PBoolean	Open (ConsoleType type)
	Open a serial channal. More...

virtual bool	GetTerminalSize (unsigned &rows, unsigned &columns)
	Get output terminal size, if known. More...

Public Member Functions inherited from PChannel
PBoolean	SetErrorValues (Errors errorCode, int osError, ErrorGroup group=LastGeneralError)
	Set error values to those specified. More...

virtual Comparison	Compare (const PObject &obj) const
	Get the relative rank of the two strings. More...

virtual PINDEX	HashFunction () const
	Calculate a hash value for use in sets and dictionaries. More...

virtual PBoolean	IsOpen () const
	Determine if the channel is currently open. More...

virtual P_INT_PTR	GetHandle () const
	Get the integer operating system handle for the channel. More...

FILE *	FDOpen (const char *mode)
	Re-open the device using the stdio library. More...

virtual PChannel *	GetBaseReadChannel () const
	Get the base channel of channel indirection using PIndirectChannel. More...

virtual PChannel *	GetBaseWriteChannel () const
	Get the base channel of channel indirection using PIndirectChannel. More...

virtual bool	CloseBaseReadChannel ()
	Close the base channel of channel indirection using PIndirectChannel. More...

virtual bool	CloseBaseWriteChannel ()
	Close the base channel of channel indirection using PIndirectChannel. More...

void	SetReadTimeout (const PTimeInterval &time)
	Set the timeout for read operations. More...

PTimeInterval	GetReadTimeout () const
	Get the timeout for read operations. More...

virtual PBoolean	Read (void *buf, PINDEX len)
	Low level read from the channel. More...

virtual PINDEX	GetLastReadCount () const
	Get the number of bytes read by the last Read() call. More...

virtual PINDEX	SetLastReadCount (PINDEX count)

PBoolean	ReadBlock (void *buf, PINDEX len)
	Read len bytes into the buffer from the channel. More...

PString	ReadString (PINDEX len)
	Read `len` character into a string from the channel. More...

void	SetWriteTimeout (const PTimeInterval &time)
	Set the timeout for write operations to complete. More...

PTimeInterval	GetWriteTimeout () const
	Get the timeout for write operations to complete. More...

virtual PBoolean	Write (const void *buf, PINDEX len)
	Low level write to the channel. More...

virtual PBoolean	Write (const void buf, PINDEX len, const void )
	Low level write to the channel with marker. More...

virtual PINDEX	GetLastWriteCount () const
	Get the number of bytes written by the last Write() call. More...

virtual PINDEX	SetLastWriteCount (PINDEX count)

PBoolean	WriteChar (int c)
	Write a single character to the channel. More...

PBoolean	WriteString (const PString &str)
	Write a string to the channel. More...

	~PChannel ()
	Close down the channel. More...

Errors	GetErrorCode (ErrorGroup group=NumErrorGroups) const
	Get normalised error code. More...

int	GetErrorNumber (ErrorGroup group=NumErrorGroups) const
	Get OS errro code. More...

virtual PString	GetErrorText (ErrorGroup group=NumErrorGroups) const
	Get error message description. More...

virtual bool	ReadAsync (AsyncContext &context)
	Begin an asynchronous read from channel. More...

virtual void	OnReadComplete (AsyncContext &context)
	User callback function for when a `ReadAsync()` call has completed or timed out. More...

virtual bool	WriteAsync (AsyncContext &context)
	Begin an asynchronous write from channel. More...

virtual void	OnWriteComplete (AsyncContext &context)
	User callback function for when a WriteAsync() call has completed or timed out. More...

virtual PBoolean	Shutdown (ShutdownValue option)
	Close one or both of the data streams associated with a channel. More...

virtual bool	FlowControl (const void *flowData)
	Flow Control information Pass data to the channel for flowControl determination. More...

PBoolean	SetBufferSize (PINDEX newSize)
	Set the iostream buffer size for reads and writes. More...

PBoolean	SendCommandString (const PString &command)
	Send a command meta-string. More...

void	AbortCommandString ()
	Abort a command string that is in progress. More...

Public Member Functions inherited from PObject
__inline unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...

__inline void	SetTraceContextIdentifier (unsigned id)

__inline void	SetTraceContextIdentifier (const PObject &obj)

__inline void	SetTraceContextIdentifier (const PObject *obj)

__inline void	CopyTraceContextIdentifier (PObject &obj) const

__inline void	CopyTraceContextIdentifier (PObject *obj) const

virtual	~PObject ()

__inline const char *	GetClass () const

__inline bool	IsClass (const char *name) const

__inline const PObject *	PTraceObjectInstance () const

virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...

template<class CLS >
CLS *	CloneAs () const
	As for Clone() but converts to specified type. More...

virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...

bool	operator== (const PObject &obj) const
	Compare the two objects. More...

bool	operator!= (const PObject &obj) const
	Compare the two objects. More...

bool	operator< (const PObject &obj) const
	Compare the two objects. More...

bool	operator> (const PObject &obj) const
	Compare the two objects. More...

bool	operator<= (const PObject &obj) const
	Compare the two objects. More...

bool	operator>= (const PObject &obj) const
	Compare the two objects. More...

virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...

virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Additional Inherited Members
Static Public Member Functions inherited from PChannel
static PString	GetErrorText (Errors lastError, int osError=0)
	Get error message description. More...

Static Public Member Functions inherited from PObject
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject *from)

static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject to, const PObject from)

static __inline const char *	Class ()

static __inline const PObject *	PTraceObjectInstance (const char *)

static __inline const PObject *	PTraceObjectInstance (const PObject *obj)

template<typename T >
static Comparison	Compare2 (T v1, T v2)
	Compare two types, returning Comparison type. More...

static Comparison	InternalCompareObjectMemoryDirect (const PObject obj1, const PObject obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...

Protected Member Functions inherited from PChannel
	PChannel (const PChannel &)

PChannel &	operator= (const PChannel &)

virtual PBoolean	ConvertOSError (P_INT_PTR libcReturnValue, ErrorGroup group=LastGeneralError)
	Convert an operating system error into platform independent error. More...

int	ReadCharWithTimeout (PTimeInterval &timeout)
	Read a character with specified timeout. More...

PBoolean	ReceiveCommandString (int nextChar, const PString &reply, PINDEX &pos, PINDEX start)

bool	CheckNotOpen ()

virtual int	os_errno () const

PBoolean	PXSetIOBlock (PXBlockType type, const PTimeInterval &timeout)

P_INT_PTR	GetOSHandleAsInt () const

int	PXClose ()

	PDECLARE_MUTEX (px_threadMutex)

	PDECLARE_MUTEX (px_writeMutex)

	PChannel ()
	Create the channel. More...

Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes inherited from PChannel
PTimeInterval	readTimeout
	Timeout for read operations. More...

PTimeInterval	writeTimeout
	Timeout for write operations. More...

atomic< P_INT_PTR >	os_handle
	The operating system file handle return by standard open() function. More...

PThreadLocalStorage< Status >	m_status [NumErrorGroups+1]

PXBlockType	px_lastBlockType

PThread *	px_readThread

PThread *	px_writeThread

PThread *	px_selectThread [3]

PCriticalSection	px_selectMutex [3]

Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Detailed Description

This class defines an I/O channel that communicates via a console.

Member Enumeration Documentation

anonymous enum

Special retrun codes from console input.

Enumerator
KeyLeft
KeyRight
KeyUp
KeyDown
KeyPageUp
KeyPageDown
KeyHome
KeyEnd
KeyBackSpace
KeyDelete
KeyInsert
KeyFuncBase
KeyF1
KeyF2
KeyF3
KeyF4
KeyF5
KeyF6
KeyF7
KeyF8
KeyF9
KeyF10
KeyF11
KeyF12
MouseEvent
MouseButton1	State of (usually) left button.
MouseButton2	State of (usually) right button.
MouseButton3	State of (usually) middle button.
MouseButton4	State of (on the side?) button.
MouseClickShift	3 bits for button that was "clicked", that is went down and up. Zero is none.
MouseDoubleClick	The click was a double.
MouseShiftKey	The shift key is down.
MouseCtrlKey	The control key is down.
MouseAltKey	The control key is down.
MouseRowShift	Shift to get 8 bit row.
MouseColShift	Shift to get 8 bit column.

enum PConsoleChannel::ConsoleType

Enumerator
StandardInput
StandardOutput
StandardError

Constructor & Destructor Documentation

PConsoleChannel::PConsoleChannel ( )

Create a new console channel object, leaving it unopen.

PConsoleChannel::PConsoleChannel ( ConsoleType type )

Create a new console channel object, connecting to the I/O stream.

Parameters

type	Type of console for object

PConsoleChannel::~PConsoleChannel ( )

inline

Make sure dtor closes channel.

Member Function Documentation

virtual PBoolean PConsoleChannel::Close ( )

virtual

Close the channel, shutting down the link to the data source.

Returns: true if the channel successfully closed.

Reimplemented from PChannel.

virtual PString PConsoleChannel::GetName ( ) const

virtual

Get the platform and I/O channel type name of the channel.

For example, it would return the filename in PFile type channels.

Returns: the name of the channel.

Implements PChannel.

virtual bool PConsoleChannel::GetTerminalSize	(	unsigned &	rows,
		unsigned &	columns
	)

virtual

Get output terminal size, if known.

Parameters

rows	Terminal rows
columns	Terminal columns

virtual PBoolean PConsoleChannel::Open ( ConsoleType type )

virtual

Open a serial channal.

The channel is opened it on the specified port and with the specified attributes.

Parameters

type	Type of console for object

virtual int PConsoleChannel::ReadChar ( )

virtual

Read a single 8 bit byte from the channel.

If one was not available within the read timeout period, or an I/O error occurred, then the function gives with a -1 return value.

Returns: byte read or -1 if no character could be read.

Reimplemented from PChannel.

virtual bool PConsoleChannel::SetLineBuffered ( bool lineBuffered )

virtual

Set line buffered mode.

For some classes of channel, e.g. PConsoleChannel, data read by this channel is not returned until a whole line is .

Default behaviour does nothing and return true if the channel is open.

virtual bool PConsoleChannel::SetLocalEcho ( bool localEcho )

virtual

Set local echo mode.

For some classes of channel, e.g. PConsoleChannel, data read by this channel is automatically echoed. This disables the function so things like password entry can work.

Default behaviour does nothing and return true if the channel is open.

Reimplemented from PChannel.

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

conchan.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation