001: /*
002: * @(#) TimerEvent.java
003: *
004: * JOTM: Java Open Transaction Manager
005: *
006: *
007: * This module was originally developed by
008: *
009: * - Bull S.A. as part of the JOnAS application server code released in
010: * July 1999 (www.bull.com)
011: *
012: * --------------------------------------------------------------------------
013: * The original code and portions created by Bull SA are
014: * Copyright (c) 1999 BULL SA
015: * All rights reserved.
016: *
017: * Redistribution and use in source and binary forms, with or without
018: * modification, are permitted provided that the following conditions are met:
019: *
020: * -Redistributions of source code must retain the above copyright notice, this
021: * list of conditions and the following disclaimer.
022: *
023: * -Redistributions in binary form must reproduce the above copyright notice,
024: * this list of conditions and the following disclaimer in the documentation
025: * and/or other materials provided with the distribution.
026: *
027: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
028: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
029: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
030: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
031: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
032: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
033: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
034: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
035: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
036: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
037: * POSSIBILITY OF SUCH DAMAGE.
038: *
039: * --------------------------------------------------------------------------
040: * $Id: TimerEvent.java,v 1.2 2005/03/15 00:05:38 tonyortiz Exp $
041: * --------------------------------------------------------------------------
042: */
043: package org.objectweb.jotm;
044:
045: public class TimerEvent {
046:
047: private TimerEventListener listener = null;
048: private Object arg = null;
049: private long reminding = 0;
050: private long startvalue;
051: private boolean permanent = false;
052: private boolean stopped = false;
053:
054: /**
055: * Constructor
056: * @param l Object that will be notified when the timer expire.
057: * @param timeout nb of seconds before the timer expires.
058: * @param a info passed with the timer
059: * @param p true if the timer is permanent.
060: */
061: public TimerEvent(TimerEventListener l, long timeout, Object a,
062: boolean p) {
063: if (TraceTm.jta.isDebugEnabled()) {
064: TraceTm.jta.debug("TimerEvent.new(" + l + "," + timeout
065: + "," + a + "," + p + ")");
066: }
067:
068: listener = l;
069: reminding = timeout;
070: startvalue = timeout;
071: arg = a;
072: permanent = p;
073: }
074:
075: /**
076: * Update timer every second. Used by clock.
077: * - this must be called with the timerList monitor.
078: */
079: public long update() {
080: return --reminding;
081: }
082:
083: /**
084: * Restart timer to its initial value
085: */
086: public void restart() {
087: if (TraceTm.jta.isDebugEnabled()) {
088: TraceTm.jta.debug("TimerEvent.new(" + listener
089: + ").restart");
090: }
091:
092: stopped = false;
093: reminding = startvalue;
094: }
095:
096: /**
097: * Process the Timer
098: */
099: public void process() {
100: if (listener != null) {
101: if (TraceTm.jta.isDebugEnabled()) {
102: TraceTm.jta.debug("TimerEvent.new(" + listener
103: + ".process");
104: }
105:
106: listener.timeoutExpired(arg);
107: }
108: }
109:
110: public void change(long timeout, Object a) {
111: if (TraceTm.jta.isDebugEnabled()) {
112: TraceTm.jta.debug("TimerEvent(" + listener + ").change("
113: + timeout + "," + a + ")");
114: }
115:
116: stopped = false;
117: startvalue = timeout;
118: reminding = startvalue;
119: arg = a;
120: }
121:
122: /**
123: * Unvalidate the timer. It will be removed by the timer manager.
124: */
125: public void unset() {
126: if (TraceTm.jta.isDebugEnabled()) {
127: TraceTm.jta.debug("TimerEvent(" + listener + ").unset");
128: }
129:
130: // the timerlist is not locked.
131: reminding = 1;
132: arg = null;
133: listener = null;
134: permanent = false;
135: stopped = false;
136: }
137:
138: /**
139: * stop the timer, but keep it for further reuse (See change())
140: */
141: public void stop() {
142: if (TraceTm.jta.isDebugEnabled()) {
143: TraceTm.jta.debug("TimerEvent(" + listener + ").stop");
144: }
145:
146: // the timerlist is not locked.
147: reminding = 1000000;
148: stopped = true;
149: }
150:
151: /**
152: * Is this timer valid ?
153: */
154: public boolean valid() {
155: return (listener != null);
156: }
157:
158: /**
159: * Is this timer permanent ?
160: */
161: public boolean ispermanent() {
162: return permanent;
163: }
164:
165: /**
166: * Is this timer stopped ?
167: */
168: public boolean isStopped() {
169: return stopped;
170: }
171: }
|