tcpRecvWatchdog Class Reference

#include "tcpRecvWatchdog.h"

Inheritance diagram for tcpRecvWatchdog:

Collaboration diagram for tcpRecvWatchdog:

Public Member Functions
	tcpRecvWatchdog (epicsMutex &cbMutex, cacContextNotify &ctxNotify, epicsMutex &mutex, tcpiiu &, double periodIn, epicsTimerQueue &)
virtual	~tcpRecvWatchdog ()
void	sendBacklogProgressNotify (epicsGuard< epicsMutex > &)
void	messageArrivalNotify (epicsGuard< epicsMutex > &guard)
void	probeResponseNotify (epicsGuard< epicsMutex > &)
void	beaconArrivalNotify (epicsGuard< epicsMutex > &)
void	beaconAnomalyNotify (epicsGuard< epicsMutex > &)
void	connectNotify (epicsGuard< epicsMutex > &)
void	sendTimeoutNotify (epicsGuard< epicsMutex > &cbGuard, epicsGuard< epicsMutex > &guard)
void	cancel ()
void	shutdown ()
void	show (unsigned level) const
double	delay () const

Detailed Description

Definition at line 34 of file tcpRecvWatchdog.h.

Constructor & Destructor Documentation

tcpRecvWatchdog::tcpRecvWatchdog	(	epicsMutex &	cbMutex,
		cacContextNotify &	ctxNotify,
		epicsMutex &	mutex,
		tcpiiu &	iiuIn,
		double	periodIn,
		epicsTimerQueue &	queueIn
	)

Definition at line 30 of file tcpRecvWatchdog.cpp.

                                                         :
        period ( periodIn ), timer ( queueIn.createTimer () ),
        cbMutex ( cbMutexIn ), ctxNotify ( ctxNotifyIn ),
        mutex ( mutexIn ), iiu ( iiuIn ),
        probeResponsePending ( false ), beaconAnomaly ( true ),
        probeTimeoutDetected ( false ), shuttingDown ( false )
{
}

tcpRecvWatchdog::~tcpRecvWatchdog ( )

virtual

Definition at line 41 of file tcpRecvWatchdog.cpp.

{
    this->timer.destroy ();
}

Member Function Documentation

void tcpRecvWatchdog::beaconAnomalyNotify

(

epicsGuard< epicsMutex > &

guard

)

Definition at line 110 of file tcpRecvWatchdog.cpp.

{
    guard.assertIdenticalMutex ( this->mutex );
    this->beaconAnomaly = true;
    debugPrintf ( ("Saw an abnormal beacon\n") );
}

void tcpRecvWatchdog::beaconArrivalNotify

(

epicsGuard< epicsMutex > &

guard

)

Definition at line 93 of file tcpRecvWatchdog.cpp.

{
    guard.assertIdenticalMutex ( this->mutex );
    if ( ! ( this->shuttingDown || this->beaconAnomaly || this->probeResponsePending ) ) {
        this->timer.start ( *this, this->period );
        debugPrintf ( ("saw a normal beacon - reseting circuit receive watchdog\n") );
    }
}

void tcpRecvWatchdog::cancel

(

)

Definition at line 216 of file tcpRecvWatchdog.cpp.

{
    this->timer.cancel ();
    debugPrintf ( ("canceling TCP recv watchdog\n") );
}

void tcpRecvWatchdog::connectNotify

(

epicsGuard< epicsMutex > &

guard

)

Definition at line 188 of file tcpRecvWatchdog.cpp.

{
    guard.assertIdenticalMutex ( this->mutex );
    if ( this->shuttingDown ) {
        return;
    }
    this->timer.start ( *this, this->period );
    debugPrintf ( ("connected to the server - initiating circuit recv watchdog\n") );
}

double tcpRecvWatchdog::delay

(

)

const

Definition at line 232 of file tcpRecvWatchdog.cpp.

{
    return this->timer.getExpireDelay ();
}

void tcpRecvWatchdog::messageArrivalNotify

(

epicsGuard< epicsMutex > &

guard

)

