flexiport::SerialPort Class Reference

Serial implementation of the Port class. More...

#include <serialport.h>

Inheritance diagram for flexiport::SerialPort:

Public Member Functions
void	Open ()
	Open the port.
void	Close ()
	Close the port.
ssize_t	Read (void *const buffer, size_t count)
	Read from the port.
ssize_t	ReadFull (void *const buffer, size_t count)
	Read the requested quantity of data from the port.
ssize_t	BytesAvailable ()
	Get the number of bytes waiting to be read at the port. Returns immediatly.
ssize_t	BytesAvailableWait ()
	Get the number of bytes waiting after blocking for the timeout. More...
ssize_t	Write (const void *const buffer, size_t count)
	Write data to the port.
void	Flush ()
	Flush the port's input and output buffers, discarding all data.
void	Drain ()
	Drain the port's input and output buffers.
std::string	GetStatus () const
	Get the status of the port (type, device, etc).
void	SetTimeout (Timeout timeout)
	Set the timeout value in milliseconds.
void	SetCanRead (bool canRead)
	Set the read permissions of the port.
void	SetCanWrite (bool canWrite)
	Set the write permissions of the port.
bool	IsOpen () const
	Check if the port is open.
void	SetBaudRate (unsigned int baud)
	Change the baud rate.
unsigned int	GetBaudRate () const
	Get the current baud rate.
Public Member Functions inherited from flexiport::Port
virtual ssize_t	ReadString (std::string &buffer)
	Read a string. More...
virtual ssize_t	ReadUntil (void *const buffer, size_t count, uint8_t terminator)
	Read data until a specified termination byte is received. More...
virtual ssize_t	ReadStringUntil (std::string &buffer, char terminator)
	Read a string until the specified termination character is received. More...
virtual ssize_t	ReadLine (char *const buffer, size_t count)
	Read a new-line terminated string of data. More...
virtual ssize_t	ReadLine (std::string &buffer)
	Read a new-line terminated string of data. More...
virtual ssize_t	Skip (size_t count)
	Dump data until the specified number of bytes have been read. More...
virtual ssize_t	SkipUntil (uint8_t terminator, unsigned int count)
	Read and dump data until the specified termination character has been seen count times. More...
virtual ssize_t	WriteFull (const void *const buffer, size_t count)
	Write all the data to the port. More...
virtual ssize_t	WriteString (const char *const buffer)
	Write a string to the port. More...
std::string	GetPortType () const
	Get the port type.
void	SetDebug (int debug)
	Set the debug level.
int	GetDebug () const
	Get the debug level.
virtual Timeout	GetTimeout () const
	Get the timeout.
virtual bool	IsBlocking () const
	Get the blocking property of the port. If the timeout is non-zero, the port will block.
virtual bool	CanRead () const
	Get the read permissions of the port.
virtual bool	CanWrite () const
	Get the write permissions of the port.

Detailed Description

Serial implementation of the Port class.

See the Port class documentation for how to use the common API.

Note

Under Windows, the timeout resolution is milliseconds, not microseconds. The timeout value will be rounded to the nearest millisecond when used.

Options

• device <string>
  • Serial device to use.
  • Default: /dev/ttyS0
• parity none|even|odd
  • Data parity.
  • Default: none
• baud <integer>
  • Baud rate. Valid values are 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 34800, 57600, 115200, 230400.
  • Default: 9600
• databits <integer>
  • Default: 8
• stopbits 1|2
  • Number of stop bits: 1 or 2.
  • Default: 1
• hwflowctrl
  • Turn hardware flow control on.
  • Default: off

Member Function Documentation

BytesAvailableWait()

ssize_t flexiport::SerialPort::BytesAvailableWait ( void  )

virtual

Get the number of bytes waiting after blocking for the timeout.

Note

Currently this function performs differently under Win32. It will block for the entire length of the timeout if data is not immediatly available. This will be fixed in the future.

Implements flexiport::Port.

---

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

• serialport.h
• serialport.cpp