#include "nciu.h"

Inheritance diagram for nciu:

Collaboration diagram for nciu:

Public Member Functions
	nciu (cac &, netiiu &, cacChannelNotify &, const char *pNameIn, cacChannel::priLev)

	~nciu ()

void	connect (unsigned nativeType, unsigned nativeCount, unsigned sid, epicsGuard< epicsMutex > &cbGuard, epicsGuard< epicsMutex > &guard)

void	connect (epicsGuard< epicsMutex > &cbGuard, epicsGuard< epicsMutex > &guard)

void	unresponsiveCircuitNotify (epicsGuard< epicsMutex > &cbGuard, epicsGuard< epicsMutex > &guard)

void	circuitHangupNotify (class udpiiu &, epicsGuard< epicsMutex > &cbGuard, epicsGuard< epicsMutex > &guard)

void	setServerAddressUnknown (netiiu &newiiu, epicsGuard< epicsMutex > &guard)

bool	searchMsg (epicsGuard< epicsMutex > &)

void	serviceShutdownNotify (epicsGuard< epicsMutex > &callbackControlGuard, epicsGuard< epicsMutex > &mutualExclusionGuard)

void	accessRightsStateChange (const caAccessRights &, epicsGuard< epicsMutex > &cbGuard, epicsGuard< epicsMutex > &guard)

ca_uint32_t	getSID (epicsGuard< epicsMutex > &) const

ca_uint32_t	getCID (epicsGuard< epicsMutex > &) const

netiiu *	getPIIU (epicsGuard< epicsMutex > &)

const netiiu *	getConstPIIU (epicsGuard< epicsMutex > &) const

cac &	getClient ()

void	searchReplySetUp (netiiu &iiu, unsigned sidIn, ca_uint16_t typeIn, arrayElementCount countIn, epicsGuard< epicsMutex > &)

void	show (unsigned level) const

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

unsigned	getName (epicsGuard< epicsMutex > &, char *pBuf, unsigned bufLen) const throw ()

const char *	pName (epicsGuard< epicsMutex > &) const throw ()

unsigned	nameLen (epicsGuard< epicsMutex > &) const

unsigned	getHostName (epicsGuard< epicsMutex > &, char *pBuf, unsigned bufLen) const throw ()

void	writeException (epicsGuard< epicsMutex > &, epicsGuard< epicsMutex > &, int status, const char *pContext, unsigned type, arrayElementCount count)

cacChannel::priLev	getPriority (epicsGuard< epicsMutex > &) const

void *	operator new (size_t size, tsFreeList< class nciu, 1024, epicsMutexNOOP > &)

	epicsPlacementDeleteOperator ((void *, tsFreeList< class nciu, 1024, epicsMutexNOOP > &)) void resubscribe(epicsGuard< epicsMutex > &)

void	sendSubscriptionUpdateRequests (epicsGuard< epicsMutex > &)

void	disconnectAllIO (epicsGuard< epicsMutex > &, epicsGuard< epicsMutex > &)

bool	connected (epicsGuard< epicsMutex > &) const

unsigned	getcount () const

Public Member Functions inherited from cacChannel
	cacChannel (cacChannelNotify &)

cacChannelNotify &	notify () const

Public Member Functions inherited from chronIntIdRes< nciu >
	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< nciu >
	tsSLNode ()

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

Public Member Functions inherited from tsDLNode< class nciu >
	tsDLNode ()

	tsDLNode (const tsDLNode< class nciu > &)

const tsDLNode< class nciu > &	operator= (const tsDLNode< class nciu > &)

Additional Inherited Members
Public Types inherited from cacChannel
enum	ioStatus { iosSynch, iosAsynch }

typedef unsigned	priLev

typedef unsigned	ioid

Static Public Member Functions inherited from channelNode
static unsigned	getMaxSearchTimerCount ()

Static Public Attributes inherited from cacChannel
static const priLev	priorityMax = 99u

static const priLev	priorityMin = 0u

static const priLev	priorityDefault = priorityMin

static const priLev	priorityLinksDB = priorityMax

static const priLev	priorityArchive = ( priorityMax - priorityMin ) / 2

static const priLev	priorityOPI = priorityMin

Protected Member Functions inherited from cacChannel
virtual	~cacChannel ()=0

Protected Member Functions inherited from channelNode
	channelNode ()

bool	isInstalledInServer (epicsGuard< epicsMutex > &) const

