Win_QextSerialPort Class Reference

#include <win_qextserialport.h>

Inheritance diagram for Win_QextSerialPort:

List of all members.

Public Member Functions
	Win_QextSerialPort ()
	Win_QextSerialPort (Win_QextSerialPort const &s)
	Win_QextSerialPort (const QString &name)
	Win_QextSerialPort (const PortSettings &settings)
	Win_QextSerialPort (const QString &name, const PortSettings &settings)
Win_QextSerialPort &	operator= (const Win_QextSerialPort &s)
virtual	~Win_QextSerialPort ()
virtual bool	open (OpenMode mode=0)
virtual void	close ()
virtual void	flush ()
virtual qint64	size () const
virtual bool	getChar (char *c)
virtual bool	putChar (char c)
virtual void	ungetChar (char c)
virtual void	setFlowControl (FlowType)
virtual void	setParity (ParityType)
virtual void	setDataBits (DataBitsType)
virtual void	setStopBits (StopBitsType)
virtual void	setBaudRate (BaudRateType)
virtual void	setDtr (bool set=true)
virtual void	setRts (bool set=true)
virtual ulong	lineStatus (void)
virtual qint64	bytesAvailable ()
virtual void	translateError (ulong)
virtual void	setTimeout (ulong, ulong)
virtual qint64	readData (char *data, qint64 maxSize)
virtual qint64	writeData (const char *data, qint64 maxSize)
virtual void	construct ()
virtual void	setPortName (const QString &name)
virtual QString	portName () const
virtual BaudRateType	baudRate () const
virtual DataBitsType	dataBits () const
virtual ParityType	parity () const
virtual StopBitsType	stopBits () const
virtual FlowType	flowControl () const
virtual bool	isOpen () const
virtual bool	atEnd () const
virtual qint64	readLine (char *data, qint64 maxSize)
virtual ulong	lastError () const
Protected Attributes
HANDLE	Win_Handle
COMMCONFIG	Win_CommConfig
COMMTIMEOUTS	Win_CommTimeouts
QString	port
bool	portOpen
PortSettings	Settings
ulong	lastErr
Static Protected Attributes
static QMutex *	mutex = NULL
static ulong	refCount = 0

---

Detailed Description

Version:

1.0.0

Author:

Stefan Sander

A cross-platform serial port class. This class encapsulates the Windows portion of QextSerialPort. The user will be notified of errors and possible portability conflicts at run-time by default - this behavior can be turned off by defining _TTY_NOWARN_ (to turn off all warnings) or _TTY_NOWARN_PORT_ (to turn off portability warnings) in the project. Note that defining _TTY_NOWARN_ also defines _TTY_NOWARN_PORT_.

Note:

On Windows NT/2000/XP this class uses Win32 serial port functions by default. The user may select POSIX behavior under NT, 2000, or XP ONLY by defining _TTY_POSIX_ in the project. I can make no guarantees as to the quality of POSIX support under NT/2000 however.

---

Constructor & Destructor Documentation

Win_QextSerialPort::Win_QextSerialPort (   )

Default constructor. Note that the name of the device used by a Win_QextSerialPort constructed with this constructor will be determined by #defined constants, or lack thereof - the default behavior is the same as _TTY_LINUX_. Possible naming conventions and their associated constants are: Constant Used By Naming Convention ---------- ------------- ------------------------ _TTY_WIN_ Windows COM1, COM2 _TTY_IRIX_ SGI/IRIX /dev/ttyf1, /dev/ttyf2 _TTY_HPUX_ HP-UX /dev/tty1p0, /dev/tty2p0 _TTY_SUN_ SunOS/Solaris /dev/ttya, /dev/ttyb _TTY_DIGITAL_ Digital UNIX /dev/tty01, /dev/tty02 _TTY_FREEBSD_ FreeBSD /dev/ttyd0, /dev/ttyd1 _TTY_LINUX_ Linux /dev/ttyS0, /dev/ttyS1 <none> Linux /dev/ttyS0, /dev/ttyS1 This constructor associates the object with the first port on the system, e.g. COM1 for Windows platforms. See the other constructor if you need a port other than the first. :QextSerialBase() { Win_Handle=INVALID_HANDLE_VALUE; }

Win_QextSerialPort::Win_QextSerialPort (  Win_QextSerialPort const &  s  )

