---

ConfigConnection Class Reference

#include <ConfigConnection.h>

Inheritance diagram for ConfigConnection:

[legend]Collaboration diagram for ConfigConnection:

[legend]List of all members.

---

Detailed Description

The config connection is a Connection which reads and write XML commands to and from a configurator.

Definition at line 20 of file ConfigConnection.h.

Public Methods
	ConfigConnection (BufferedFile *fd)
	ConfigConnection Constructor, fd is a BufferedFile to read and write from.
bool	isMessage ()
	Is there a message from the config connection?
void	update ()
	Sends the ConfigConnection a update of current system status.
Message *	getMessage ()
	Gets the next message on the queue.
int	write (const char *data, int size)
	write size bytes of data to the Connection
virtual	~ConfigConnection ()
	Destructor.
virtual bool	readReady ()
	Is the Connection ready to read w/o blocking?
virtual bool	writeReady ()
	Is the Connection ready to write w/o blocking?
int	getFileHandle ()
	retrieves the current file handle
string	getType ()
	returns a string represntation of the type
void	setType (string type)
	sets the type of connection.
Protected Attributes
char *	buffer

---

Constructor & Destructor Documentation

ConfigConnection::ConfigConnection (  BufferedFile *    fd )

ConfigConnection Constructor, fd is a BufferedFile to read and write from. Definition at line 8 of file ConfigConnection.C. References buffer, CBUFFSIZE, and Connection< char >::init().

ConfigConnection::~ConfigConnection (    )  [virtual]

Destructor. Definition at line 22 of file ConfigConnection.C. References buffer.

---

Member Function Documentation

int ConfigConnection::getFileHandle (    )  [virtual]

retrieves the current file handle Reimplemented from Connection< char >. Definition at line 19 of file ConfigConnection.C. References Connection< char >::file, and BufferedFile::getFileHandle().

Message * ConfigConnection::getMessage (    )

Gets the next message on the queue. Definition at line 28 of file ConfigConnection.C. References buffer, CBUFFSIZE, Connection< char >::disconnect(), and Connection< char >::read(). Referenced by Connector::process().

string ConfigConnection::getType (    )  [virtual]

returns a string represntation of the type Reimplemented from Connection< char >. Definition at line 42 of file ConfigConnection.C.

bool ConfigConnection::isMessage (    )

Is there a message from the config connection? Definition at line 25 of file ConfigConnection.C. References readReady().

bool ConfigConnection::readReady (    )  [virtual]

Is the Connection ready to read w/o blocking? Reimplemented from Connection< char >. Definition at line 13 of file ConfigConnection.C. References Connection< char >::file, and BufferedFile::readReady(). Referenced by isMessage().

void ConfigConnection::setType (  string    type )  [virtual]

sets the type of connection. Reimplemented from Connection< char >. Definition at line 48 of file ConfigConnection.C.

void ConfigConnection::update (    )

Sends the ConfigConnection a update of current system status. Depricated: Currently not being used. Definition at line 49 of file ConfigConnection.C.

int ConfigConnection::write (  const char *    data, int    size )  [virtual]

write size bytes of data to the Connection Reimplemented from Connection< char >. Definition at line 45 of file ConfigConnection.C. References Connection< SAMPLE >::write(). Referenced by Connector::lastChange(), Connector::process(), ConnectionWrap::read(), Connector::sendUpdate(), and ConnectionWrap::write().

bool ConfigConnection::writeReady (    )  [virtual]

Is the Connection ready to write w/o blocking? Reimplemented from Connection< char >. Definition at line 16 of file ConfigConnection.C. References Connection< char >::file, and BufferedFile::writeReady().

---

Member Data Documentation

char* ConfigConnection::buffer [protected]

Definition at line 69 of file ConfigConnection.h. Referenced by ConfigConnection(), getMessage(), and ~ConfigConnection().

---

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

• ConfigConnection.h
• ConfigConnection.C

---