bool	isConnected (epicsGuard< epicsMutex > &) const

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

Detailed Description

Definition at line 127 of file nciu.h.

Constructor & Destructor Documentation

nciu::nciu	(	cac &	cacIn,
		netiiu &	iiuIn,
		cacChannelNotify &	chanIn,
		const char *	pNameIn,
		cacChannel::priLev	pri
	)

Definition at line 40 of file nciu.cpp.

                                                         :
     cacChannel ( chanIn ),
     cacCtx ( cacIn ),
     piiu ( & iiuIn ),
     sid ( UINT_MAX ),
     count ( 0 ),
     retry ( 0u ),
     nameLength ( 0u ),
     typeCode ( USHRT_MAX ),
     priority ( static_cast <ca_uint8_t> ( pri ) )
 {
     size_t nameLengthTmp = strlen ( pNameIn ) + 1;
 
     // second constraint is imposed by size field in protocol header
     if ( nameLengthTmp > MAX_UDP_SEND - sizeof ( caHdr ) || nameLengthTmp > USHRT_MAX ) {
         throw cacChannel::badString ();
     }
 
     if ( pri > 0xff ) {
         throw cacChannel::badPriority ();
     }
 
     this->nameLength = static_cast <unsigned short> ( nameLengthTmp );
 
     this->pNameStr = new char [ this->nameLength ];
     strcpy ( this->pNameStr, pNameIn );
 }

nciu::~nciu ( )

Definition at line 69 of file nciu.cpp.

 {
     delete [] this->pNameStr;
 }

Member Function Documentation

void nciu::accessRightsStateChange	(	const caAccessRights &	arIn,
		epicsGuard< epicsMutex > &	cbGuard,
		epicsGuard< epicsMutex > &	guard
	)

Definition at line 196 of file nciu.cpp.

 {
     guard.assertIdenticalMutex ( this->cacCtx.mutexRef () );
     this->accessRightState = arIn;
 
     //
     // the channel delete routine takes the call back lock so
     // that this will not be called when the channel is being
     // deleted.
     //
     this->notify().accessRightsNotify ( guard, this->accessRightState );
 }

void nciu::circuitHangupNotify	(	class udpiiu &	,
		epicsGuard< epicsMutex > &	cbGuard,
		epicsGuard< epicsMutex > &	guard
	)

void nciu::connect	(	unsigned	nativeType,
		unsigned	nativeCount,
		unsigned	sid,
		epicsGuard< epicsMutex > &	cbGuard,
		epicsGuard< epicsMutex > &	guard
	)

Definition at line 114 of file nciu.cpp.

 {
     guard.assertIdenticalMutex ( this->cacCtx.mutexRef () );
     if ( ! dbf_type_is_valid ( nativeType ) ) {
         throw std::logic_error ( "Ignored conn resp with bad native data type" );
     }
 
     this->typeCode = static_cast < unsigned short > ( nativeType );
     this->count = nativeCount;
     this->sid = sidIn;
 
     /*
      * if less than v4.1 then the server will never
      * send access rights and there will always be access
      */
     bool v41Ok = this->piiu->ca_v41_ok ( guard );
     if ( ! v41Ok ) {
         this->accessRightState.setReadPermit();
         this->accessRightState.setWritePermit();
     }
 
     /*
         * if less than v4.1 then the server will never
         * send access rights and we know that there
         * will always be access and also need to call
         * their call back here
         */
     if ( ! v41Ok ) {
         this->notify().accessRightsNotify (
             guard, this->accessRightState );
     }
 
     // channel uninstal routine grabs the callback lock so
     // a channel will not be deleted while a call back is
     // in progress
     //
     // the callback lock is also taken when a channel
     // disconnects to prevent a race condition with the
     // code below - ie we hold the callback lock here
     // so a chanel cant be destroyed out from under us.
     this->notify().connectNotify ( guard );
 }

void nciu::connect	(	epicsGuard< epicsMutex > &	cbGuard,
		epicsGuard< epicsMutex > &	guard
	)

inline

Definition at line 304 of file nciu.h.

 {
     this->connect ( this->typeCode, this->count,
         this->sid, cbGuard, guard );
 }

bool nciu::connected ( epicsGuard< epicsMutex > & guard ) const

virtual

Reimplemented from cacChannel.

Definition at line 466 of file nciu.cpp.

 {
     guard.assertIdenticalMutex ( this->cacCtx.mutexRef () );
     return this->channelNode::isConnected ( guard );
 }

