typedef enum Error Error

typedef enum Flow Flow

typedef enum Parity Parity

typedef enum Pending Pending

enum Error { errSuccess = 0, errOpenNoTty, errOpenFailed, errSpeedInvalid, errFlowInvalid, errParityInvalid, errCharsizeInvalid, errStopbitsInvalid, errOptionInvalid, errResourceFailure, errOutput, errInput, errTimeout, errExtended }

enum Flow { flowNone, flowSoft, flowHard, flowBoth }

enum Parity { parityNone, parityOdd, parityEven }

enum Pending { pendingInput, pendingOutput, pendingError }

virtual ~Serial ()

The serial base class may be 'thrown' as a result on an error, and the 'catcher' may then choose to destory the object. Serial & operator= (const Serial &from)

Serial ports may also be duplecated by the assignment operator. Error setSpeed (unsigned long speed)

Set serial port speed for both input and output. Error setCharBits (int bits)

Set character size. Error setParity (Parity parity)

Set parity mode. Error setStopBits (int bits)

Set number of stop bits. Error setFlowControl (Flow flow)

Set flow control. void toggleDTR (timeout_t millisec)

Set the DTR mode off momentarily. void sendBreak (void)

Send the 'break' signal. Error getErrorNumber (void)

Often used by a 'catch' to fetch the last error of a thrown serial. char * getErrorString (void)

Often used by a 'catch' to fetch the user set error string of a thrown serial. int getBufferSize (void)

Get the 'buffer' size for buffered operations. virtual bool isPending (Pending pend, timeout_t timeout=TIMEOUT_INF)

Get the status of pending operations.

void open (const char *fname)

Opens the serial device. void close (void)

Closes the serial device. virtual int aRead (char *Data, const int Length)

Reads from serial device. virtual int aWrite (const char *Data, const int Length)

Writes to serial device. Error error (Error error, char *errstr=NULL)

This service is used to throw all serial errors which usually occur during the serial constructor. void error (char *err)

This service is used to thow application defined serial errors where the application specific error code is a string. void setError (bool enable)

This method is used to turn the error handler on or off for 'throwing' execptions by manipulating the thrown flag. int setPacketInput (int size, unsigned char btimer=0)

Set packet read mode and 'size' of packet read buffer. int setLineInput (char newline=13, char nl1=0)

Set 'line buffering' read mode and specifies the newline character to be used in seperating line records. void restore (void)

Restore serial device to the original settings at time of open. void flushInput (void)

Used to flush the input waiting queue. void flushOutput (void)

Used to flush any pending output data. void waitOutput (void)

Used to wait until all output has been sent. void endSerial (void)

Used as the default destructor for ending serial I/O services. void initConfig (void)

Used to initialize a newly opened serial file handle. Serial ()

This allows later ttystream class to open and close a serial device. Serial (const char *name)

A serial object may be constructed from a named file on the file system.

HANDLE dev

int bufsize

Enumerator:

errSuccess

errOpenNoTty

errOpenFailed

errSpeedInvalid

errFlowInvalid

errParityInvalid

errCharsizeInvalid

errStopbitsInvalid

errOptionInvalid

errResourceFailure

errOutput

errInput

errTimeout

errExtended

Enumerator:

flowNone

flowSoft

flowHard

flowBoth

Enumerator:

parityNone

parityOdd

parityEven

Enumerator:

pendingInput

pendingOutput

pendingError

This allows later ttystream class to open and close a serial device.

A serial object may be constructed from a named file on the file system.

This named device must be 'isatty()'.

Parameters: name of file.

The serial base class may be 'thrown' as a result on an error, and the 'catcher' may then choose to destory the object.

By assuring the socket base class is a virtual destructor, we can assure the full object is properly terminated.

Reads from serial device.

Parameters: Data Point to character buffer to receive data. Buffers MUST be at least Length + 1 bytes in size.

Length Number of bytes to read.

Writes to serial device.

Parameters: Data Point to character buffer containing data to write. Buffers MUST

Length Number of bytes to write.

Closes the serial device.

Reimplemented in ost::ttystream.

Used as the default destructor for ending serial I/O services.

It will restore the port to it's original state.

This service is used to thow application defined serial errors where the application specific error code is a string.

Parameters: errstr string or message to pass.

This service is used to throw all serial errors which usually occur during the serial constructor.

Parameters: error defined serial error id.

errstr string or message to optionally pass.

Used to flush the input waiting queue.

Used to flush any pending output data.

Get the 'buffer' size for buffered operations.

This can be used when setting packet or line read modes to determine how many bytes to wait for in a given read call.

Returns: number of bytes used for buffering.

Often used by a 'catch' to fetch the last error of a thrown serial.

Returns: error numbr of last Error.

Often used by a 'catch' to fetch the user set error string of a thrown serial.

Returns: string for error message.

Used to initialize a newly opened serial file handle.

You should set serial properties and DTR manually before first use.

Get the status of pending operations.

This can be used to examine if input or output is waiting, or if an error has occured on the serial device.

Returns: true if ready, false if timeout.

Parameters: pend ready check to perform.

timeout in milliseconds.

Opens the serial device.

Parameters: fname Pathname of device to open

Reimplemented in ost::ttystream.

Serial ports may also be duplecated by the assignment operator.

Restore serial device to the original settings at time of open.

Send the 'break' signal.

Set character size.

Returns: 0 on success.

Parameters: bits character size to use (usually 7 or 8).

This method is used to turn the error handler on or off for 'throwing' execptions by manipulating the thrown flag.

Parameters: enable true to enable handler.

Set flow control.

Returns: 0 on success.

Parameters: flow control mode.

Set 'line buffering' read mode and specifies the newline character to be used in seperating line records.

isPending can then be used to wait for an entire line of input.

Parameters: newline newline character.

nl1 EOL2 control character.

Returns: size of conical input buffer.

Set packet read mode and 'size' of packet read buffer.

This sets VMIN to x. VTIM is normally set to '0' so that 'isPending()' can wait for an entire packet rather than just the first byte.

Returns: actual buffer size set.

Parameters: size of packet read request.

btimer optional inter-byte data packet timeout.

Set parity mode.

Returns: 0 on success.

Parameters: parity mode.

Set serial port speed for both input and output.

Returns: 0 on success.

Parameters: speed to select. 0 signifies modem 'hang up'.

Set number of stop bits.

Returns: 0 on success.

Parameters: bits stop bits.

Set the DTR mode off momentarily.

Parameters: millisec number of milliseconds.

Used to wait until all output has been sent.