Definition at line 118 of file tcpRecvWatchdog.cpp.

{
    guard.assertIdenticalMutex ( this->mutex );

    if ( ! ( this->shuttingDown || this->probeResponsePending ) ) {
        this->beaconAnomaly = false;
        this->timer.start ( *this, this->period );
        debugPrintf ( ("received a message - reseting circuit recv watchdog\n") );
    }
}

void tcpRecvWatchdog::probeResponseNotify

(

epicsGuard< epicsMutex > &

cbGuard

)

Definition at line 130 of file tcpRecvWatchdog.cpp.

{
    bool restartNeeded = false;
    double restartDelay = DBL_MAX;
    {
        epicsGuard < epicsMutex > guard ( this->mutex );
        if ( this->probeResponsePending && ! this->shuttingDown ) {
            restartNeeded = true;
            if ( this->probeTimeoutDetected ) {
                this->probeTimeoutDetected = false;
                this->probeResponsePending = this->iiu.setEchoRequestPending ( guard );
                restartDelay = CA_ECHO_TIMEOUT;
                debugPrintf ( ("late probe response - sending another probe request\n") );
            }
            else {
                this->probeResponsePending = false;
                restartDelay = this->period;
                this->iiu.responsiveCircuitNotify ( cbGuard, guard );
                debugPrintf ( ("probe response on time - circuit was tagged reponsive if unresponsive\n") );
            }
        }
    }
    if ( restartNeeded ) {
        this->timer.start ( *this, restartDelay );
        debugPrintf ( ("recv wd restarted with delay %f\n", restartDelay) );
    }
}

void tcpRecvWatchdog::sendBacklogProgressNotify

(

epicsGuard< epicsMutex > &

guard

)

Definition at line 173 of file tcpRecvWatchdog.cpp.

{
    guard.assertIdenticalMutex ( this->mutex );

    // We dont set "beaconAnomaly" to be false here because, after we see a
    // beacon anomaly (which could be transiently detecting a reboot) we will
    // not trust the beacon as an indicator of a healthy server until we
    // receive at least one message from the server.
    if ( this->probeResponsePending && ! this->shuttingDown ) {
        this->timer.start ( *this, CA_ECHO_TIMEOUT );
        debugPrintf ( ("saw heavy send backlog - reseting circuit recv watchdog\n") );
    }
}

void tcpRecvWatchdog::sendTimeoutNotify	(	epicsGuard< epicsMutex > &	cbGuard,
		epicsGuard< epicsMutex > &	guard
	)

Definition at line 199 of file tcpRecvWatchdog.cpp.

{
    guard.assertIdenticalMutex ( this->mutex );

    bool restartNeeded = false;
    if ( ! ( this->probeResponsePending || this->shuttingDown ) ) {
        this->probeResponsePending = this->iiu.setEchoRequestPending ( guard );
        restartNeeded = true;
    }
    if ( restartNeeded ) {
        this->timer.start ( *this, CA_ECHO_TIMEOUT );
    }
    debugPrintf ( ("TCP send timed out - sending echo request\n") );
}

void tcpRecvWatchdog::show

(

unsigned

level

)

const

Definition at line 237 of file tcpRecvWatchdog.cpp.

{
    epicsGuard < epicsMutex > guard ( this->mutex );

    ::printf ( "Receive virtual circuit watchdog at %p, period %f\n",
        static_cast <const void *> ( this ), this->period );
    if ( level > 0u ) {
        ::printf ( "\t%s %s %s\n",
            this->probeResponsePending ? "probe-response-pending" : "",
            this->beaconAnomaly ? "beacon-anomaly-detected" : "",
            this->probeTimeoutDetected ? "probe-response-timeout" : "" );
    }
}

void tcpRecvWatchdog::shutdown

(

)

Definition at line 222 of file tcpRecvWatchdog.cpp.

{
    {
        epicsGuard < epicsMutex > guard ( this->mutex );
        this->shuttingDown = true;
    }
    this->timer.cancel ();
    debugPrintf ( ("canceling TCP recv watchdog\n") );
}

---

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

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