Win_QextSerialPort::Win_QextSerialPort(const Win_QextSerialPort&) Copy constructor. :QextSerialBase(s.port) { Win_Handle=INVALID_HANDLE_VALUE; portOpen=s.portOpen; lastErr=s.lastErr; port = s.port; Settings.FlowControl=s.Settings.FlowControl; Settings.Parity=s.Settings.Parity; Settings.DataBits=s.Settings.DataBits; Settings.StopBits=s.Settings.StopBits; Settings.BaudRate=s.Settings.BaudRate; Win_Handle=s.Win_Handle; memcpy(&Win_CommConfig, &s.Win_CommConfig, sizeof(COMMCONFIG)); memcpy(&Win_CommTimeouts, &s.Win_CommTimeouts, sizeof(COMMTIMEOUTS)); }

Win_QextSerialPort::Win_QextSerialPort (  const QString &  name  )

Constructs a serial port attached to the port specified by devName. devName is the name of the device, which is windowsystem-specific, e.g."COM2" or "/dev/ttyS0". :QextSerialBase(name) { Win_Handle=INVALID_HANDLE_VALUE; }

Win_QextSerialPort::Win_QextSerialPort (  const PortSettings &  settings  )

Constructs a port with default name and specified settings. { Win_Handle=INVALID_HANDLE_VALUE; setBaudRate(settings.BaudRate); setDataBits(settings.DataBits); setStopBits(settings.StopBits); setParity(settings.Parity); setFlowControl(settings.FlowControl); setTimeout(settings.Timeout_Sec, settings.Timeout_Millisec); }

Win_QextSerialPort::Win_QextSerialPort (  const QString &  name, const PortSettings &  settings )

Constructs a port with specified name and settings. { Win_Handle=INVALID_HANDLE_VALUE; setPortName(name); setBaudRate(settings.BaudRate); setDataBits(settings.DataBits); setStopBits(settings.StopBits); setParity(settings.Parity); setFlowControl(settings.FlowControl); setTimeout(settings.Timeout_Sec, settings.Timeout_Millisec); }

Win_QextSerialPort::~Win_QextSerialPort (   )  [virtual]

Standard destructor. { if (portOpen) { close(); } }

---

Member Function Documentation

Win_QextSerialPort & Win_QextSerialPort::operator= (  const Win_QextSerialPort &  s  )

overrides the = operator { portOpen=s.isOpen(); lastErr=s.lastErr; port = s.port; Settings.FlowControl=s.Settings.FlowControl; Settings.Parity=s.Settings.Parity; Settings.DataBits=s.Settings.DataBits; Settings.StopBits=s.Settings.StopBits; Settings.BaudRate=s.Settings.BaudRate; Win_Handle=s.Win_Handle; memcpy(&Win_CommConfig, &s.Win_CommConfig, sizeof(COMMCONFIG)); memcpy(&Win_CommTimeouts, &s.Win_CommTimeouts, sizeof(COMMTIMEOUTS)); return *this; }

bool Win_QextSerialPort::open (  OpenMode  mode = 0  )  [virtual]

Opens a serial port. Note that this function does not specify which device to open. If you need to open a device by name, see Win_QextSerialPort::open(const char*). This function has no effect if the port associated with the class is already open. The port is also configured to the current settings, as stored in the Settings structure. Implements QextSerialBase. { unsigned long confSize; LOCK_MUTEX(); if (!portOpen) { /*open the port*/ Win_Handle=CreateFileA(port.toAscii(), GENERIC_READ|GENERIC_WRITE, FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, OPEN_EXISTING, 0, NULL); if (Win_Handle!=INVALID_HANDLE_VALUE) { portOpen=true; /*configure port settings*/ GetCommConfig(Win_Handle, &Win_CommConfig, &confSize); GetCommState(Win_Handle, &(Win_CommConfig.dcb)); /*set up parameters*/ Win_CommConfig.dcb.fBinary=TRUE; Win_CommConfig.dcb.fInX=FALSE; Win_CommConfig.dcb.fOutX=FALSE; Win_CommConfig.dcb.fAbortOnError=FALSE; Win_CommConfig.dcb.fNull=FALSE; setBaudRate(Settings.BaudRate); setDataBits(Settings.DataBits); setStopBits(Settings.StopBits); setParity(Settings.Parity); setFlowControl(Settings.FlowControl); setTimeout(Settings.Timeout_Sec, Settings.Timeout_Millisec); SetCommConfig(Win_Handle, &Win_CommConfig, sizeof(COMMCONFIG)); } } UNLOCK_MUTEX(); return portOpen; }

void Win_QextSerialPort::close (   )  [virtual]

Closes a serial port. This function has no effect if the serial port associated with the class is not currently open. Implements QextSerialBase. { LOCK_MUTEX(); CloseHandle(Win_Handle); portOpen=false; UNLOCK_MUTEX(); }

