w11 - cpp 0.794
Backend server for Rlink and w11
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
Retro::Rw11VirtTerm Class Referenceabstract

FIXME_docs. More...

#include <Rw11VirtTerm.hpp>

Inheritance diagram for Retro::Rw11VirtTerm:
[legend]
Collaboration diagram for Retro::Rw11VirtTerm:
[legend]

Public Types

enum  stats {
  kStatNVTRcvPoll = Rw11Virt::kDimStat , kStatNVTSnd , kStatNVTRcvByt , kStatNVTSndByt ,
  kDimStat
}
 
typedef std::function< bool(const uint8_t *, size_t)> rcvcbfo_t
 
- Public Types inherited from Retro::Rw11Virt
enum  stats { kDimStat = 0 }
 

Public Member Functions

 Rw11VirtTerm (Rw11Unit *punit)
 Default constructor.
 
 ~Rw11VirtTerm ()
 Destructor.
 
virtual const std::string & ChannelId () const
 FIXME_docs.
 
void SetupRcvCallback (rcvcbfo_t &&rcvcbfo)
 FIXME_docs.
 
virtual bool Snd (const uint8_t *data, size_t count, RerrMsg &emsg)=0
 
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::Rw11Virt
 Rw11Virt (Rw11Unit *punit)
 Default constructor.
 
virtual ~Rw11Virt ()
 Destructor.
 
 Rw11Virt (const Rw11Virt &)=delete
 
Rw11Virt & operator= (const Rw11Virt &)=delete
 
Rw11Unit & Unit () const
 FIXME_docs.
 
Rw11Cntl & Cntl () const
 FIXME_docs.
 
Rw11Cpu & Cpu () const
 FIXME_docs.
 
Rw11 & W11 () const
 FIXME_docs.
 
RlinkServer & Server () const
 FIXME_docs.
 
RlogFile & LogFile () const
 FIXME_docs.
 
virtual bool WProt () const
 FIXME_docs.
 
const RparseUrl & Url () const
 FIXME_docs.
 
virtual bool Open (const std::string &url, RerrMsg &emsg)=0
 
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 Member Functions

static std::unique_ptr< Rw11VirtTerm > New (const std::string &url, Rw11Unit *punit, RerrMsg &emsg)
 FIXME_docs.
 

Protected Attributes

std::string fChannelId
 channel id
 
rcvcbfo_t fRcvCb
 receive callback fobj
 
- Protected Attributes inherited from Retro::Rw11Virt
Rw11Unit * fpUnit
 back ref to unit
 
RparseUrl fUrl
 
bool fWProt
 write protected
 
Rstats fStats
 statistics
 

Detailed Description

FIXME_docs.

Definition at line 29 of file Rw11VirtTerm.hpp.

Member Typedef Documentation

◆ rcvcbfo_t

typedef std::function<bool(const uint8_t*, size_t)> Retro::Rw11VirtTerm::rcvcbfo_t

Definition at line 31 of file Rw11VirtTerm.hpp.

Member Enumeration Documentation

◆ stats

enum Retro::Rw11VirtTerm::stats
Enumerator
kStatNVTRcvPoll 
kStatNVTSnd 
kStatNVTRcvByt 
kStatNVTSndByt 
kDimStat 

Definition at line 48 of file Rw11VirtTerm.hpp.

Constructor & Destructor Documentation

◆ Rw11VirtTerm()

Retro::Rw11VirtTerm::Rw11VirtTerm ( Rw11Unit *  punit)
explicit

Default constructor.

Definition at line 38 of file Rw11VirtTerm.cpp.

References Retro::Rstats::Define(), Retro::Rw11Virt::fStats, kStatNVTRcvByt, kStatNVTRcvPoll, kStatNVTSnd, and kStatNVTSndByt.

◆ ~Rw11VirtTerm()

Retro::Rw11VirtTerm::~Rw11VirtTerm ( )

Destructor.

Definition at line 52 of file Rw11VirtTerm.cpp.

Member Function Documentation

◆ ChannelId()

const std::string & Retro::Rw11VirtTerm::ChannelId ( ) const
inlinevirtual

FIXME_docs.

Definition at line 22 of file Rw11VirtTerm.ipp.

References fChannelId.

Referenced by Retro::Rw11UnitTerm::ChannelId().

◆ SetupRcvCallback()

void Retro::Rw11VirtTerm::SetupRcvCallback ( rcvcbfo_t &&  rcvcbfo)
inline

FIXME_docs.

Definition at line 31 of file Rw11VirtTerm.ipp.

References fRcvCb.

Referenced by Retro::Rw11UnitTerm::AttachDone().

◆ Snd()

virtual bool Retro::Rw11VirtTerm::Snd ( const uint8_t *  data,
size_t  count,
RerrMsg &  emsg 
)
pure virtual

Implemented in Retro::Rw11VirtTermPty, and Retro::Rw11VirtTermTcp.

Referenced by Retro::Rw11UnitTerm::Snd().

◆ Dump()

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

FIXME_docs.

Reimplemented from Retro::Rw11Virt.

Reimplemented in Retro::Rw11VirtTermPty, and Retro::Rw11VirtTermTcp.

Definition at line 84 of file Rw11VirtTerm.cpp.

References Retro::Rw11Virt::Dump(), and fChannelId.

Referenced by Retro::Rw11VirtTermPty::Dump(), and Retro::Rw11VirtTermTcp::Dump().

◆ New()

std::unique_ptr< Rw11VirtTerm > Retro::Rw11VirtTerm::New ( const std::string &  url,
Rw11Unit *  punit,
RerrMsg &  emsg 
)
static

FIXME_docs.

Definition at line 58 of file Rw11VirtTerm.cpp.

References Retro::RparseUrl::FindScheme(), and Retro::RerrMsg::Init().

Member Data Documentation

◆ fChannelId

std::string Retro::Rw11VirtTerm::fChannelId
protected

channel id

Definition at line 57 of file Rw11VirtTerm.hpp.

Referenced by ChannelId(), Dump(), Retro::Rw11VirtTermTcp::ListenPollHandler(), Retro::Rw11VirtTermPty::Open(), Retro::Rw11VirtTermTcp::Open(), Retro::Rw11VirtTermTcp::RcvPollHandler(), and Retro::Rw11VirtTermTcp::Snd().

◆ fRcvCb

rcvcbfo_t Retro::Rw11VirtTerm::fRcvCb
protected

receive callback fobj

Definition at line 58 of file Rw11VirtTerm.hpp.

Referenced by Retro::Rw11VirtTermPty::RcvPollHandler(), Retro::Rw11VirtTermTcp::RcvPollHandler(), and SetupRcvCallback().

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