BComms Class Reference

#include <BComms.h>

Public Types
enum	Flush { FlushRead, FlushWrite, FlushReadWrite }

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 (BTimeout timeoutUs)
	Set communication timeout. More...
virtual BError	connect (const char *resource)
	Create a connection. More...
virtual Bool	isConnected ()
virtual BError	disconnect ()
	Disconnect. More...
virtual void	flush (Flush flush)
virtual BUInt	writeAvailable ()
virtual BError	write (const void *data, BUInt32 nBytes, BUInt32 &nTrans)=0
virtual BError	writeChunks (const BDataChunk *chunks, BUInt nChunks, BUInt32 &nTrans)
virtual BUInt	readAvailable ()
virtual BError	read (void *data, BUInt32 num, BUInt32 &nTrans)=0
virtual BError	wait (BEventWaitSet events, BTimeout timeoutUs=BTimeoutForever, BUInt32 num=1)
virtual void	eventQueue (BEventQueue *eventQueue, BInt32 event, BUInt num=1)

Protected Attributes
Bool	oconnected
Bool	opacketMode
BTimeout	otimeout
BEventQueue *	oeventQueue
BInt32	oevent
BUInt	oeventNum

Member Enumeration Documentation

Flush

enum BComms::Flush

Enumerator
FlushRead
FlushWrite
FlushReadWrite

Constructor & Destructor Documentation

BComms()

BComms::BComms

(

)

~BComms()

BComms::~BComms ( )

virtual

Member Function Documentation

connect()

BError BComms::connect ( const char *  resource )

virtual

Create a connection.

disconnect()

BError BComms::disconnect ( )

virtual

Disconnect.

eventQueue()

void BComms::eventQueue ( BEventQueue *  eventQueue, BInt32  event, BUInt  num = 1  )

virtual

flush()

void BComms::flush ( Flush  flush )

virtual

init()

BError BComms::init ( )

virtual

isConnected()

Bool BComms::isConnected ( )

virtual

packetMode()

Bool BComms::packetMode ( )

virtual

Device is in packet mode.

read()

virtual BError BComms::read ( void *  data, BUInt32  num, BUInt32 &  nTrans  )

pure virtual

readAvailable()

BUInt BComms::readAvailable ( )

virtual

setPacketMode()

BError BComms::setPacketMode ( Bool  packetMode )

virtual

Set packet mode.

setTimeout()

BError BComms::setTimeout ( BTimeout  timeoutUs )

virtual

Set communication timeout.

wait()

BError BComms::wait ( BEventWaitSet  events, BTimeout  timeoutUs = BTimeoutForever, BUInt32  num = 1  )

virtual

write()

virtual BError BComms::write ( const void *  data, BUInt32  nBytes, BUInt32 &  nTrans  )

pure virtual

writeAvailable()

BUInt BComms::writeAvailable ( )

virtual

writeChunks()

BError BComms::writeChunks ( const BDataChunk *  chunks, BUInt  nChunks, BUInt32 &  nTrans  )

virtual

Member Data Documentation

oconnected

Bool BComms::oconnected

protected

oevent

BInt32 BComms::oevent

protected

oeventNum

BUInt BComms::oeventNum

protected

oeventQueue

BEventQueue* BComms::oeventQueue

protected

opacketMode

Bool BComms::opacketMode

protected

otimeout

BTimeout BComms::otimeout

protected

---

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

• BComms.h
• BComms.cpp