void Win_QextSerialPort::flush (   )  [virtual]

Flushes all pending I/O to the serial port. This function has no effect if the serial port associated with the class is not currently open. Implements QextSerialBase. { LOCK_MUTEX(); if (portOpen) { FlushFileBuffers(Win_Handle); } UNLOCK_MUTEX(); }

qint64 Win_QextSerialPort::size (   )  const [virtual]

This function will return the number of bytes waiting in the receive queue of the serial port. It is included primarily to provide a complete QIODevice interface, and will not record errors in the lastErr member (because it is const). This function is also not thread-safe - in multithreading situations, use Win_QextSerialPort::bytesAvailable() instead. Implements QextSerialBase. { int availBytes; COMSTAT Win_ComStat; DWORD Win_ErrorMask=0; ClearCommError(Win_Handle, &Win_ErrorMask, &Win_ComStat); availBytes = Win_ComStat.cbInQue; return (qint64)availBytes; }

bool Win_QextSerialPort::getChar (  char *  c  )  [virtual]

Reads one character from the device and stores it in c. Returns true on success; otherwise returns false. This function has no effect if the serial port associated with the class is not currently open. Implements QextSerialBase. { LOCK_MUTEX(); bool retVal=false; if (portOpen) { char readChar=0; COMSTAT Win_ComStat; DWORD Win_BytesRead=0; DWORD Win_ErrorMask=0; ClearCommError(Win_Handle, &Win_ErrorMask, &Win_ComStat); if (Win_ComStat.cbInQue) { if (!ReadFile(Win_Handle, (void*)&readChar, 1, &Win_BytesRead, NULL) || Win_BytesRead==0) { lastErr=E_READ_FAILED; } else { *c = readChar; retVal=true; } } } UNLOCK_MUTEX(); return retVal; }

bool Win_QextSerialPort::putChar (  char  c  )  [virtual]

Writes the character c to the device. Returns true on success; otherwise returns false. This function has no effect if the serial port associated with the class is not currently open. Implements QextSerialBase. { LOCK_MUTEX(); bool retVal=false; if (portOpen) { DWORD Win_BytesWritten; if (!WriteFile(Win_Handle, (void*)&c, 1, &Win_BytesWritten, NULL)) { lastErr=E_WRITE_FAILED; } else { retVal=true; } } UNLOCK_MUTEX(); flush(); return retVal; }

void Win_QextSerialPort::ungetChar (  char  c  )  [virtual]

This function is included to implement the full QIODevice interface, and currently has no purpose within this class. This function is meaningless on an unbuffered device and currently only prints a warning message to that effect. Implements QextSerialBase. { /*meaningless on unbuffered sequential device - return error and print a warning*/ TTY_WARNING("Win_QextSerialPort: ungetChar() called on an unbuffered sequential device - operation is meaningless"); }

void Win_QextSerialPort::setFlowControl (  FlowType  flow  )  [virtual]

Sets the flow control used by the port. Possible values of flow are: FLOW_OFF No flow control FLOW_HARDWARE Hardware (RTS/CTS) flow control FLOW_XONXOFF Software (XON/XOFF) flow control Implements QextSerialBase. { LOCK_MUTEX(); if (Settings.FlowControl!=flow) { Settings.FlowControl=flow; } if (portOpen) { switch(flow) { /*no flow control*/ case FLOW_OFF: Win_CommConfig.dcb.fOutxCtsFlow=FALSE; Win_CommConfig.dcb.fRtsControl=RTS_CONTROL_DISABLE; Win_CommConfig.dcb.fInX=FALSE; Win_CommConfig.dcb.fOutX=FALSE; SetCommConfig(Win_Handle, &Win_CommConfig, sizeof(COMMCONFIG)); break; /*software (XON/XOFF) flow control*/ case FLOW_XONXOFF: Win_CommConfig.dcb.fOutxCtsFlow=FALSE; Win_CommConfig.dcb.fRtsControl=RTS_CONTROL_DISABLE; Win_CommConfig.dcb.fInX=TRUE; Win_CommConfig.dcb.fOutX=TRUE; SetCommConfig(Win_Handle, &Win_CommConfig, sizeof(COMMCONFIG)); break; case FLOW_HARDWARE: Win_CommConfig.dcb.fOutxCtsFlow=TRUE; Win_CommConfig.dcb.fRtsControl=RTS_CONTROL_HANDSHAKE; Win_CommConfig.dcb.fInX=FALSE; Win_CommConfig.dcb.fOutX=FALSE; SetCommConfig(Win_Handle, &Win_CommConfig, sizeof(COMMCONFIG)); break; } } UNLOCK_MUTEX(); }

