#include "syncGroup.h"

Inheritance diagram for CASG:

Collaboration diagram for CASG:

Public Member Functions
	CASG (epicsGuard< epicsMutex > &, ca_client_context &cacIn)

void	destructor (CallbackGuard &, epicsGuard< epicsMutex > &guard)

bool	ioComplete (CallbackGuard &, epicsGuard< epicsMutex > &guard)

bool	verify (epicsGuard< epicsMutex > &) const

int	block (epicsGuard< epicsMutex > *pcbGuard, epicsGuard< epicsMutex > &guard, double timeout)

void	reset (CallbackGuard &, epicsGuard< epicsMutex > &)

void	show (epicsGuard< epicsMutex > &, unsigned level) const

void	show (unsigned level) const

void	get (epicsGuard< epicsMutex > &, chid pChan, unsigned type, arrayElementCount count, void *pValue)

void	put (epicsGuard< epicsMutex > &, chid pChan, unsigned type, arrayElementCount count, const void *pValue)

void	completionNotify (epicsGuard< epicsMutex > &, syncGroupNotify &)

int	printFormated (const char *pFormat,...)

void *	operator new (size_t size, tsFreeList< struct CASG, 128, epicsMutexNOOP > &)

void	destroyPendingIO (CallbackGuard &cbGuard, epicsGuard< epicsMutex > &guard)

void	destroyCompletedIO (CallbackGuard &cbGuard, epicsGuard< epicsMutex > &guard)

void	recycleReadNotifyIO (epicsGuard< epicsMutex > &, syncGroupReadNotify &)

void	recycleWriteNotifyIO (epicsGuard< epicsMutex > &, syncGroupWriteNotify &)

	CASG (const CASG &)

CASG &	operator= (const CASG &)

void	operator delete (void *)

	~CASG ()

Public Member Functions inherited from chronIntIdRes< CASG >
	chronIntIdRes ()

Public Member Functions inherited from chronIntId
	chronIntId (const unsigned &idIn)

Public Member Functions inherited from intId< unsigned, 8u, sizeof(unsigned)*CHAR_BIT >
	intId (const unsigned &idIn)

bool	operator== (const intId &idIn) const

resTableIndex	hash () const

const unsigned	getId () const

Public Member Functions inherited from tsSLNode< CASG >
	tsSLNode ()

tsSLNode< CASG > &	operator= (const tsSLNode< CASG > &)

Public Attributes
void exception epicsGuard< epicsMutex > int	status

void exception epicsGuard< epicsMutex > int const char *	pContext

void exception epicsGuard< epicsMutex > int const char const char *	pFileName

void exception epicsGuard< epicsMutex > int const char const char unsigned	lineNo

void exception epicsGuard< epicsMutex > int const char const char unsigned oldChannelNotify &	chan

void exception epicsGuard< epicsMutex > int const char const char unsigned oldChannelNotify unsigned	type

void exception epicsGuard< epicsMutex > int const char const char unsigned oldChannelNotify unsigned arrayElementCount	count

void exception epicsGuard< epicsMutex > int const char const char unsigned oldChannelNotify unsigned arrayElementCount unsigned	op

epicsPlacementDeleteOperator((void *, tsFreeList< struct CASG, 128, epicsMutexNOOP > &)) private tsDLList< syncGroupNotify	ioCompletedList )

epicsEvent	sem

ca_client_context &	client

unsigned	magic

tsFreeList< class syncGroupReadNotify, 128, epicsMutexNOOP >	freeListReadOP

tsFreeList< class syncGroupWriteNotify, 128, epicsMutexNOOP >	freeListWriteOP

Friends
class	sgAutoPtr< syncGroupWriteNotify >

class	sgAutoPtr< syncGroupReadNotify >

Additional Inherited Members
Protected Attributes inherited from intId< unsigned, 8u, sizeof(unsigned)*CHAR_BIT >
unsigned	id

Detailed Description

Definition at line 152 of file syncGroup.h.

Constructor & Destructor Documentation

