Retro::RlinkPortTerm Class Reference

FIXME_docs. More...

#include <RlinkPortTerm.hpp>

Inheritance diagram for Retro::RlinkPortTerm:

Collaboration diagram for Retro::RlinkPortTerm:

Public Member Functions
	RlinkPortTerm ()
	Default constructor.
virtual	~RlinkPortTerm ()
	Destructor.
virtual bool	Open (const std::string &url, RerrMsg &emsg)
	FIXME_docs.
virtual void	Close ()
	FIXME_docs.
virtual void	Dump (std::ostream &os, int ind=0, const char *text=0, int detail=0) const
	FIXME_docs.
Public Member Functions inherited from Retro::RlinkPort
	RlinkPort ()
	Default constructor.
virtual	~RlinkPort ()
	Destructor.
	RlinkPort (const RlinkPort &)=delete
RlinkPort &	operator= (const RlinkPort &)=delete
virtual bool	Open (const std::string &url, RerrMsg &emsg)=0
virtual void	Close ()
	FIXME_docs.
virtual int	Read (uint8_t *buf, size_t size, const Rtime &timeout, RerrMsg &emsg)
	FIXME_docs.
virtual int	Write (const uint8_t *buf, size_t size, RerrMsg &emsg)
	FIXME_docs.
virtual bool	PollRead (const Rtime &timeout)
	FIXME_docs.
int	RawRead (uint8_t *buf, size_t size, bool exactsize, const Rtime &timeout, Rtime &tused, RerrMsg &emsg)
	FIXME_docs.
int	RawWrite (const uint8_t *buf, size_t size, RerrMsg &emsg)
	FIXME_docs.
bool	IsOpen () const
	FIXME_docs.
const RparseUrl &	Url () const
	FIXME_docs.
bool	XonEnable () const
	FIXME_docs.
int	FdRead () const
	FIXME_docs.
int	FdWrite () const
	FIXME_docs.
void	SetLogFile (const std::shared_ptr< RlogFile > &splog)
	FIXME_docs.
void	SetTraceLevel (uint32_t level)
	FIXME_docs.
uint32_t	TraceLevel () const
	FIXME_docs.
Rstats &	Stats ()
	FIXME_docs.
virtual void	Dump (std::ostream &os, int ind=0, const char *text=0, int detail=0) const
	FIXME_docs.

Static Public Attributes
static const uint8_t	kc_xon = 0x11
static const uint8_t	kc_xoff = 0x13
Static Public Attributes inherited from Retro::RlinkPort
static const int	kEof = 0
	return code: end-of-file
static const int	kTout = -1
	return code: time out
static const int	kErr = -2
	return code: IO error

Protected Member Functions
void	DumpTios (std::ostream &os, int ind, const std::string &name, const struct termios &tios) const
	FIXME_docs.
Protected Member Functions inherited from Retro::RlinkPort
void	CloseFd (int &fd)
	FIXME_docs.

Protected Attributes
struct termios	fTiosOld
struct termios	fTiosNew
Protected Attributes inherited from Retro::RlinkPort
bool	fIsOpen
	is open flag
RparseUrl	fUrl
	parsed url
bool	fXon
	xon attribute set
int	fFdRead
	fd for read
int	fFdWrite
	fd for write
std::shared_ptr< RlogFile >	fspLog
	log file ptr
uint32_t	fTraceLevel
	trace level
Rtime	fTsLastRead
	time stamp last write
Rtime	fTsLastWrite
	time stamp last write
Rstats	fStats
	statistics

Additional Inherited Members
Public Types inherited from Retro::RlinkPort
enum	stats {   kStatNPortWrite = 0 , kStatNPortRead , kStatNPortTxByt , kStatNPortRxByt ,   kStatNPortRawWrite , kStatNPortRawRead , kDimStat }
typedef std::unique_ptr< RlinkPort >	port_uptr_t

Detailed Description

FIXME_docs.

Definition at line 29 of file RlinkPortTerm.hpp.

Constructor & Destructor Documentation

RlinkPortTerm()

Retro::RlinkPortTerm::RlinkPortTerm

(

)

Default constructor.

Definition at line 60 of file RlinkPortTerm.cpp.

~RlinkPortTerm()

Retro::RlinkPortTerm::~RlinkPortTerm ( )

virtual

Destructor.

Definition at line 69 of file RlinkPortTerm.cpp.

References Close().

Member Function Documentation

Open()

bool Retro::RlinkPortTerm::Open ( const std::string &  url, RerrMsg &  emsg  )

virtual

FIXME_docs.

Implements Retro::RlinkPort.

Definition at line 77 of file RlinkPortTerm.cpp.

References Close(), Retro::RlinkPort::fFdRead, Retro::RlinkPort::fFdWrite, Retro::RparseUrl::FindOpt(), Retro::RlinkPort::fIsOpen, fTiosNew, fTiosOld, Retro::RlinkPort::fUrl, Retro::RlinkPort::fXon, Retro::RerrMsg::Init(), Retro::RerrMsg::InitErrno(), kc_xoff, kc_xon, Retro::RparseUrl::Path(), Retro::RparseUrl::Set(), Retro::RparseUrl::SetPath(), and Retro::RlinkPort::Write().

Close()

void Retro::RlinkPortTerm::Close ( )

virtual

FIXME_docs.

Reimplemented from Retro::RlinkPort.

Definition at line 297 of file RlinkPortTerm.cpp.

References Retro::RlinkPort::Close(), Retro::RlinkPort::fFdWrite, fTiosOld, and Retro::RlinkPort::IsOpen().

Referenced by Open(), and ~RlinkPortTerm().

Dump()

void Retro::RlinkPortTerm::Dump ( std::ostream &  os, int  ind = 0, const char *  text = 0, int  detail = 0  ) const

virtual

FIXME_docs.

Reimplemented from Retro::RlinkPort.

Definition at line 313 of file RlinkPortTerm.cpp.

References Retro::RlinkPort::Dump(), DumpTios(), fTiosNew, and fTiosOld.

DumpTios()

void Retro::RlinkPortTerm::DumpTios ( std::ostream &  os, int  ind, const std::string &  name, const struct termios &  tios  ) const

protected

FIXME_docs.

Definition at line 327 of file RlinkPortTerm.cpp.

References Retro::RosPrintf().

Referenced by Dump().

Member Data Documentation

kc_xon

const uint8_t Retro::RlinkPortTerm::kc_xon = 0x11

static

Definition at line 42 of file RlinkPortTerm.hpp.

Referenced by Open().

kc_xoff

const uint8_t Retro::RlinkPortTerm::kc_xoff = 0x13

static

Definition at line 43 of file RlinkPortTerm.hpp.

Referenced by Open().

fTiosOld

struct termios Retro::RlinkPortTerm::fTiosOld

protected

Definition at line 50 of file RlinkPortTerm.hpp.

Referenced by Close(), Dump(), and Open().

fTiosNew

struct termios Retro::RlinkPortTerm::fTiosNew

protected

Definition at line 51 of file RlinkPortTerm.hpp.

Referenced by Dump(), and Open().

---

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

• librlink/RlinkPortTerm.hpp
• librlink/RlinkPortTerm.cpp