comQueSend Class Reference

#include "comQueSend.h"

Public Member Functions
	comQueSend (wireSendAdapter &, comBufMemoryManager &)
	~comQueSend ()
void	clear ()
unsigned	occupiedBytes () const
bool	flushEarlyThreshold (unsigned nBytesThisMsg) const
bool	flushBlockThreshold () const
void	pushUInt16 (const ca_uint16_t value)
void	pushUInt32 (const ca_uint32_t value)
void	pushFloat32 (const ca_float32_t value)
void	pushString (const char *pVal, unsigned nChar)
void	insertRequestHeader (ca_uint16_t request, ca_uint32_t payloadSize, ca_uint16_t dataType, ca_uint32_t nElem, ca_uint32_t cid, ca_uint32_t requestDependent, bool v49Ok)
void	insertRequestWithPayLoad (ca_uint16_t request, unsigned dataType, arrayElementCount nElem, ca_uint32_t cid, ca_uint32_t requestDependent, const void *pPayload, bool v49Ok)
comBuf *	popNextComBufToSend ()

Friends
class	comQueSendMsgMinder

Detailed Description

Definition at line 53 of file comQueSend.h.

Constructor & Destructor Documentation

comQueSend::comQueSend	(	wireSendAdapter &	wireIn,
		comBufMemoryManager &	comBufMemMgrIn
	)

Definition at line 80 of file comQueSend.cpp.

                                          :
        comBufMemMgr ( comBufMemMgrIn ), wire ( wireIn ),
            nBytesPending ( 0u )
{
}

comQueSend::~comQueSend

(

)

Definition at line 87 of file comQueSend.cpp.

{
    this->clear ();
}

Member Function Documentation

void comQueSend::clear

(

)

Definition at line 92 of file comQueSend.cpp.

{
    comBuf *pBuf;

    while ( ( pBuf = this->bufs.get () ) ) {
        this->nBytesPending -= pBuf->occupiedBytes ();
        pBuf->~comBuf ();
        this->comBufMemMgr.release ( pBuf );
    }
    this->pFirstUncommited = tsDLIter < comBuf > ();
    assert ( this->nBytesPending == 0 );
}

bool comQueSend::flushBlockThreshold ( ) const

inline

Definition at line 221 of file comQueSend.h.

{
    return ( this->nBytesPending > 16 * comBuf::capacityBytes () );
}

bool comQueSend::flushEarlyThreshold ( unsigned  nBytesThisMsg ) const

inline

Definition at line 226 of file comQueSend.h.

{
    return ( this->nBytesPending + nBytesThisMsg > 4 * comBuf::capacityBytes () );
}

void comQueSend::insertRequestHeader	(	ca_uint16_t	request,
		ca_uint32_t	payloadSize,
		ca_uint16_t	dataType,
		ca_uint32_t	nElem,
		ca_uint32_t	cid,
		ca_uint32_t	requestDependent,
		bool	v49Ok
	)

Definition at line 279 of file comQueSend.cpp.

{
    if ( payloadSize < 0xffff && nElem < 0xffff ) {
        comBuf * pComBuf = this->bufs.last ();
        if ( ! pComBuf || pComBuf->unoccupiedBytes() < 16u ) {
            pComBuf = newComBuf ();
            this->pushComBuf ( *pComBuf );
        }
        pComBuf->push ( request );
        pComBuf->push ( static_cast < ca_uint16_t > ( payloadSize ) );
        pComBuf->push ( dataType );
        pComBuf->push ( static_cast < ca_uint16_t > ( nElem ) );
        pComBuf->push ( cid );
        pComBuf->push ( requestDependent );
    }
    else if ( v49Ok ) {
        comBuf * pComBuf = this->bufs.last ();
        if ( ! pComBuf || pComBuf->unoccupiedBytes() < 24u ) {
            pComBuf = newComBuf ();
            this->pushComBuf ( *pComBuf );
        }
        pComBuf->push ( request );
        pComBuf->push ( static_cast < ca_uint16_t > ( 0xffff ) );
        pComBuf->push ( dataType );
        pComBuf->push ( static_cast < ca_uint16_t > ( 0u ) );
        pComBuf->push ( cid );
        pComBuf->push ( requestDependent );
        pComBuf->push ( payloadSize );
        pComBuf->push ( nElem );
    }
    else {
        throw cacChannel::outOfBounds ();
    }
}

