/* 
    P/P   *  Method: com.dmdirc.parser.irc.PingTimer__static_init
          */
     1  /*
     2   * Copyright (c) 2006-2009 Chris Smith, Shane Mc Cormack, Gregory Holmes
     3   *
     4   * Permission is hereby granted, free of charge, to any person obtaining a copy
     5   * of this software and associated documentation files (the "Software"), to deal
     6   * in the Software without restriction, including without limitation the rights
     7   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     8   * copies of the Software, and to permit persons to whom the Software is
     9   * furnished to do so, subject to the following conditions:
    10   *
    11   * The above copyright notice and this permission notice shall be included in
    12   * all copies or substantial portions of the Software.
    13   *
    14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    20   * SOFTWARE.
    21   */
    22  
    23  package com.dmdirc.parser.irc;
    24  
    25  import java.util.TimerTask;
    26  import java.util.Timer;
    27  
    28  /**
    29   * Used by the parser to ping the server at a set interval to check that the
    30   * server is still alive.
    31   *
    32   * @author Shane Mc Cormack
    33   */
    34  public class PingTimer extends TimerTask {
    35  	/** Owning Parser. */
    36  	final IRCParser myOwner;
    37  	/** The Timer that owns this task */
    38  	final Timer myTimer;
    39  	
    40  	/**
    41  	 * Create the PingTimer.
    42  	 *
    43  	 * @param control IRCParser that owns this TimerTask.
    44  	 * @param timer Timer that owns this TimerTask.
    45  	 */
        	 /* 
    P/P 	  *  Method: void com.dmdirc.parser.irc.PingTimer(IRCParser, Timer)
        	  * 
        	  *  Postconditions:
        	  *    this.myOwner == control
        	  *    init'ed(this.myOwner)
        	  *    this.myTimer == timer
        	  *    init'ed(this.myTimer)
        	  */
    46  	public PingTimer(final IRCParser control, final Timer timer) {
    47  		myOwner = control;
    48  		myTimer = timer;
    49  	}
    50  	
    51  	/** Timer has been executed. */
    52  	public void run() {
        		 /* 
    P/P 		  *  Method: void run()
        		  * 
        		  *  Preconditions:
        		  *    this.myOwner != null
        		  *    this.myOwner.pingNeeded != null
        		  *    (soft) this.myOwner.cMyself != null
        		  *    (soft) init'ed(this.myOwner.currentSocketState)
        		  *    (soft) this.myOwner.pingCountDown >= -231+1
        		  *    (soft) init'ed(this.myOwner.pingTimer)
        		  *    (soft) init'ed(this.myOwner.stringConverter)
        		  *    (soft) this.myOwner.hChanModesOther != null
        		  *    (soft) this.myOwner.hChannelList != null
        		  *    (soft) this.myOwner.myCallbackManager != null
        		  *    ...
        		  * 
        		  *  Postconditions:
        		  *    init'ed(java.lang.String:substring(...)._tainted)
        		  *    java.lang.String:valueOf(...)._tainted == 0
        		  *    this.myOwner.cMyself == old this.myOwner.cMyself
        		  *    this.myOwner.cMyself != null
        		  *    possibly_updated(this.myOwner.cMyself.myAwayReason)
        		  *    this.myOwner.currentSocketState == old this.myOwner.currentSocketState
        		  *    init'ed(this.myOwner.currentSocketState)
        		  *    this.myOwner.got001 == old this.myOwner.got001
        		  *    this.myOwner.lastLine == old this.myOwner.lastLine
        		  *    this.myOwner.lastPingValue == One-of{old this.myOwner.lastPingValue, &java.lang.String:valueOf(...)}
        		  *    ...
        		  */
    53  		myOwner.pingTimerTask(myTimer);
    54  	}
    55  }