de.ipcon.db.protocol

Class TransportWatchdog

java.lang.Object

de.ipcon.db.protocol.TransportWatchdog

All Implemented Interfaces:

java.lang.Runnable

public class TransportWatchdog
extends java.lang.Object
implements java.lang.Runnable

A watchdog that monitors the outgoing channel of a given TransportI for network activity. The watchdog periodically checks for activity and will close the transport if no activity is detected within the specified time frame, unless the watchdog is explicitly stopped.

Constructor Summary

Constructors

Constructor and Description
TransportWatchdog(TransportI _transport, java.lang.String _title) Creates a new TransportWatchdog for the given TransportI, using the default timeout.
TransportWatchdog(TransportI _transport, java.lang.String _title, long _timeoutInMillis) Creates a new TransportWatchdog for the given TransportI with a specified timeout.

Method Summary

Modifier and Type	Method and Description
void	run() The TimerTask's run method, executed if the watchdog's timer has not been cancelled.
void	stop() Cancels this watchdog by cancelling its timer.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransportWatchdog

public TransportWatchdog(TransportI _transport,
                         java.lang.String _title)

Creates a new TransportWatchdog for the given TransportI, using the default timeout. The transport will be closed after DEFAULT_TIMEOUT_MILLISECS milliseconds unless the watchdog is cancelled. The timer is named using the provided title (if any) as a suffix and is scheduled upon construction.

Parameters:

_transport - The TransportI to monitor.

_title - A suffix for the timer's name (optional).

TransportWatchdog

public TransportWatchdog(TransportI _transport,
                         java.lang.String _title,
                         long _timeoutInMillis)

Creates a new TransportWatchdog for the given TransportI with a specified timeout. The transport will be closed after the specified timeout (in milliseconds) unless the watchdog is cancelled. The timer is named using the provided title (if any) as a suffix and is scheduled upon construction.

Parameters:

_transport - The TransportI to monitor.

_title - A suffix for the timer's name (optional).

_timeoutInMillis - The timeout in milliseconds before closing the TransportI.

Method Detail

stop

public void stop()

Cancels this watchdog by cancelling its timer.

run

public void run()

The TimerTask's run method, executed if the watchdog's timer has not been cancelled. This method checks for network activity since the timer started. If activity is detected, the timer is rescheduled with a delay representing the remaining time until the original timeout (considering the last activity time), or with the full original timeout if the calculated delta exceeds the original timeout. If no network activity occurred, the transport is closed due to inactivity.

Specified by:

run in interface java.lang.Runnable