void Win_QextSerialPort::setParity (  ParityType  parity  )  [virtual]

Sets the parity associated with the serial port. The possible values of parity are: PAR_SPACE Space Parity PAR_MARK Mark Parity PAR_NONE No Parity PAR_EVEN Even Parity PAR_ODD Odd Parity Implements QextSerialBase. { LOCK_MUTEX(); if (Settings.Parity!=parity) { Settings.Parity=parity; } if (portOpen) { Win_CommConfig.dcb.Parity=(unsigned char)parity; switch (parity) { /*space parity*/ case PAR_SPACE: if (Settings.DataBits==DATA_8) { TTY_PORTABILITY_WARNING("Win_QextSerialPort Portability Warning: Space parity with 8 data bits is not supported by POSIX systems."); } Win_CommConfig.dcb.fParity=TRUE; break; /*mark parity - WINDOWS ONLY*/ case PAR_MARK: TTY_PORTABILITY_WARNING("Win_QextSerialPort Portability Warning: Mark parity is not supported by POSIX systems"); Win_CommConfig.dcb.fParity=TRUE; break; /*no parity*/ case PAR_NONE: Win_CommConfig.dcb.fParity=FALSE; break; /*even parity*/ case PAR_EVEN: Win_CommConfig.dcb.fParity=TRUE; break; /*odd parity*/ case PAR_ODD: Win_CommConfig.dcb.fParity=TRUE; break; } SetCommConfig(Win_Handle, &Win_CommConfig, sizeof(COMMCONFIG)); } UNLOCK_MUTEX(); }

void Win_QextSerialPort::setDataBits (  DataBitsType  dataBits  )  [virtual]

Sets the number of data bits used by the serial port. Possible values of dataBits are: DATA_5 5 data bits DATA_6 6 data bits DATA_7 7 data bits DATA_8 8 data bits Note: This function is subject to the following restrictions: 5 data bits cannot be used with 2 stop bits. 1.5 stop bits can only be used with 5 data bits. 8 data bits cannot be used with space parity on POSIX systems. Implements QextSerialBase. { LOCK_MUTEX(); if (Settings.DataBits!=dataBits) { if ((Settings.StopBits==STOP_2 && dataBits==DATA_5) || (Settings.StopBits==STOP_1_5 && dataBits!=DATA_5)) { } else { Settings.DataBits=dataBits; } } if (portOpen) { switch(dataBits) { /*5 data bits*/ case DATA_5: if (Settings.StopBits==STOP_2) { TTY_WARNING("Win_QextSerialPort: 5 Data bits cannot be used with 2 stop bits."); } else { Win_CommConfig.dcb.ByteSize=5; SetCommConfig(Win_Handle, &Win_CommConfig, sizeof(COMMCONFIG)); } break; /*6 data bits*/ case DATA_6: if (Settings.StopBits==STOP_1_5) { TTY_WARNING("Win_QextSerialPort: 6 Data bits cannot be used with 1.5 stop bits."); } else { Win_CommConfig.dcb.ByteSize=6; SetCommConfig(Win_Handle, &Win_CommConfig, sizeof(COMMCONFIG)); } break; /*7 data bits*/ case DATA_7: if (Settings.StopBits==STOP_1_5) { TTY_WARNING("Win_QextSerialPort: 7 Data bits cannot be used with 1.5 stop bits."); } else { Win_CommConfig.dcb.ByteSize=7; SetCommConfig(Win_Handle, &Win_CommConfig, sizeof(COMMCONFIG)); } break; /*8 data bits*/ case DATA_8: if (Settings.StopBits==STOP_1_5) { TTY_WARNING("Win_QextSerialPort: 8 Data bits cannot be used with 1.5 stop bits."); } else { Win_CommConfig.dcb.ByteSize=8; SetCommConfig(Win_Handle, &Win_CommConfig, sizeof(COMMCONFIG)); } break; } } UNLOCK_MUTEX(); }

void Win_QextSerialPort::setStopBits (  StopBitsType  stopBits  )  [virtual]

