Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

IOLayer Class Reference

#include </home/clem/local/src/opie/noncore/apps/opie-console/io_layer.h>

Inheritance diagram for IOLayer:

Inheritance graph
[legend]
List of all members.

Public Types

enum  Error {
  NoError = -1, Refuse = 0, CouldNotOpen = 1, ClosedUnexpected = 2,
  ClosedError = 3, Terminate = 4
}
enum  Feature { AutoConnect = 0, TransferFile = 1, Close = 2 }

Public Slots

virtual void send (const QByteArray &)=0
virtual bool open ()=0
virtual void close ()=0
virtual void reload (const Profile &)=0
virtual void setSize (int lines, int cols)

Signals

virtual void received (const QByteArray &)
virtual void error (int, const QString &)
virtual void closed ()
virtual void closed (IOLayer *)

Public Member Functions

 IOLayer ()
 IOLayer (const Profile &)
virtual ~IOLayer ()
virtual QString identifier () const =0
virtual QString name () const =0
virtual int rawIO () const
virtual void closeRawIO (int)
virtual QBitArray supports () const =0
virtual bool isConnected ()=0

Detailed Description

This is the base class for IO Layers It will used to sent and recv data( QByteArray ) it

Definition at line 17 of file io_layer.h.


Member Enumeration Documentation

enum IOLayer::Error
 

Enumeration values:
NoError 
Refuse 
CouldNotOpen 
ClosedUnexpected 
ClosedError 
Terminate 

Definition at line 20 of file io_layer.h.

enum IOLayer::Feature
 

Enumeration values:
AutoConnect 
TransferFile 
Close 

Definition at line 29 of file io_layer.h.


Constructor & Destructor Documentation

IOLayer::IOLayer  ) 
 

a small c'tor

Definition at line 3 of file io_layer.cpp.

IOLayer::IOLayer const Profile  ) 
 

create an IOLayer instance from a config file the currently set group stores the profile/session information

Definition at line 8 of file io_layer.cpp.

IOLayer::~IOLayer  )  [virtual]
 

destructor

Definition at line 13 of file io_layer.cpp.


Member Function Documentation

virtual void IOLayer::close  )  [pure virtual, slot]
 

close the io

Implemented in IOBt, IOIrda, IOModem, IOSerial, and MyPty.

virtual void IOLayer::closed IOLayer  )  [virtual, signal]
 

virtual void IOLayer::closed  )  [virtual, signal]
 

void IOLayer::closeRawIO int   )  [virtual]
 

will close the rawIO stuff and will listen to it's data again...

Reimplemented in IOSerial.

Definition at line 18 of file io_layer.cpp.

virtual void IOLayer::error int  ,
const QString
[virtual, signal]
 

an error occured int for the error number and QString for a text

Reimplemented in IOBt, IOIrda, and IOModem.

Referenced by IOSerial::close(), IOSerial::errorOccured(), IOSerial::open(), and IOSerial::send().

virtual QString IOLayer::identifier  )  const [pure virtual]
 

a small internal identifier

Implemented in IOBt, IOIrda, IOModem, IOSerial, and MyPty.

virtual bool IOLayer::isConnected  )  [pure virtual]
 

Implemented in IOSerial, and MyPty.

virtual QString IOLayer::name  )  const [pure virtual]
 

a short name

Implemented in IOBt, IOIrda, IOModem, IOSerial, and MyPty.

virtual bool IOLayer::open  )  [pure virtual, slot]
 

bool open

Implemented in IOBt, IOIrda, IOModem, IOSerial, and MyPty.

int IOLayer::rawIO  )  const [virtual]
 

a file descriptor which opens the device for io but does not do any ioctling on it... and it'll stop listening to the before opened device

Reimplemented in IOSerial.

Definition at line 15 of file io_layer.cpp.

virtual void IOLayer::received const QByteArray  )  [virtual, signal]
 

received input as QCString

Reimplemented in IOBt, IOIrda, IOModem, and MyPty.

Referenced by IOSerial::dataArrived().

virtual void IOLayer::reload const Profile  )  [pure virtual, slot]
 

closes and reloads the settings

Implemented in IOBt, IOIrda, IOModem, IOSerial, and MyPty.

virtual void IOLayer::send const QByteArray  )  [pure virtual, slot]
 

send a QCString to the device

Implemented in IOSerial, and MyPty.

void IOLayer::setSize int  lines,
int  cols
[virtual, slot]
 

set the size needed for pty

Reimplemented in MyPty, and MyPty.

Definition at line 21 of file io_layer.cpp.

virtual QBitArray IOLayer::supports  )  const [pure virtual]
 

What does the IOLayer support? Bits are related to features

Implemented in IOSerial, and MyPty.


The documentation for this class was generated from the following files:
Generated on Sat Nov 5 17:36:25 2005 for OPIE by  doxygen 1.4.2