rp::hal::serial_rxtx Class Reference

#include <abs_rxtx.h>

Inheritance diagram for rp::hal::serial_rxtx:

List of all members.

Public Types
enum	{ ANS_OK = 0, ANS_TIMEOUT = -1, ANS_DEV_ERR = -2 }
Public Member Functions
virtual bool	bind (const char *portname, _u32 baudrate, _u32 flags=0)=0
virtual void	cancelOperation ()
virtual void	clearDTR ()=0
virtual void	close ()=0
virtual void	flush (_u32 flags)=0
virtual bool	isOpened ()
virtual bool	open ()=0
virtual int	recvdata (unsigned char *data, size_t size)=0
virtual size_t	rxqueue_count ()=0
virtual int	senddata (const unsigned char *data, size_t size)=0
	serial_rxtx ()
virtual void	setDTR ()=0
virtual int	waitfordata (size_t data_count, _u32 timeout=-1, size_t *returned_size=NULL)=0
virtual int	waitforrecv (_u32 timeout=-1, size_t *returned_size=NULL)=0
virtual int	waitforsent (_u32 timeout=-1, size_t *returned_size=NULL)=0
virtual	~serial_rxtx ()
Static Public Member Functions
static serial_rxtx *	CreateRxTx ()
static void	ReleaseRxTx (serial_rxtx *)
Protected Attributes
volatile bool	_is_serial_opened

---

Detailed Description

Definition at line 41 of file abs_rxtx.h.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

ANS_OK
ANS_TIMEOUT
ANS_DEV_ERR

Definition at line 44 of file abs_rxtx.h.

---

Constructor & Destructor Documentation

rp::hal::serial_rxtx::serial_rxtx

(

)

[inline]

Definition at line 53 of file abs_rxtx.h.

virtual rp::hal::serial_rxtx::~serial_rxtx

(

)

[inline, virtual]

Definition at line 54 of file abs_rxtx.h.

---

Member Function Documentation

virtual bool rp::hal::serial_rxtx::bind	(	const char *	portname,
		_u32	baudrate,
		_u32	flags = 0
	)		[pure virtual]

Implemented in rp::arch::net::raw_serial, rp::arch::net::raw_serial, and rp::arch::net::raw_serial.

virtual void rp::hal::serial_rxtx::cancelOperation

(

)

[inline, virtual]

Reimplemented in rp::arch::net::raw_serial.

Definition at line 74 of file abs_rxtx.h.

virtual void rp::hal::serial_rxtx::clearDTR

(

)

[pure virtual]

Implemented in rp::arch::net::raw_serial, rp::arch::net::raw_serial, and rp::arch::net::raw_serial.

virtual void rp::hal::serial_rxtx::close

(

)

[pure virtual]

Implemented in rp::arch::net::raw_serial, rp::arch::net::raw_serial, and rp::arch::net::raw_serial.

serial_rxtx * rp::hal::serial_rxtx::CreateRxTx

(

)

[static]

Definition at line 466 of file linux/net_serial.cpp.

virtual void rp::hal::serial_rxtx::flush

(

_u32

flags

)

[pure virtual]

Implemented in rp::arch::net::raw_serial, rp::arch::net::raw_serial, and rp::arch::net::raw_serial.

virtual bool rp::hal::serial_rxtx::isOpened

(

)

[inline, virtual]

Definition at line 76 of file abs_rxtx.h.

virtual bool rp::hal::serial_rxtx::open

(

)

[pure virtual]

Implemented in rp::arch::net::raw_serial, rp::arch::net::raw_serial, and rp::arch::net::raw_serial.

virtual int rp::hal::serial_rxtx::recvdata	(	unsigned char *	data,
		size_t	size
	)		[pure virtual]

Implemented in rp::arch::net::raw_serial, and rp::arch::net::raw_serial.

void rp::hal::serial_rxtx::ReleaseRxTx

(

serial_rxtx *

rxtx

)

[static]

Definition at line 471 of file linux/net_serial.cpp.

virtual size_t rp::hal::serial_rxtx::rxqueue_count

(

)

[pure virtual]

Implemented in rp::arch::net::raw_serial, rp::arch::net::raw_serial, and rp::arch::net::raw_serial.

virtual int rp::hal::serial_rxtx::senddata	(	const unsigned char *	data,
		size_t	size
	)		[pure virtual]

Implemented in rp::arch::net::raw_serial, and rp::arch::net::raw_serial.

virtual void rp::hal::serial_rxtx::setDTR

(

)

[pure virtual]

Implemented in rp::arch::net::raw_serial, rp::arch::net::raw_serial, and rp::arch::net::raw_serial.

virtual int rp::hal::serial_rxtx::waitfordata	(	size_t	data_count,
		_u32	timeout = -1,
		size_t *	returned_size = NULL
	)		[pure virtual]

Implemented in rp::arch::net::raw_serial, and rp::arch::net::raw_serial.

virtual int rp::hal::serial_rxtx::waitforrecv	(	_u32	timeout = -1,
		size_t *	returned_size = NULL
	)		[pure virtual]

Implemented in rp::arch::net::raw_serial, and rp::arch::net::raw_serial.

virtual int rp::hal::serial_rxtx::waitforsent	(	_u32	timeout = -1,
		size_t *	returned_size = NULL
	)		[pure virtual]

Implemented in rp::arch::net::raw_serial, and rp::arch::net::raw_serial.

---

Member Data Documentation

volatile bool rp::hal::serial_rxtx::_is_serial_opened [protected]

Definition at line 82 of file abs_rxtx.h.

---

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

• abs_rxtx.h
• linux/net_serial.cpp
• macOS/net_serial.cpp
• win32/net_serial.cpp