LibBeamApi  0.3.8
Public Types | Public Member Functions | Protected Attributes | List of all members
BComms Class Referenceabstract

#include <BComms.h>

Public Types

enum  Wait { WaitNone = 0x00, WaitRead = 0x01, WaitWrite = 0x02, WaitError = 0x04 }
 

Public Member Functions

 BComms ()
 
virtual ~BComms ()
 
virtual BError init ()
 
virtual BError setPacketMode (Bool packetMode)
 Set packet mode. More...
 
virtual Bool packetMode ()
 Device is in packet mode. More...
 
virtual BError setTimeout (BInt timeoutMs)
 Set communication timeout. More...
 
virtual BUInt writeAvailable ()
 
virtual BError write (const void *data, BUInt32 nBytes, BUInt32 &nTrans)=0
 
virtual BUInt readAvailable ()
 
virtual BError read (void *data, BUInt32 num, BUInt32 &nTrans)=0
 
virtual BError wait (BUInt8 events, BInt timeout=-1, BUInt32 num=1)
 
virtual void eventQueue (BEventQueue *eventQueue, BInt32 event, BUInt num=1)
 

Protected Attributes

Bool opacketMode
 
BInt32 otimeout
 
BEventQueueoeventQueue
 
BInt32 oevent
 
BUInt oeventNum
 

Member Enumeration Documentation

Enumerator
WaitNone 
WaitRead 
WaitWrite 
WaitError 

Constructor & Destructor Documentation

BComms::BComms ( )
BComms::~BComms ( )
virtual

Member Function Documentation

void BComms::eventQueue ( BEventQueue eventQueue,
BInt32  event,
BUInt  num = 1 
)
virtual
BError BComms::init ( )
virtual
Bool BComms::packetMode ( )
virtual

Device is in packet mode.

virtual BError BComms::read ( void *  data,
BUInt32  num,
BUInt32 nTrans 
)
pure virtual
BUInt BComms::readAvailable ( )
virtual
BError BComms::setPacketMode ( Bool  packetMode)
virtual

Set packet mode.

BError BComms::setTimeout ( BInt  timeoutMs)
virtual

Set communication timeout.

BError BComms::wait ( BUInt8  events,
BInt  timeout = -1,
BUInt32  num = 1 
)
virtual
virtual BError BComms::write ( const void *  data,
BUInt32  nBytes,
BUInt32 nTrans 
)
pure virtual
BUInt BComms::writeAvailable ( )
virtual

Member Data Documentation

BInt32 BComms::oevent
protected
BUInt BComms::oeventNum
protected
BEventQueue* BComms::oeventQueue
protected
Bool BComms::opacketMode
protected
BInt32 BComms::otimeout
protected

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