Sets the number of stop bits used by the serial port. Possible values of stopBits are: STOP_1 1 stop bit STOP_1_5 1.5 stop bits STOP_2 2 stop bits Note: This function is subject to the following restrictions: 2 stop bits cannot be used with 5 data bits. 1.5 stop bits cannot be used with 6 or more data bits. POSIX does not support 1.5 stop bits. Implements QextSerialBase. { LOCK_MUTEX(); if (Settings.StopBits!=stopBits) { if ((Settings.DataBits==DATA_5 && stopBits==STOP_2) || (stopBits==STOP_1_5 && Settings.DataBits!=DATA_5)) { } else { Settings.StopBits=stopBits; } } if (portOpen) { switch (stopBits) { /*one stop bit*/ case STOP_1: Win_CommConfig.dcb.StopBits=ONESTOPBIT; SetCommConfig(Win_Handle, &Win_CommConfig, sizeof(COMMCONFIG)); break; /*1.5 stop bits*/ case STOP_1_5: TTY_PORTABILITY_WARNING("Win_QextSerialPort Portability Warning: 1.5 stop bit operation is not supported by POSIX."); if (Settings.DataBits!=DATA_5) { TTY_WARNING("Win_QextSerialPort: 1.5 stop bits can only be used with 5 data bits"); } else { Win_CommConfig.dcb.StopBits=ONE5STOPBITS; SetCommConfig(Win_Handle, &Win_CommConfig, sizeof(COMMCONFIG)); } break; /*two stop bits*/ case STOP_2: if (Settings.DataBits==DATA_5) { TTY_WARNING("Win_QextSerialPort: 2 stop bits cannot be used with 5 data bits"); } else { Win_CommConfig.dcb.StopBits=TWOSTOPBITS; SetCommConfig(Win_Handle, &Win_CommConfig, sizeof(COMMCONFIG)); } break; } } UNLOCK_MUTEX(); }

void Win_QextSerialPort::setBaudRate (  BaudRateType  baudRate  )  [virtual]

Sets the baud rate of the serial port. Note that not all rates are applicable on all platforms. The following table shows translations of the various baud rate constants on Windows(including NT/2000) and POSIX platforms. Speeds marked with an * are speeds that are usable on both Windows and POSIX. RATE Windows Speed POSIX Speed ----------- ------------- ----------- BAUD50 110 50 BAUD75 110 75 *BAUD110 110 110 BAUD134 110 134.5 BAUD150 110 150 BAUD200 110 200 *BAUD300 300 300 *BAUD600 600 600 *BAUD1200 1200 1200 BAUD1800 1200 1800 *BAUD2400 2400 2400 *BAUD4800 4800 4800 *BAUD9600 9600 9600 BAUD14400 14400 9600 *BAUD19200 19200 19200 *BAUD38400 38400 38400 BAUD56000 56000 38400 *BAUD57600 57600 57600 BAUD76800 57600 76800 *BAUD115200 115200 115200 BAUD128000 128000 115200 BAUD256000 256000 115200 Implements QextSerialBase. { LOCK_MUTEX(); if (Settings.BaudRate!=baudRate) { switch (baudRate) { case BAUD50: case BAUD75: case BAUD134: case BAUD150: case BAUD200: Settings.BaudRate=BAUD110; break; case BAUD1800: Settings.BaudRate=BAUD1200; break; case BAUD76800: Settings.BaudRate=BAUD57600; break; default: Settings.BaudRate=baudRate; break; } } if (portOpen) { switch (baudRate) { /*50 baud*/ case BAUD50: TTY_WARNING("Win_QextSerialPort: Windows does not support 50 baud operation. Switching to 110 baud."); Win_CommConfig.dcb.BaudRate=CBR_110; break; /*75 baud*/ case BAUD75: TTY_WARNING("Win_QextSerialPort: Windows does not support 75 baud operation. Switching to 110 baud."); Win_CommConfig.dcb.BaudRate=CBR_110; break; /*110 baud*/ case BAUD110: Win_CommConfig.dcb.BaudRate=CBR_110; break; /*134.5 baud*/ case BAUD134: TTY_WARNING("Win_QextSerialPort: Windows does not support 134.5 baud operation. Switching to 110 baud."); Win_CommConfig.dcb.BaudRate=CBR_110; break; /*150 baud*/ case BAUD150: TTY_WARNING("Win_QextSerialPort: Windows does not support 150 baud operation. Switching to 110 baud."); Win_CommConfig.dcb.BaudRate=CBR_110; break; /*200 baud*/ case BAUD200: TTY_WARNING("Win_QextSerialPort: Windows does not support 200 baud operation. Switching to 110 baud."); Win_CommConfig.dcb.BaudRate=CBR_110; break; /*300 baud*/ case BAUD300: Win_CommConfig.dcb.BaudRate=CBR_300; break; /*600 baud*/ case BAUD600: Win_CommConfig.dcb.BaudRate=CBR_600; break; /*1200 baud*/ case BAUD1200: Win_CommConfig.dcb.BaudRate=CBR_1200; break; /*1800 baud*/ case BAUD1800: TTY_WARNING("Win_QextSerialPort: Windows does not support 1800 baud operation. Switching to 1200 baud."); Win_CommConfig.dcb.BaudRate=CBR_1200; break; /*2400 baud*/ case BAUD2400: Win_CommConfig.dcb.BaudRate=CBR_2400; break; /*4800 baud*/ case BAUD4800: Win_CommConfig.dcb.BaudRate=CBR_4800; break; /*9600 baud*/ case BAUD9600: Win_CommConfig.dcb.BaudRate=CBR_9600; break; /*14400 baud*/ case BAUD14400: TTY_PORTABILITY_WARNING("Win_QextSerialPort Portability Warning: POSIX does not support 14400 baud operation."); Win_CommConfig.dcb.BaudRate=CBR_14400; break; /*19200 baud*/ case BAUD19200: Win_CommConfig.dcb.BaudRate=CBR_19200; break; /*38400 baud*/ case BAUD38400: Win_CommConfig.dcb.BaudRate=CBR_38400; break; /*56000 baud*/ case BAUD56000: TTY_PORTABILITY_WARNING("Win_QextSerialPort Portability Warning: POSIX does not support 56000 baud operation."); Win_CommConfig.dcb.BaudRate=CBR_56000; break; /*57600 baud*/ case BAUD57600: Win_CommConfig.dcb.BaudRate=CBR_57600; break; /*76800 baud*/ case BAUD76800: TTY_WARNING("Win_QextSerialPort: Windows does not support 76800 baud operation. Switching to 57600 baud."); Win_CommConfig.dcb.BaudRate=CBR_57600; break; /*115200 baud*/ case BAUD115200: Win_CommConfig.dcb.BaudRate=CBR_115200; break; /*128000 baud*/ case BAUD128000: TTY_PORTABILITY_WARNING("Win_QextSerialPort Portability Warning: POSIX does not support 128000 baud operation."); Win_CommConfig.dcb.BaudRate=CBR_128000; break; /*256000 baud*/ case BAUD256000: TTY_PORTABILITY_WARNING("Win_QextSerialPort Portability Warning: POSIX does not support 256000 baud operation."); Win_CommConfig.dcb.BaudRate=CBR_256000; break; } SetCommConfig(Win_Handle, &Win_CommConfig, sizeof(COMMCONFIG)); } UNLOCK_MUTEX(); }

