PConsoleChannel Class Reference

#include <conchan.h>

Inheritance diagram for PConsoleChannel:

PChannel PObject List of all members.

Public Types

enum  ConsoleType { StandardInput, StandardOutput, StandardError }

Public Member Functions

PString GetName () const
BOOL Close ()
Open functions
virtual BOOL Open (ConsoleType type)

Detailed Description

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


Member Enumeration Documentation

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 (  ) 

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


Member Function Documentation

virtual BOOL 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

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.

Reimplemented from PChannel.

BOOL PConsoleChannel::Close (  )  [virtual]

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

Returns:
TRUE if the channel successfully closed.

Reimplemented from PChannel.


The documentation for this class was generated from the following file:
Generated on Fri Mar 7 06:25:04 2008 for PTLib by  doxygen 1.5.1