void nciu::disconnectAllIO	(	epicsGuard< epicsMutex > &	cbGuard,
		epicsGuard< epicsMutex > &	guard
	)

Definition at line 558 of file nciu.cpp.

 {
     this->cacCtx.disconnectAllIO ( cbGuard, guard,
         *this, this->eventq );
 }

nciu::epicsPlacementDeleteOperator ( (void *, tsFreeList< class nciu, 1024, epicsMutexNOOP > &) )

ca_uint32_t nciu::getCID ( epicsGuard< epicsMutex > & ) const

inline

Definition at line 297 of file nciu.h.

 {
     return this->id;
 }

cac & nciu::getClient ( )

inline

Definition at line 343 of file nciu.h.

 {
     return this->cacCtx;
 }

const netiiu * nciu::getConstPIIU ( epicsGuard< epicsMutex > & ) const

inline

Definition at line 337 of file nciu.h.

 {
     return this->piiu;
 }

unsigned nciu::getcount ( ) const

inline

Definition at line 200 of file nciu.h.

200 { return count; }

event_handler_args::count

long count

Definition: cadef.h:88

unsigned nciu::getHostName	(	epicsGuard< epicsMutex > &	guard,
		char *	pBuf,
		unsigned	bufLen
	)		const
throw	(
	)

virtual

Reimplemented from cacChannel.

Definition at line 398 of file nciu.cpp.

 {
     return this->piiu->getHostName (
         guard, pBuf, bufLength );
 }

unsigned nciu::getName	(	epicsGuard< epicsMutex > &	,
		char *	pBuf,
		unsigned	bufLen
	)		const
throw	(
	)

virtual

Implements cacChannel.

Definition at line 233 of file nciu.cpp.

 {
     if ( bufLen == 0u ) {
         return 0u;
     }
     if ( this->nameLength < bufLen ) {
         strcpy ( pBuf, this->pNameStr );
         return this->nameLength;
     }
     else {
         unsigned reducedSize = bufLen - 1u;
         strncpy ( pBuf, this->pNameStr, bufLen );
         pBuf[reducedSize] = '\0';
         return reducedSize;
     }
 }

netiiu * nciu::getPIIU ( epicsGuard< epicsMutex > & )

inline

Definition at line 321 of file nciu.h.

 {
     return this->piiu;
 }

cacChannel::priLev nciu::getPriority ( epicsGuard< epicsMutex > & ) const

inline

Definition at line 348 of file nciu.h.

 {
     return this->priority;
 }

ca_uint32_t nciu::getSID ( epicsGuard< epicsMutex > & ) const

inline

Definition at line 291 of file nciu.h.

 {
     return this->sid;
 }

unsigned nciu::nameLen ( epicsGuard< epicsMutex > & guard ) const

Definition at line 252 of file nciu.cpp.

 {
     guard.assertIdenticalMutex ( this->cacCtx.mutexRef () );
     return this->nameLength;
 }

void * nciu::operator new	(	size_t	size,
		tsFreeList< class nciu, 1024, epicsMutexNOOP > &	freeList
	)

inline

Definition at line 277 of file nciu.h.

 {
     return freeList.allocate ( size );
 }

const char * nciu::pName	(	epicsGuard< epicsMutex > &	guard	)	const
throw	(
	)

virtual

Implements cacChannel.

Definition at line 226 of file nciu.cpp.

 {
     guard.assertIdenticalMutex ( this->cacCtx.mutexRef () );
     return this->pNameStr;
 }

bool nciu::searchMsg ( epicsGuard< epicsMutex > & guard )

Definition at line 214 of file nciu.cpp.

 {
    bool success = this->piiu->searchMsg (
         guard, this->getId (), this->pNameStr, this->nameLength );
    if ( success ) {
         if ( this->retry < UINT_MAX ) {
             this->retry++;
         }
    }
    return success;
 }

void nciu::searchReplySetUp	(	netiiu &	iiu,
		unsigned	sidIn,
		ca_uint16_t	typeIn,
		arrayElementCount	countIn,
		epicsGuard< epicsMutex > &
	)

inline

Definition at line 311 of file nciu.h.

 {
     this->piiu = & iiu;
     this->typeCode = typeIn;
     this->count = countIn;
     this->sid = sidIn;
 }

void nciu::sendSubscriptionUpdateRequests ( epicsGuard< epicsMutex > & guard )

