bufRxManager Class Reference

#include <bufrxmgr.h>

Inheritance diagram for bufRxManager:

Collaboration diagram for bufRxManager:

Public Member Functions
	bufRxManager (const std::string &, unsigned int qdepth, unsigned int bsize=0)
virtual	~bufRxManager ()
unsigned int	bsize ()
epicsUInt8 *	getFree (unsigned int *)
void	receive (epicsUInt8 *, unsigned int)
virtual void	dataRxError (dataBufComplete, void *) OVERRIDE FINAL
	Notification if Rx queue overflows. More...
virtual void	dataRxAddReceive (dataBufComplete fptr, void *arg=0) OVERRIDE FINAL
	Register to receive data buffers. More...
virtual void	dataRxDeleteReceive (dataBufComplete fptr, void *arg=0) OVERRIDE FINAL
	Unregister. More...
Public Member Functions inherited from dataBufRx
	dataBufRx (const std::string &n)
virtual	~dataBufRx ()=0
virtual bool	dataRxEnabled () const =0
virtual void	dataRxEnable (bool)=0
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)

Protected Member Functions
void	haderror (epicsStatus e)
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

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 *)

Detailed Description

Definition at line 21 of file bufrxmgr.h.

Constructor & Destructor Documentation

bufRxManager()

bufRxManager::bufRxManager	(	const std::string &	n,
		unsigned int	qdepth,
		unsigned int	bsize = 0
	)

Definition at line 63 of file bufrxmgr.cpp.

  :dataBufRx(n)
  ,guard()
  ,onerror(defaulterr)
  ,onerror_arg(NULL)
  ,m_bsize(bsize ? bsize : 2048)
{
    ellInit(&dispatch);
    ellInit(&freebufs);
    ellInit(&usedbufs);

    CBINIT(&received_cb, priorityMedium, &bufRxManager::received, this);

    for(unsigned int i=0; i<qdepth; i++) {
        buffer *t=(buffer*)callocMustSucceed(1, sizeof(buffer)-1+m_bsize, "bufRxManager buffer");
        ellAdd(&freebufs, &t->node);
    }
}

~bufRxManager()

bufRxManager::~bufRxManager ( )

virtual

Definition at line 82 of file bufrxmgr.cpp.

{
    ELLNODE *node, *next;

    SCOPED_LOCK(guard);

    for(node=ellFirst(&freebufs), next=node ? ellNext(node):NULL;
        node;
        node=next, next=next ? ellNext(next) : NULL)
    {
        buffer *b=CONTAINER(node, buffer, node);
        free(b);
    }
}

Member Function Documentation

bsize()

unsigned int bufRxManager::bsize ( )

inline

Definition at line 28 of file bufrxmgr.h.

{return m_bsize;};

dataRxAddReceive()

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

virtual

Register to receive data buffers.

Parameters

id	Receive buffers with this Protocol ID.
fptr[in]	Function pointer invoken after Rx
arg[in]	Arbitrary pointer passed to completion function

Implements dataBufRx.

Definition at line 191 of file bufrxmgr.cpp.

{
    listener *l;

    SCOPED_LOCK(guard);

    for(ELLNODE *node=ellFirst(&dispatch); node; node=ellNext(node))
    {
        l=CONTAINER(node, listener, node);
        // Don't add duplicates
        if (l->fn==fn && l->fnarg==arg) {
            return;
        }
    }

    l=new listener;
    l->fn=fn;
    l->fnarg=arg;

    ellAdd(&dispatch, &l->node);
}

dataRxDeleteReceive()

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

virtual

Unregister.

Implements dataBufRx.

Definition at line 214 of file bufrxmgr.cpp.

{
    listener *l;

    SCOPED_LOCK(guard);

    for(ELLNODE *node=ellFirst(&dispatch); node; node=ellNext(node))
    {
        l=CONTAINER(node, listener, node);
        if (l->fn==fn && l->fnarg==arg) {
            ellDelete(&dispatch, node);
            delete l;
            return;
        }
    }
}

dataRxError()

void bufRxManager::dataRxError ( dataBufComplete  fn, void *  arg  )

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.

Implements dataBufRx.

Definition at line 183 of file bufrxmgr.cpp.

{
    SCOPED_LOCK(guard);
    onerror=fn;
    onerror_arg=arg;
}

getFree()

epicsUInt8 * bufRxManager::getFree

(

unsigned int *

blen

)

Definition at line 98 of file bufrxmgr.cpp.

{
    ELLNODE *node;
    {
        SCOPED_LOCK(guard);
        node=ellGet(&freebufs);
    }

    if (!node)
        return NULL;

    buffer *buf=CONTAINER(node, buffer, node);

    if (blen) *blen=bsize();

    buf->used=0;
    return buf->data;
}

haderror()

void bufRxManager::haderror ( epicsStatus  e )

inlineprotected

Definition at line 71 of file bufrxmgr.h.

{onerror(onerror_arg,e,0,NULL);}

receive()

void bufRxManager::receive	(	epicsUInt8 *	raw,
		unsigned int	usedlen
	)

Definition at line 118 of file bufrxmgr.cpp.

{
    /* CONTAINER doesn't work when the member is a pointer
     * because the GNU version's check isn't correct
    buffer *buf=CONTAINER(raw, buffer, data);
     */
    buffer *buf=(buffer*)((char*)(raw) - offsetof(buffer, data));

    if (usedlen>bsize())
        throw std::out_of_range("User admitted overflowing Rx buffer");
    buf->used=usedlen;

    if (usedlen==0) {
        // buffer returned w/o being used
        {
            SCOPED_LOCK(guard);
            ellAdd(&freebufs, &buf->node);
        }
        if(evrMrmSeqRxDebug>=2) {
            errlogPrintf("buffer ignored\n");
        }
        return;
    }

    {
        SCOPED_LOCK(guard);
        ellAdd(&usedbufs, &buf->node);
    }

    callbackRequest(&received_cb);
}

---

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

• bufrxmgr.h
• bufrxmgr.cpp