WindowsSerialPort Class Reference
[Comms - Serial Port interface]

Inheritance diagram for WindowsSerialPort:

List of all members.

---

Detailed Description

Serial port object for Windows.

Definition at line 51 of file serial_port.cpp.

Public Member Functions
	WindowsSerialPort ()
int	Open (unsigned port)
int	Initialise (unsigned baud)
int	Out (const uint8_t *data, size_t size, unsigned timeout)
int	In (uint8_t *data, size_t maxSize, unsigned timeout)
void	Close ()
Private Member Functions
	~WindowsSerialPort ()
int	Error (int defaultError=ErrorUnspecified)
Private Attributes
HANDLE	hSerial

---

Member Function Documentation

int WindowsSerialPort::Open (  unsigned  port  )  [virtual]

Open port for communications over a specified port number. Parameters: port  Port number. Returns: Zero if successful, or a negative error value if failed. Implements SerialPort. Definition at line 105 of file serial_port.cpp.

int WindowsSerialPort::Initialise (  unsigned  baud  )  [virtual]

Initialise port. Parameters: baud  Baud rate for port. Returns: Zero if successful, or a negative error value if failed. Precondition: Open() must have been called. Implements SerialPort. Definition at line 150 of file serial_port.cpp.

int WindowsSerialPort::Out (  const uint8_t *  data, size_t  size, unsigned  timeout )  [virtual]

Transmit data. This function does not wait if only some of data could be transmitted, instead it returns immediately. Parameters: data  Pointer to data to be transmitted. size  Size of data. timeout  Time in milliseconds to wait if output is not ready. Returns: Number of bytes transmitted or negative error value if failed. Precondition: Initialise() must have been called. Implements SerialPort. Definition at line 191 of file serial_port.cpp.

int WindowsSerialPort::In (  uint8_t *  data, size_t  maxSize, unsigned  timeout )  [virtual]

Receive data. Parameters: [out]  data  Pointer to buffer to hold received data. maxSize  Size of data. timeout  Time in milliseconds to wait if no data available. Returns: Number of bytes received or negative error value if failed. Precondition: Initialise() must have been called. Implements SerialPort. Definition at line 234 of file serial_port.cpp.

void WindowsSerialPort::Close (   )  [virtual]

Close port. Port must not be used again until Open() has been called. Implements SerialPort. Definition at line 277 of file serial_port.cpp.

int WindowsSerialPort::Error (  int  defaultError = ErrorUnspecified  )  [private]

Process a Windows error. Parameters: defaultError  The default error value to return. Returns: An error value from Errors Definition at line 78 of file serial_port.cpp.

---

Member Data Documentation

HANDLE WindowsSerialPort::hSerial [private]

File handle for serial port. Definition at line 64 of file serial_port.cpp.

---

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

• comms/windows/serial_port.cpp

---