dataBufRx Class Reference

#include <databuf.h>

Inheritance diagram for dataBufRx:

Collaboration diagram for dataBufRx:

Public Member Functions
	dataBufRx (const std::string &n)
virtual	~dataBufRx ()=0
virtual bool	dataRxEnabled () const =0
virtual void	dataRxEnable (bool)=0
virtual void	dataRxError (dataBufComplete, void *)=0
	Notification if Rx queue overflows. More...
virtual void	dataRxAddReceive (dataBufComplete fptr, void *arg=0)=0
	Register to receive data buffers. More...
virtual void	dataRxDeleteReceive (dataBufComplete fptr, void *arg=0)=0
	Unregister. More...
Public Member Functions inherited from mrf::ObjectInst< dataBufRx >
virtual propertyBase *	getPropertyBase (const char *pname, const std::type_info &ptype)
virtual void	visitProperties (bool(*cb)(propertyBase *, void *), void *arg)
Public Member Functions inherited from mrf::Object
const std::string &	name () const
const Object *	parent () const
virtual void	lock () const =0
virtual void	unlock () const =0
child_iterator	beginChild () const
child_iterator	endChild () const
template<typename P >
mrf::auto_ptr< property< P > >	getProperty (const char *pname)

Additional Inherited Members
Public Types inherited from mrf::Object
typedef m_obj_children_t::const_iterator	child_iterator
typedef std::map< std::string, std::string >	create_args_t
typedef Object *(*	create_factory_t) (const std::string &name, const std::string &klass, const create_args_t &args)
Static Public Member Functions inherited from mrf::ObjectInst< dataBufRx >
static int	initObject ()
Static Public Member Functions inherited from mrf::Object
static Object *	getObject (const std::string &name)
static Object *	getCreateObject (const std::string &name, const std::string &klass, const create_args_t &args=create_args_t())
static void	addFactory (const std::string &klass, create_factory_t fn)
static void	visitObjects (bool(*)(Object *, void *), void *)
Protected Member Functions inherited from mrf::ObjectInst< dataBufRx >
	ObjectInst (const std::string &n)
	ObjectInst (const std::string &n, A &a)
virtual	~ObjectInst ()
Protected Member Functions inherited from mrf::Object
	Object (const std::string &n, const Object *par=0)
virtual	~Object ()=0

Detailed Description

Definition at line 62 of file databuf.h.

Constructor & Destructor Documentation

dataBufRx()

dataBufRx::dataBufRx ( const std::string &  n )

inlineexplicit

Definition at line 64 of file databuf.h.

: mrf::ObjectInst<dataBufRx>(n) {}

~dataBufRx()

dataBufRx::~dataBufRx ( )

pure virtual

Definition at line 19 of file databuf.cpp.

{}

Member Function Documentation

dataRxAddReceive()

virtual void dataBufRx::dataRxAddReceive ( dataBufComplete  fptr, void *  arg = 0  )

pure virtual

Register to receive data buffers.

Parameters

fptr[in]	Function pointer invoken after Rx
arg[in]	Arbitrary pointer passed to completion function

Implemented in bufRxManager.

dataRxDeleteReceive()

virtual void dataBufRx::dataRxDeleteReceive ( dataBufComplete  fptr, void *  arg = 0  )

pure virtual

Unregister.

Implemented in bufRxManager.

dataRxEnable()

virtual void dataBufRx::dataRxEnable ( bool  )

pure virtual

Implemented in mrmBufRx.

dataRxEnabled()

virtual bool dataBufRx::dataRxEnabled ( ) const

pure virtual

Implemented in mrmBufRx.

dataRxError()

virtual void dataBufRx::dataRxError ( dataBufComplete  , void *    )

pure virtual

Notification if Rx queue overflows.

If the queue overflows then the function is invoked with 'len' zero and 'buf' NULL. If a buffer with a length greater then the given maxlen is received then the function is invoked with 'len' set to the length of the discarded buffer and 'buf' NULL.

Implemented in bufRxManager.

---

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

• databuf.h
• databuf.cpp