void comQueSend::insertRequestWithPayLoad	(	ca_uint16_t	request,
		unsigned	dataType,
		arrayElementCount	nElem,
		ca_uint32_t	cid,
		ca_uint32_t	requestDependent,
		const void *	pPayload,
		bool	v49Ok
	)

Definition at line 317 of file comQueSend.cpp.

{
    if ( INVALID_DB_REQ ( dataType ) ) {
        throw cacChannel::badType ();
    }
    if ( dataType >= comQueSendCopyDispatchSize ) {
        throw cacChannel::badType();
    }
    ca_uint32_t size = 0u;
    ca_uint32_t payloadSize = 0u;
    if ( nElem == 1 ) {
        if ( dataType == DBR_STRING  ) {
            const char * pStr = static_cast < const char * >  ( pPayload );
            size = strlen ( pStr ) + 1u;
            if ( size > MAX_STRING_SIZE ) {
                throw cacChannel::outOfBounds();
            }
            payloadSize = CA_MESSAGE_ALIGN ( size );
            this->insertRequestHeader ( request, payloadSize,
                static_cast <ca_uint16_t> ( dataType ),
                nElem, cid, requestDependent, v49Ok );
            this->pushString ( pStr, size );
        }
        else {
            size = dbr_size[dataType];
            payloadSize = CA_MESSAGE_ALIGN ( size );
            this->insertRequestHeader ( request, payloadSize,
                static_cast <ca_uint16_t> ( dataType ),
                nElem, cid, requestDependent, v49Ok );
            ( this->*dbrCopyScalar [dataType] ) ( pPayload );
        }
    }
    else {
        arrayElementCount maxBytes;
        if ( v49Ok ) {
            maxBytes = 0xffffffff;
        }
        else {
            maxBytes = MAX_TCP - sizeof ( caHdr );
        }
        arrayElementCount maxElem =
            ( maxBytes - sizeof (dbr_double_t) - dbr_size[dataType] ) /
                dbr_value_size[dataType];
        if ( nElem >= maxElem ) {
            throw cacChannel::outOfBounds();
        }
        // the above checks verify that the total size
        // is lest that 0xffffffff
        size = static_cast < ca_uint32_t >
            ( dbr_size_n ( dataType, nElem ) );
        payloadSize = CA_MESSAGE_ALIGN ( size );
        this->insertRequestHeader ( request, payloadSize,
            static_cast <ca_uint16_t> ( dataType ),
            static_cast < ca_uint32_t > ( nElem ),
            cid, requestDependent, v49Ok );
        ( this->*dbrCopyVector [dataType] ) ( pPayload, nElem );
    }
    // set pad bytes to nill
    unsigned padSize = payloadSize - size;
    if ( padSize ) {
        this->pushString ( cacNillBytes, payloadSize - size );
    }
}

unsigned comQueSend::occupiedBytes ( ) const

inline

Definition at line 216 of file comQueSend.h.

{
    return this->nBytesPending;
}

comBuf * comQueSend::popNextComBufToSend

(

)

Definition at line 259 of file comQueSend.cpp.

{
    comBuf *pBuf = this->bufs.get ();
    if ( pBuf ) {
        unsigned nBytesThisBuf = pBuf->occupiedBytes ();
        if ( nBytesThisBuf ) {
            assert ( this->nBytesPending >= nBytesThisBuf );
            this->nBytesPending -= nBytesThisBuf;
        }
        else {
            this->bufs.push ( *pBuf );
            pBuf = 0;
        }
    }
    else {
        assert ( this->nBytesPending == 0u );
    }
    return pBuf;
}

void comQueSend::pushFloat32 ( const ca_float32_t  value )

inline

Definition at line 198 of file comQueSend.h.

{
    this->push ( value );
}

void comQueSend::pushString ( const char *  pVal, unsigned  nChar  )

inline

Definition at line 203 of file comQueSend.h.

{
    this->push ( pVal, nChar );
}

void comQueSend::pushUInt16 ( const ca_uint16_t  value )

inline

Definition at line 188 of file comQueSend.h.

{
    this->push ( value );
}

void comQueSend::pushUInt32 ( const ca_uint32_t  value )

inline

Definition at line 193 of file comQueSend.h.

{
    this->push ( value );
}

Friends And Related Function Documentation

friend class comQueSendMsgMinder

friend

Definition at line 110 of file comQueSend.h.

---

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

• modules/ca/src/client/comQueSend.h
• modules/ca/src/client/comQueSend.cpp