Definition at line 539 of file nciu.cpp.

 {
     guard.assertIdenticalMutex ( this->cacCtx.mutexRef () );
     tsDLIter < baseNMIU > pNetIO = this->eventq.firstIter ();
     while ( pNetIO.valid () ) {
         tsDLIter < baseNMIU > next = pNetIO;
         next++;
         try {
             pNetIO->forceSubscriptionUpdate ( guard, *this );
         }
         catch ( ... ) {
             errlogPrintf (
                 "CAC: failed to send subscription update request "
                 "during channel connect\n" );
         }
         pNetIO = next;
     }
 }

void nciu::serviceShutdownNotify	(	epicsGuard< epicsMutex > &	callbackControlGuard,
		epicsGuard< epicsMutex > &	mutualExclusionGuard
	)

Definition at line 566 of file nciu.cpp.

 {
     this->setServerAddressUnknown ( noopIIU, mutualExclusionGuard );
     this->notify().serviceShutdownNotify ( mutualExclusionGuard );
 }

void nciu::setServerAddressUnknown	(	netiiu &	newiiu,
		epicsGuard< epicsMutex > &	guard
	)

Definition at line 183 of file nciu.cpp.

 {
     guard.assertIdenticalMutex ( this->cacCtx.mutexRef () );
     this->piiu = & newiiu;
     this->retry = 0;
     this->typeCode = USHRT_MAX;
     this->count = 0u;
     this->sid = UINT_MAX;
     this->accessRightState.clrReadPermit();
     this->accessRightState.clrWritePermit();
 }

void nciu::show ( unsigned level ) const

Definition at line 472 of file nciu.cpp.

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

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

virtual

Implements cacChannel.

Definition at line 478 of file nciu.cpp.

 {
     if ( this->connected ( guard ) ) {
         char hostNameTmp [256];
         this->getHostName ( guard, hostNameTmp, sizeof ( hostNameTmp ) );
         ::printf ( "Channel \"%s\", connected to server %s",
             this->pNameStr, hostNameTmp );
         if ( level > 1u ) {
             int tmpTypeCode = static_cast < int > ( this->typeCode );
             ::printf ( ", native type %s, native element count %u",
                 dbf_type_to_text ( tmpTypeCode ), this->count );
             ::printf ( ", %sread access, %swrite access",
                 this->accessRightState.readPermit() ? "" : "no ",
                 this->accessRightState.writePermit() ? "" : "no ");
         }
         ::printf ( "\n" );
     }
     else {
         ::printf ( "Channel \"%s\" is disconnected\n", this->pNameStr );
     }
 
     if ( level > 2u ) {
         ::printf ( "\tnetwork IO pointer = %p\n",
             static_cast <void *> ( this->piiu ) );
         ::printf ( "\tserver identifier %u\n", this->sid );
         ::printf ( "\tsearch retry number=%u\n", this->retry );
         ::printf ( "\tname length=%u\n", this->nameLength );
     }
 }

void nciu::unresponsiveCircuitNotify	(	epicsGuard< epicsMutex > &	cbGuard,
		epicsGuard< epicsMutex > &	guard
	)

Definition at line 160 of file nciu.cpp.

 {
     ioid tmpId = this->getId ();
     cac & caRefTmp = this->cacCtx;
     guard.assertIdenticalMutex ( this->cacCtx.mutexRef () );
     this->cacCtx.disconnectAllIO ( cbGuard, guard,
         *this, this->eventq );
     this->notify().disconnectNotify ( guard );
     // if they destroy the channel in their disconnect
     // handler then we have to be very careful to not
     // touch this object if it has been destroyed
     nciu * pChan = caRefTmp.lookupChannel ( guard, tmpId );
     if ( pChan ) {
         caAccessRights noRights;
         pChan->notify().accessRightsNotify ( guard, noRights );
         // likewise, they might destroy the channel in their access rights
         // handler so we have to be very careful to not touch this
         // object from here on down
     }
 }

void nciu::writeException	(	epicsGuard< epicsMutex > &	,
		epicsGuard< epicsMutex > &	guard,
		int	status,
		const char *	pContext,
		unsigned	type,
		arrayElementCount	count
	)

inline

Definition at line 327 of file nciu.h.

 {
     this->notify().writeException ( guard,
         status, pContext, typeIn, countIn );
 }

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

modules/ca/src/client/nciu.h
modules/ca/src/client/nciu.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation