Retro::RlinkPortFifo Class Reference

FIXME_docs. More...

#include <RlinkPortFifo.hpp>

Inheritance diagram for Retro::RlinkPortFifo:

Collaboration diagram for Retro::RlinkPortFifo:

Public Member Functions
	RlinkPortFifo ()
	Default constructor.
virtual	~RlinkPortFifo ()
	Destructor.
virtual bool	Open (const std::string &url, RerrMsg &emsg)
	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.

Private Member Functions
int	OpenFifo (const std::string &, bool snd, RerrMsg &emsg)
	FIXME_docs.

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
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 inherited from Retro::RlinkPort
void	CloseFd (int &fd)
	FIXME_docs.
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

Detailed Description

FIXME_docs.

Definition at line 23 of file RlinkPortFifo.hpp.

Constructor & Destructor Documentation

RlinkPortFifo()

Retro::RlinkPortFifo::RlinkPortFifo

(

)

Default constructor.

Definition at line 39 of file RlinkPortFifo.cpp.

~RlinkPortFifo()

Retro::RlinkPortFifo::~RlinkPortFifo ( )

virtual

Destructor.

Definition at line 46 of file RlinkPortFifo.cpp.

Member Function Documentation

Open()

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

virtual

FIXME_docs.

Implements Retro::RlinkPort.

Definition at line 55 of file RlinkPortFifo.cpp.

References Retro::RlinkPort::Close(), Retro::RlinkPort::fFdRead, Retro::RlinkPort::fFdWrite, Retro::RparseUrl::FindOpt(), Retro::RlinkPort::fIsOpen, Retro::RlinkPort::fUrl, Retro::RlinkPort::fXon, Retro::RlinkPort::IsOpen(), OpenFifo(), Retro::RparseUrl::Path(), and Retro::RparseUrl::Set().

OpenFifo()

int Retro::RlinkPortFifo::OpenFifo ( const std::string &  name, bool  snd, RerrMsg &  emsg  )

private

FIXME_docs.

Definition at line 83 of file RlinkPortFifo.cpp.

References Retro::RerrMsg::Init(), and Retro::RerrMsg::InitErrno().

Referenced by Open().

---

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

• librlink/RlinkPortFifo.hpp
• librlink/RlinkPortFifo.cpp