void Win_QextSerialPort::setDtr (  bool  set = true  )  [virtual]

Sets DTR line to the requested state (high by default). This function will have no effect if the port associated with the class is not currently open. Implements QextSerialBase. { LOCK_MUTEX(); if (portOpen) { if (set) { EscapeCommFunction(Win_Handle, SETDTR); } else { EscapeCommFunction(Win_Handle, CLRDTR); } } UNLOCK_MUTEX(); }

void Win_QextSerialPort::setRts (  bool  set = true  )  [virtual]

Sets RTS line to the requested state (high by default). This function will have no effect if the port associated with the class is not currently open. Implements QextSerialBase. { LOCK_MUTEX(); if (portOpen) { if (set) { EscapeCommFunction(Win_Handle, SETRTS); } else { EscapeCommFunction(Win_Handle, CLRRTS); } } UNLOCK_MUTEX(); }

ulong Win_QextSerialPort::lineStatus (  void   )  [virtual]

returns the line status as stored by the port function. This function will retrieve the states of the following lines: DCD, CTS, DSR, and RI. On POSIX systems, the following additional lines can be monitored: DTR, RTS, Secondary TXD, and Secondary RXD. The value returned is an unsigned long with specific bits indicating which lines are high. The following constants should be used to examine the states of individual lines: Mask Line ------ ---- LS_CTS CTS LS_DSR DSR LS_DCD DCD LS_RI RI This function will return 0 if the port associated with the class is not currently open. Implements QextSerialBase. { unsigned long Status=0, Temp=0; LOCK_MUTEX(); if (portOpen) { GetCommModemStatus(Win_Handle, &Temp); if (Temp&MS_CTS_ON) { Status|=LS_CTS; } if (Temp&MS_DSR_ON) { Status|=LS_DSR; } if (Temp&MS_RING_ON) { Status|=LS_RI; } if (Temp&MS_RLSD_ON) { Status|=LS_DCD; } } UNLOCK_MUTEX(); return Status; }

qint64 Win_QextSerialPort::bytesAvailable (   )  [virtual]