CASG::CASG	(	epicsGuard< epicsMutex > &	guard,
		ca_client_context &	cacIn
	)

Definition at line 27 of file CASG.cpp.

                                                                           :
     client ( cacIn ), magic ( CASG_MAGIC )
 {
     client.installCASG ( guard, *this );
 }

CASG::CASG ( const CASG & )

CASG::~CASG ( )

Definition at line 33 of file CASG.cpp.

34 {

35 }

Member Function Documentation

int CASG::block	(	epicsGuard< epicsMutex > *	pcbGuard,
		epicsGuard< epicsMutex > &	guard,
		double	timeout
	)

Definition at line 62 of file CASG.cpp.

 {
     epicsTime cur_time;
     epicsTime beg_time;
     double delay;
     double remaining;
     int status;
 
     guard.assertIdenticalMutex ( this->client.mutexRef() );
 
     // prevent recursion nightmares by disabling blocking
     // for IO from within a CA callback.
     if ( epicsThreadPrivateGet ( caClientCallbackThreadId ) ) {
         return ECA_EVDISALLOW;
     }
 
     if ( timeout < 0.0 ) {
         return ECA_TIMEOUT;
     }
 
     cur_time = epicsTime::getCurrent ();
 
     this->client.flush ( guard );
 
     beg_time = cur_time;
     delay = 0.0;
 
     while ( 1 ) {
         if ( this->ioPendingList.count() == 0u ) {
             status = ECA_NORMAL;
             break;
         }
 
         remaining = timeout - delay;
         if ( remaining <= CAC_SIGNIFICANT_DELAY ) {
             /*
              * Make sure that we take care of
              * recv backlog at least once
              */
             status = ECA_TIMEOUT;
             break;
         }
 
         if ( pcbGuard ) {
             epicsGuardRelease < epicsMutex > unguard ( guard );
             {
                 epicsGuardRelease < epicsMutex > uncbGuard ( *pcbGuard );
                 this->sem.wait ( remaining );
             }
         }
         else {
             epicsGuardRelease < epicsMutex > unguard ( guard );
             this->sem.wait ( remaining );
         }
 
         /*
          * force a time update
          */
         cur_time = epicsTime::getCurrent ();
 
         delay = cur_time - beg_time;
     }
 
     return status;
 }

void CASG::completionNotify	(	epicsGuard< epicsMutex > &	guard,
		syncGroupNotify &	notify
	)

Definition at line 233 of file CASG.cpp.

 {
     guard.assertIdenticalMutex ( this->client.mutexRef() );
     this->ioPendingList.remove ( notify );
     this->ioCompletedList.add ( notify );
     if ( this->ioPendingList.count () == 0u ) {
         this->sem.signal ();
     }
 }

void CASG::destroyCompletedIO	(	CallbackGuard &	cbGuard,
		epicsGuard< epicsMutex > &	guard
	)

Definition at line 141 of file CASG.cpp.

 {
     guard.assertIdenticalMutex ( this->client.mutexRef() );
     syncGroupNotify * pNotify;
     while ( ( pNotify = this->ioCompletedList.get () ) ) {
         pNotify->destroy ( cbGuard, guard );
     }
 }

void CASG::destroyPendingIO	(	CallbackGuard &	cbGuard,
		epicsGuard< epicsMutex > &	guard
	)

Definition at line 152 of file CASG.cpp.

 {
     guard.assertIdenticalMutex ( this->client.mutexRef() );
     while ( syncGroupNotify * pNotify = this->ioPendingList.first () ) {
         pNotify->cancel ( cbGuard, guard );
         // cancel must release the guard while
         // canceling put callbacks so we
         // must double check list membership
         if ( pNotify->ioPending ( guard ) ) {
             this->ioPendingList.remove ( *pNotify );
         }
         else {
             this->ioCompletedList.remove ( *pNotify );
         }
         pNotify->destroy ( cbGuard, guard );
     }
 }

void CASG::destructor	(	CallbackGuard &	cbGuard,
		epicsGuard< epicsMutex > &	guard
	)

