1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
|
//
// System.Timers.Timer
//
// Authors:
// Gonzalo Paniagua Javier (gonzalo@ximian.com)
//
// (C) 2002 Ximian, Inc (http://www.ximian.com)
// Copyright (C) 2005 Novell, Inc (http://www.novell.com)
//
// The docs talk about server timers and such...
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
using System.ComponentModel;
using System.Threading;
namespace System.Timers
{
[DefaultEventAttribute("Elapsed")]
[DefaultProperty("Interval")]
public class Timer : Component, ISupportInitialize {
double interval;
bool autoReset;
System.Threading.Timer timer;
object _lock = new object ();
ISynchronizeInvoke so;
bool enabled;
[Category("Behavior")]
[TimersDescription("Occurs when the Interval has elapsed.")]
public event ElapsedEventHandler Elapsed;
public Timer () : this (100)
{
}
public Timer (double interval)
{
// MSBUG: https://connect.microsoft.com/VisualStudio/feedback/ViewFeedback.aspx?FeedbackID=296761
if (interval <= 0 || interval > 0x7FFFFFFF)
throw new ArgumentException ("Invalid value: " + interval, "interval");
autoReset = true;
timer = new System.Threading.Timer (Callback, this, Timeout.Infinite, Timeout.Infinite); //disabled
Interval = interval;
}
[Category("Behavior")]
[DefaultValue(true)]
[TimersDescription("Indicates whether the timer will be restarted when it is enabled.")]
public bool AutoReset
{
get { return autoReset; }
set { autoReset = value; }
}
[Category("Behavior")]
[DefaultValue(false)]
[TimersDescription("Indicates whether the timer is enabled to fire events at a defined interval.")]
public bool Enabled
{
get {
lock (_lock)
return enabled && timer != null;
}
set {
lock (_lock) {
if (timer == null)
throw new ObjectDisposedException (GetType ().ToString (), "The object has been disposed");
if (enabled == value)
return;
if (value) {
// As per MS docs (throw this only when the timer becomes enabled): http://msdn.microsoft.com/en-us/library/system.timers.timer.enabled(v=vs.110).aspx
if (interval > Int32.MaxValue)
throw new ArgumentException ("Invalid value: " + interval, "interval");
enabled = true;
timer.Change ((int)interval, autoReset ? (int)interval : 0);
} else {
enabled = false;
timer.Change (Timeout.Infinite, Timeout.Infinite);
}
}
}
}
[Category("Behavior")]
[DefaultValue(100)]
[RecommendedAsConfigurable(true)]
[TimersDescription( "The number of milliseconds between timer events.")]
public double Interval
{
get { return interval; }
set {
// The doc says 'less than 0', but 0 also throws the exception
if (value <= 0)
throw new ArgumentException ("Invalid value: " + value);
// As per MS docs (throw only if enabled, otherwise postpone throwing until it becomes enabled): http://msdn.microsoft.com/en-us/library/system.timers.timer.interval(v=vs.110).aspx
if (value > Int32.MaxValue && enabled)
throw new ArgumentException ("Invalid value: " + value);
lock (_lock) {
if (timer == null)
return;
interval = value;
//call Change only if enabled, otherwise it will be called when Enabled = true, see the comment above on throwing ArgumentException
if (enabled)
timer.Change ((int)interval, autoReset? (int)interval: 0);
}
}
}
public override ISite Site
{
get { return base.Site; }
set { base.Site = value; }
}
[DefaultValue(null)]
[TimersDescriptionAttribute("The object used to marshal the event handler calls issued " +
"when an interval has elapsed.")]
[Browsable (false)]
public ISynchronizeInvoke SynchronizingObject
{
get { return so; }
set { so = value; }
}
public void BeginInit ()
{
// Nothing to do
}
public void Close ()
{
lock (_lock)
Dispose (true);
}
public void EndInit ()
{
// Nothing to do
}
public void Start ()
{
Enabled = true;
}
public void Stop ()
{
Enabled = false;
}
protected override void Dispose (bool disposing)
{
// Could call Close() twice
if (timer == null)
return;
// If we're disposing explicitly, clear all
// fields. If not, all fields will have been
// nulled by the GC during finalization, so
// trying to lock on _lock will blow up.
if (disposing)
{
timer.Dispose ();
timer = null;
}
base.Dispose (disposing);
}
static void Callback (object state)
{
Timer timer = (Timer) state;
if (timer.Enabled == false)
return;
ElapsedEventHandler events = timer.Elapsed;
try
{
if (!timer.autoReset)
timer.Enabled = false; //this could throw ObjectDisposed if timer.Close() was just called, after the check for Enabled above
}
catch (ObjectDisposedException) {
//Probably the Elapsed event should not fire if this Timer is found here to be closed
return;
}
//If another thread calls Close() when this thread is right here (of further down), the Elapsed event might get called once more after this Timer was Closed()
//It's not a problem, it happens with all Timers, but it's good to know...
if (events == null)
return;
ElapsedEventArgs arg = new ElapsedEventArgs (DateTime.Now);
if (timer.so != null && timer.so.InvokeRequired) {
timer.so.BeginInvoke (events, new object [2] {timer, arg});
} else {
try {
events (timer, arg);
} catch {
}
}
}
}
}
|