Returns the number of bytes waiting in the port's receive queue. This function will return 0 if the port is not currently open, or -1 on error. Error information can be retrieved by calling Win_QextSerialPort::getLastError(). Implements QextSerialBase. { LOCK_MUTEX(); if (portOpen) { DWORD Errors; COMSTAT Status; bool success=ClearCommError(Win_Handle, &Errors, &Status); translateError(Errors); if (success) { lastErr=E_NO_ERROR; UNLOCK_MUTEX(); return Status.cbInQue; } UNLOCK_MUTEX(); return (unsigned int)-1; } UNLOCK_MUTEX(); return 0; }

void Win_QextSerialPort::translateError (  ulong  error  )  [virtual]

Translates a system-specific error code to a QextSerialPort error code. Used internally. Implements QextSerialBase. { if (error&CE_BREAK) { lastErr=E_BREAK_CONDITION; } else if (error&CE_FRAME) { lastErr=E_FRAMING_ERROR; } else if (error&CE_IOE) { lastErr=E_IO_ERROR; } else if (error&CE_MODE) { lastErr=E_INVALID_FD; } else if (error&CE_OVERRUN) { lastErr=E_BUFFER_OVERRUN; } else if (error&CE_RXPARITY) { lastErr=E_RECEIVE_PARITY_ERROR; } else if (error&CE_RXOVER) { lastErr=E_RECEIVE_OVERFLOW; } else if (error&CE_TXFULL) { lastErr=E_TRANSMIT_OVERFLOW; } }

void Win_QextSerialPort::setTimeout (  ulong  sec, ulong  millisec )  [virtual]

Sets the read and write timeouts for the port to sec seconds and millisec milliseconds. Implements QextSerialBase. { LOCK_MUTEX(); Settings.Timeout_Sec=sec; Settings.Timeout_Millisec=millisec; if(portOpen) { Win_CommTimeouts.ReadIntervalTimeout = sec*1000+millisec; Win_CommTimeouts.ReadTotalTimeoutMultiplier = sec*1000+millisec; Win_CommTimeouts.ReadTotalTimeoutConstant = 0; Win_CommTimeouts.WriteTotalTimeoutMultiplier = sec*1000+millisec; Win_CommTimeouts.WriteTotalTimeoutConstant = 0; SetCommTimeouts(Win_Handle, &Win_CommTimeouts); } UNLOCK_MUTEX(); }

qint64 Win_QextSerialPort::readData (  char *  data, qint64  maxSize )  [virtual]

Reads a block of data from the serial port. This function will read at most maxlen bytes from the serial port and place them in the buffer pointed to by data. Return value is the number of bytes actually read, or -1 on error. This function will have no effect if the serial port associated with the class is not currently open. Implements QextSerialBase. { LOCK_MUTEX(); int retVal=0; if (portOpen) { COMSTAT Win_ComStat; DWORD Win_BytesRead=0; DWORD Win_ErrorMask=0; ClearCommError(Win_Handle, &Win_ErrorMask, &Win_ComStat); if (Win_ComStat.cbInQue && (!ReadFile(Win_Handle, (void*)data, (DWORD)maxSize, &Win_BytesRead, NULL) || Win_BytesRead==0)) { lastErr=E_READ_FAILED; retVal=-1; } else { retVal=((int)Win_BytesRead); } } UNLOCK_MUTEX(); return retVal; }

qint64 Win_QextSerialPort::writeData (  const char *  data, qint64  maxSize )  [virtual]

Writes a block of data to the serial port. This function will write len bytes from the buffer pointed to by data to the serial port. Return value is the number of bytes actually written, or -1 on error. This function will have no effect if the serial port associated with the class is not currently open. Implements QextSerialBase. { LOCK_MUTEX(); int retVal=0; if (portOpen) { DWORD Win_BytesWritten; if (!WriteFile(Win_Handle, (void*)data, (DWORD)maxSize, &Win_BytesWritten, NULL)) { lastErr=E_WRITE_FAILED; retVal=-1; } else { retVal=((int)Win_BytesWritten); } } UNLOCK_MUTEX(); flush(); return retVal; }

void QextSerialBase::construct (   )  [virtual, inherited]