Definition at line 37 of file CASG.cpp.

 {
     guard.assertIdenticalMutex ( this->client.mutexRef() );
 
     if ( this->verify ( guard ) ) {
         this->reset ( cbGuard, guard );
         this->client.uninstallCASG ( guard, *this );
         this->magic = 0;
     }
     else {
         this->printFormated ( "cac: attempt to destroy invalid sync group ignored\n" );
     }
     this->~CASG ();
 }

void CASG::get	(	epicsGuard< epicsMutex > &	guard,
		chid	pChan,
		unsigned	type,
		arrayElementCount	count,
		void *	pValue
	)

Definition at line 222 of file CASG.cpp.

 {
     guard.assertIdenticalMutex ( this->client.mutexRef() );
     sgAutoPtr < syncGroupReadNotify > pNotify ( guard, *this );
     pNotify = syncGroupReadNotify::factory (
         this->freeListReadOP, *this, & CASG :: recycleReadNotifyIO, pChan, pValue );
     pNotify->begin ( guard, type, count );
     pNotify.release ();
 }

bool CASG::ioComplete	(	CallbackGuard &	cbGuard,
		epicsGuard< epicsMutex > &	guard
	)

Definition at line 202 of file CASG.cpp.

 {
     guard.assertIdenticalMutex ( this->client.mutexRef() );
     this->destroyCompletedIO ( cbGuard, guard );
     return this->ioPendingList.count () == 0u;
 }

void CASG::operator delete ( void * )

Definition at line 298 of file CASG.cpp.

 {
     // Visual C++ .net appears to require operator delete if
     // placement operator delete is defined? I smell a ms rat
     // because if I declare placement new and delete, but
     // comment out the placement delete definition there are
     // no undefined symbols.
     errlogPrintf ( "%s:%d this compiler is confused about placement delete - memory was probably leaked",
         __FILE__, __LINE__ );
 }

void * CASG::operator new	(	size_t	size,
		tsFreeList< struct CASG, 128, epicsMutexNOOP > &	freeList
	)

inline

Definition at line 244 of file syncGroup.h.

 {
     return freeList.allocate ( size );
 }

CASG& CASG::operator= ( const CASG & )

int CASG::printFormated	(	const char *	pFormat,
			...
	)

Definition at line 258 of file CASG.cpp.

 {
     va_list theArgs;
     int status;
 
     va_start ( theArgs, pformat );
 
     status = this->client.varArgsPrintFormated ( pformat, theArgs );
 
     va_end ( theArgs );
 
     return status;
 }

void CASG::put	(	epicsGuard< epicsMutex > &	guard,
		chid	pChan,
		unsigned	type,
		arrayElementCount	count,
		const void *	pValue
	)

Definition at line 211 of file CASG.cpp.

 {
     guard.assertIdenticalMutex ( this->client.mutexRef() );
     sgAutoPtr < syncGroupWriteNotify > pNotify ( guard, *this );
     pNotify = syncGroupWriteNotify::factory (
         this->freeListWriteOP, *this, & CASG :: recycleWriteNotifyIO, pChan );
     pNotify->begin ( guard, type, count, pValue );
     pNotify.release ();
 }

void CASG::recycleReadNotifyIO	(	epicsGuard< epicsMutex > &	guard,
		syncGroupReadNotify &	io
	)

Definition at line 244 of file CASG.cpp.

 {
     guard.assertIdenticalMutex ( this->client.mutexRef() );
     this->freeListReadOP.release ( & io );
 }

void CASG::recycleWriteNotifyIO	(	epicsGuard< epicsMutex > &	guard,
		syncGroupWriteNotify &	io
	)

Definition at line 251 of file CASG.cpp.

 {
     guard.assertIdenticalMutex ( this->client.mutexRef() );
     this->freeListWriteOP.release ( & io );
 }

void CASG::reset	(	CallbackGuard &	cbGuard,
		epicsGuard< epicsMutex > &	guard
	)

