netSubscription Class Reference

#include "netIO.h"

Inheritance diagram for netSubscription:

Collaboration diagram for netSubscription:

Public Member Functions
void	show (unsigned level) const
void	show (epicsGuard< epicsMutex > &, unsigned level) const
arrayElementCount	getCount (epicsGuard< epicsMutex > &, bool allow_zero) const
unsigned	getType (epicsGuard< epicsMutex > &) const
unsigned	getMask (epicsGuard< epicsMutex > &) const
void	subscribeIfRequired (epicsGuard< epicsMutex > &guard, nciu &chan)
void	unsubscribeIfRequired (epicsGuard< epicsMutex > &guard, nciu &chan)
Public Member Functions inherited from baseNMIU
virtual void	destroy (epicsGuard< epicsMutex > &, class cacRecycle &)=0
Public Member Functions inherited from tsDLNode< baseNMIU >
	tsDLNode ()
	tsDLNode (const tsDLNode< baseNMIU > &)
const tsDLNode< baseNMIU > &	operator= (const tsDLNode< baseNMIU > &)
Public Member Functions inherited from chronIntIdRes< baseNMIU >
	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< baseNMIU >
	tsSLNode ()
tsSLNode< baseNMIU > &	operator= (const tsSLNode< baseNMIU > &)

Static Public Member Functions
static netSubscription *	factory (tsFreeList< class netSubscription, 1024, epicsMutexNOOP > &, class privateInterfaceForIO &, unsigned type, arrayElementCount count, unsigned mask, cacStateNotify &)

Protected Member Functions
	netSubscription (class privateInterfaceForIO &, unsigned type, arrayElementCount count, unsigned mask, cacStateNotify &)
	~netSubscription ()
Protected Member Functions inherited from baseNMIU
NETIO_VIRTUAL_DESTRUCTOR	~baseNMIU ()

Additional Inherited Members
Public Attributes inherited from baseNMIU
virtual void exception epicsGuard< epicsMutex > cacRecycle int	status
virtual void exception epicsGuard< epicsMutex > cacRecycle int const char *	pContext = 0
virtual void exception epicsGuard< epicsMutex > cacRecycle int const char unsigned	type
virtual void exception epicsGuard< epicsMutex > cacRecycle int const char unsigned arrayElementCount	count = 0
Protected Attributes inherited from intId< unsigned, 8u, sizeof(unsigned)*CHAR_BIT >
unsigned	id

Detailed Description

Definition at line 74 of file netIO.h.

Constructor & Destructor Documentation

netSubscription::netSubscription ( class privateInterfaceForIO &  chanIn, unsigned  type, arrayElementCount  count, unsigned  mask, cacStateNotify &  notifyIn  )

protected

Definition at line 33 of file netSubscription.cpp.

                                                     :
    count ( countIn ), privateChanForIO ( chanIn ),
    notify ( notifyIn ), type ( typeIn ), mask ( maskIn ),
    subscribed ( false )
{
    if ( ! dbr_type_is_valid ( typeIn ) ) {
        throw cacChannel::badType ();
    }
    if ( this->mask == 0u ) {
        throw cacChannel::badEventSelection ();
    }
}

netSubscription::~netSubscription ( )

protected

Definition at line 49 of file netSubscription.cpp.

{
}

Member Function Documentation

netSubscription * netSubscription::factory ( tsFreeList< class netSubscription, 1024, epicsMutexNOOP > &  freeList, class privateInterfaceForIO &  chan, unsigned  type, arrayElementCount  count, unsigned  mask, cacStateNotify &  notify  )

inlinestatic

Definition at line 231 of file netIO.h.

{
    return new ( freeList ) netSubscription ( chan, type,
                                count, mask, notify );
}

arrayElementCount netSubscription::getCount ( epicsGuard< epicsMutex > &  guard, bool  allow_zero  ) const

inline

Definition at line 240 of file netIO.h.

{
    //guard.assertIdenticalMutex ( this->mutex );
    arrayElementCount nativeCount = this->privateChanForIO.nativeElementCount ( guard );
    if ( (this->count == 0u && !allow_zero) || this->count > nativeCount ) {
        return nativeCount;
    }
    else {
        return this->count;
    }
}

unsigned netSubscription::getMask ( epicsGuard< epicsMutex > &  ) const

inline

Definition at line 258 of file netIO.h.

{
    return this->mask;
}

unsigned netSubscription::getType ( epicsGuard< epicsMutex > &  ) const

inline

Definition at line 253 of file netIO.h.

{
    return this->type;
}

void netSubscription::show ( unsigned  level ) const

virtual

Implements baseNMIU.

Definition at line 65 of file netSubscription.cpp.

{
    ::printf ( "event subscription IO at %p, type %s, element count %lu, mask %u\n",
        static_cast < const void * > ( this ),
        dbf_type_to_text ( static_cast < int > ( this->type ) ),
        this->count, this->mask );
}

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

virtual

Implements baseNMIU.

Definition at line 73 of file netSubscription.cpp.

{
    this->show ( level );
}

void netSubscription::subscribeIfRequired	(	epicsGuard< epicsMutex > &	guard,
		nciu &	chan
	)

Definition at line 144 of file netSubscription.cpp.

{
    if ( ! this->subscribed ) {
        chan.getPIIU(guard)->subscriptionRequest (
            guard, chan, *this );
        this->subscribed = true;
    }
}

void netSubscription::unsubscribeIfRequired	(	epicsGuard< epicsMutex > &	guard,
		nciu &	chan
	)

Definition at line 154 of file netSubscription.cpp.

{
    if ( this->subscribed ) {
        chan.getPIIU(guard)->subscriptionCancelRequest (
            guard, chan, *this );
        this->subscribed = false;
    }
}

---

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

• modules/ca/src/client/netIO.h
• modules/ca/src/client/netSubscription.cpp