Common constructor function for setting up default port settings. (115200 Baud, 8N1, Hardware flow control where supported, otherwise no flow control, and 500 ms timeout). { Settings.BaudRate=BAUD115200; Settings.DataBits=DATA_8; Settings.Parity=PAR_NONE; Settings.StopBits=STOP_1; Settings.FlowControl=FLOW_HARDWARE; Settings.Timeout_Sec=0; Settings.Timeout_Millisec=500; #ifdef QT_THREAD_SUPPORT if (!mutex) { mutex=new QMutex( QMutex::Recursive ); } refCount++; #endif portOpen=false; }

void QextSerialBase::setPortName (  const QString &  name  )  [virtual, inherited]

Sets the name of the device associated with the object, e.g. "COM1", or "/dev/ttyS0". { port = name; }

QString QextSerialBase::portName (   )  const [virtual, inherited]

Returns the name set by setPortName(). { return port; }

BaudRateType QextSerialBase::baudRate (  void   )  const [virtual, inherited]

Returns the baud rate of the serial port. For a list of possible return values see the definition of the enum BaudRateType. { return Settings.BaudRate; }

DataBitsType QextSerialBase::dataBits (   )  const [virtual, inherited]

Returns the number of data bits used by the port. For a list of possible values returned by this function, see the definition of the enum DataBitsType. { return Settings.DataBits; }

ParityType QextSerialBase::parity (   )  const [virtual, inherited]

Returns the type of parity used by the port. For a list of possible values returned by this function, see the definition of the enum ParityType. { return Settings.Parity; }

StopBitsType QextSerialBase::stopBits (   )  const [virtual, inherited]

Returns the number of stop bits used by the port. For a list of possible return values, see the definition of the enum StopBitsType. { return Settings.StopBits; }

FlowType QextSerialBase::flowControl (   )  const [virtual, inherited]

Returns the type of flow control used by the port. For a list of possible values returned by this function, see the definition of the enum FlowType. { return Settings.FlowControl; }

bool QextSerialBase::isOpen (   )  const [virtual, inherited]

Returns true if the port associated with the class is currently open, or false if it is not. { return portOpen; }

bool QextSerialBase::atEnd (   )  const [virtual, inherited]

This function will return true if the input buffer is empty (or on error), and false otherwise. Call QextSerialBase::lastError() for error information. { if (size()) { return true; } return false; }

qint64 QextSerialBase::readLine (  char *  data, qint64  maxSize )  [virtual, inherited]

This function will read a line of buffered input from the port, stopping when either maxSize bytes have been read, the port has no more data available, or a newline is encountered. The value returned is the length of the string that was read. { qint64 numBytes = bytesAvailable(); char* pData = data; /*if nothing waiting, return 0 length*/ if (numBytes<1) { return 0; } /*read a byte at a time for MIN(bytesAvail, maxSize) iterations, or until a newline*/ while (pData<(data+numBytes) && --maxSize) { readData(pData, 1); if (*pData++ == '\n') { break; } } *pData++='\0'; /*return size of data read*/ return (pData-data); }

ulong QextSerialBase::lastError (   )  const [virtual, inherited]

Returns the code for the last error encountered by the port, or E_NO_ERROR if the last port operation was successful. Possible error codes are: Error Explanation --------------------------- ------------------------------------------------------------- E_NO_ERROR No Error has occured E_INVALID_FD Invalid file descriptor (port was not opened correctly) E_NO_MEMORY Unable to allocate memory tables (POSIX) E_CAUGHT_NON_BLOCKED_SIGNAL Caught a non-blocked signal (POSIX) E_PORT_TIMEOUT Operation timed out (POSIX) E_INVALID_DEVICE The file opened by the port is not a character device (POSIX) E_BREAK_CONDITION The port detected a break condition E_FRAMING_ERROR The port detected a framing error (usually caused by incorrect baud rate settings) E_IO_ERROR There was an I/O error while communicating with the port E_BUFFER_OVERRUN Character buffer overrun E_RECEIVE_OVERFLOW Receive buffer overflow E_RECEIVE_PARITY_ERROR The port detected a parity error in the received data E_TRANSMIT_OVERFLOW Transmit buffer overflow E_READ_FAILED General read operation failure E_WRITE_FAILED General write operation failure { return lastErr; }

---

Member Data Documentation

HANDLE Win_QextSerialPort::Win_Handle [protected]

COMMCONFIG Win_QextSerialPort::Win_CommConfig [protected]

COMMTIMEOUTS Win_QextSerialPort::Win_CommTimeouts [protected]

QString QextSerialBase::port [protected, inherited]

bool QextSerialBase::portOpen [protected, inherited]

PortSettings QextSerialBase::Settings [protected, inherited]

ulong QextSerialBase::lastErr [protected, inherited]

QMutex * QextSerialBase::mutex = NULL [static, protected, inherited]

unsigned long QextSerialBase::refCount = 0 [static, protected, inherited]

---

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

• win_qextserialport.h
• win_qextserialport.cpp

---