Definition at line 131 of file CASG.cpp.

 {
     guard.assertIdenticalMutex ( this->client.mutexRef() );
     this->destroyCompletedIO ( cbGuard, guard );
     this->destroyPendingIO ( cbGuard, guard );
 }

void CASG::show	(	epicsGuard< epicsMutex > &	guard,
		unsigned	level
	)		const

Definition at line 178 of file CASG.cpp.

 {
     guard.assertIdenticalMutex ( this->client.mutexRef() );
     ::printf ( "Sync Group: id=%u, magic=%u, opPend=%u\n",
         this->getId (), this->magic, this->ioPendingList.count () );
     if ( level ) {
         ::printf ( "\tPending" );
         tsDLIterConst < syncGroupNotify > notifyPending =
             this->ioPendingList.firstIter ();
         while ( notifyPending.valid () ) {
             notifyPending->show ( guard, level - 1u );
             notifyPending++;
         }
         ::printf ( "\tCompleted" );
         tsDLIterConst < syncGroupNotify > notifyCompleted =
             this->ioCompletedList.firstIter ();
         while ( notifyCompleted.valid () ) {
             notifyCompleted->show ( guard, level - 1u );
             notifyCompleted++;
         }
     }
 }

void CASG::show ( unsigned level ) const

Definition at line 172 of file CASG.cpp.

 {
     epicsGuard < epicsMutex > guard ( this->client.mutexRef () );
     this->show ( guard, level );
 }

bool CASG::verify ( epicsGuard< epicsMutex > & ) const

Definition at line 54 of file CASG.cpp.

 {
     return ( this->magic == CASG_MAGIC );
 }

Friends And Related Function Documentation

friend class sgAutoPtr< syncGroupReadNotify >

friend

Definition at line 214 of file syncGroup.h.

friend class sgAutoPtr< syncGroupWriteNotify >

friend

Definition at line 213 of file syncGroup.h.

Member Data Documentation

void exception epicsGuard< epicsMutex > int const char const char unsigned oldChannelNotify& CASG::chan

Definition at line 177 of file syncGroup.h.

ca_client_context& CASG::client

Definition at line 190 of file syncGroup.h.

void exception epicsGuard< epicsMutex > int const char const char unsigned oldChannelNotify unsigned arrayElementCount CASG::count

Definition at line 177 of file syncGroup.h.

tsFreeList< class syncGroupReadNotify, 128, epicsMutexNOOP > CASG::freeListReadOP

Definition at line 192 of file syncGroup.h.

tsFreeList< class syncGroupWriteNotify, 128, epicsMutexNOOP > CASG::freeListWriteOP

Definition at line 193 of file syncGroup.h.

epicsPlacementDeleteOperator (( void *, tsFreeList < struct CASG, 128, epicsMutexNOOP > & )) private tsDLList< syncGroupNotify CASG::ioCompletedList)

Definition at line 183 of file syncGroup.h.

void exception epicsGuard< epicsMutex > int const char const char unsigned CASG::lineNo

Definition at line 174 of file syncGroup.h.

unsigned CASG::magic

Definition at line 191 of file syncGroup.h.

void exception epicsGuard< epicsMutex > int const char const char unsigned oldChannelNotify unsigned arrayElementCount unsigned CASG::op

Definition at line 177 of file syncGroup.h.

void exception epicsGuard< epicsMutex > int const char * CASG::pContext

Definition at line 174 of file syncGroup.h.

void exception epicsGuard< epicsMutex > int const char const char * CASG::pFileName

Definition at line 174 of file syncGroup.h.

epicsEvent CASG::sem

Definition at line 189 of file syncGroup.h.

void exception epicsGuard< epicsMutex > int CASG::status

Definition at line 174 of file syncGroup.h.

void exception epicsGuard< epicsMutex > int const char const char unsigned oldChannelNotify unsigned CASG::type

Definition at line 177 of file syncGroup.h.

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

modules/ca/src/client/syncGroup.h
modules/ca/src/client/CASG.cpp

Public Member Functions

Public Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation