Timer Класс

Определение

Создает событие после заданного интервала с возможностью создания повторяющихся событий.Generates an event after a set interval, with an option to generate recurring events.

public ref class Timer : System::ComponentModel::Component, System::ComponentModel::ISupportInitialize
public class Timer : System.ComponentModel.Component, System.ComponentModel.ISupportInitialize
type Timer = class
    inherit Component
    interface ISupportInitialize
Public Class Timer
Inherits Component
Implements ISupportInitialize
Наследование
Реализации

Примеры

В следующем примере создается экземпляр объекта System.Timers.Timer, который запускает событие Timer.Elapsed каждые две секунды (2 000 миллисекунд), настраивает обработчик событий для события и запускает таймер.The following example instantiates a System.Timers.Timer object that fires its Timer.Elapsed event every two seconds (2,000 milliseconds), sets up an event handler for the event, and starts the timer. Обработчик событий отображает значение свойства ElapsedEventArgs.SignalTime при каждом его возникновении.The event handler displays the value of the ElapsedEventArgs.SignalTime property each time it is raised.

using System;
using System.Timers;

public class Example
{
   private static System.Timers.Timer aTimer;
   
   public static void Main()
   {
      SetTimer();

      Console.WriteLine("\nPress the Enter key to exit the application...\n");
      Console.WriteLine("The application started at {0:HH:mm:ss.fff}", DateTime.Now);
      Console.ReadLine();
      aTimer.Stop();
      aTimer.Dispose();
      
      Console.WriteLine("Terminating the application...");
   }

   private static void SetTimer()
   {
        // Create a timer with a two second interval.
        aTimer = new System.Timers.Timer(2000);
        // Hook up the Elapsed event for the timer. 
        aTimer.Elapsed += OnTimedEvent;
        aTimer.AutoReset = true;
        aTimer.Enabled = true;
    }

    private static void OnTimedEvent(Object source, ElapsedEventArgs e)
    {
        Console.WriteLine("The Elapsed event was raised at {0:HH:mm:ss.fff}",
                          e.SignalTime);
    }
}
// The example displays output like the following:
//       Press the Enter key to exit the application...
//
//       The application started at 09:40:29.068
//       The Elapsed event was raised at 09:40:31.084
//       The Elapsed event was raised at 09:40:33.100
//       The Elapsed event was raised at 09:40:35.100
//       The Elapsed event was raised at 09:40:37.116
//       The Elapsed event was raised at 09:40:39.116
//       The Elapsed event was raised at 09:40:41.117
//       The Elapsed event was raised at 09:40:43.132
//       The Elapsed event was raised at 09:40:45.133
//       The Elapsed event was raised at 09:40:47.148
//
//       Terminating the application...
Imports System.Timers

Public Module Example
    Private aTimer As System.Timers.Timer

    Public Sub Main()
        SetTimer()

      Console.WriteLine("{0}Press the Enter key to exit the application...{0}",
                        vbCrLf)
      Console.WriteLine("The application started at {0:HH:mm:ss.fff}",
                        DateTime.Now)
      Console.ReadLine()
      aTimer.Stop()
      aTimer.Dispose()

      Console.WriteLine("Terminating the application...")
    End Sub

    Private Sub SetTimer()
        ' Create a timer with a two second interval.
        aTimer = New System.Timers.Timer(2000)
        ' Hook up the Elapsed event for the timer. 
        AddHandler aTimer.Elapsed, AddressOf OnTimedEvent
        aTimer.AutoReset = True
        aTimer.Enabled = True
    End Sub

    ' The event handler for the Timer.Elapsed event. 
    Private Sub OnTimedEvent(source As Object, e As ElapsedEventArgs)
        Console.WriteLine("The Elapsed event was raised at {0:HH:mm:ss.fff}",
                          e.SignalTime)
    End Sub 
End Module
' The example displays output like the following:
'       Press the Enter key to exit the application...
'
'       The application started at 09:40:29.068
'       The Elapsed event was raised at 09:40:31.084
'       The Elapsed event was raised at 09:40:33.100
'       The Elapsed event was raised at 09:40:35.100
'       The Elapsed event was raised at 09:40:37.116
'       The Elapsed event was raised at 09:40:39.116
'       The Elapsed event was raised at 09:40:41.117
'       The Elapsed event was raised at 09:40:43.132
'       The Elapsed event was raised at 09:40:45.133
'       The Elapsed event was raised at 09:40:47.148
'
'       Terminating the application...

Комментарии

Компонент Timer является таймером на основе сервера, который вызывает событие Elapsed в приложении после истечения времени ожидания в свойстве Interval.The Timer component is a server-based timer that raises an Elapsed event in your application after the number of milliseconds in the Interval property has elapsed. Можно настроить объект Timer для вызова события только один раз или многократно с помощью свойства AutoReset.You can configure the Timer object to raise the event just once or repeatedly using the AutoReset property. Как правило, объект Timer объявляется на уровне класса, чтобы он оставался в области, пока он необходим.Typically, a Timer object is declared at the class level so that it stays in scope as long as it is needed. Затем можно обработать событие Elapsed, чтобы обеспечить нормальную обработку.You can then handle its Elapsed event to provide regular processing. Например, предположим, что имеется важный сервер, который должен храниться 24 часа в день, 7 дней в неделю.For example, suppose you have a critical server that must be kept running 24 hours a day, 7 days a week. Можно создать службу, которая использует объект Timer для периодической проверки сервера и обеспечения работоспособности системы.You could create a service that uses a Timer object to periodically check the server and ensure that the system is up and running. Если система не отвечает, служба может попытаться перезапустить сервер или уведомить администратора.If the system is not responding, the service could attempt to restart the server or notify an administrator.

Важно!

Класс Timer недоступен для всех реализаций и версий .NET, например .NET Standard 1,6 и более ранних версий.The Timer class is not available for all .NET implementations and versions, such as .NET Standard 1.6 and lower versions. В этих случаях вместо этого можно использовать класс System.Threading.Timer.In these cases, you can use the System.Threading.Timer class instead.

Этот тип реализует интерфейс IDisposable.This type implements the IDisposable interface. По окончании использования выдаленную ему память следует прямо или косвенно освободить.When you have finished using the type, you should dispose of it either directly or indirectly. Чтобы сделать это прямо, вызовите его метод Dispose в блоке try/catch.To dispose of the type directly, call its Dispose method in a try/catch block. Чтобы сделать это косвенно, используйте языковые конструкции, такие как using (в C#) или Using (в Visual Basic).To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). Дополнительные сведения см. в разделе "Использование объекта, реализующего IDisposable" в статье об интерфейсе IDisposable.For more information, see the "Using an Object that Implements IDisposable" section in the IDisposable interface topic.

Класс System.Timers.Timer на основе сервера предназначен для использования с рабочими потоками в многопоточной среде.The server-based System.Timers.Timer class is designed for use with worker threads in a multithreaded environment. Серверные таймеры могут перемещаться между потоками, чтобы справиться с событием Elapsed, что приводит к большей точности, чем таймеры Windows при возникновении события вовремя.Server timers can move among threads to handle the raised Elapsed event, resulting in more accuracy than Windows timers in raising the event on time.

Компонент System.Timers.Timer вызывает событие Elapsed в зависимости от значения (в миллисекундах) свойства Interval.The System.Timers.Timer component raises the Elapsed event, based on the value (in milliseconds) of the Interval property. Это событие можно обработать для выполнения необходимой обработки.You can handle this event to perform the processing you need. Например, предположим, что у вас есть интерактивное приложение для продаж, которое постоянно отправляет заказы на продажу в базу данных.For example, suppose that you have an online sales application that continuously posts sales orders to a database. Служба, которая компилирует инструкции для доставки, работает с пакетом заказов, вместо того чтобы обрабатывать каждый заказ по отдельности.The service that compiles the instructions for shipping operates on a batch of orders rather than processing each order individually. Можно использовать Timer для запуска пакетной обработки каждые 30 минут.You could use a Timer to start the batch processing every 30 minutes.

Важно!

Класс System. Timers. Timer имеет то же разрешение, что и системные часы.The System.Timers.Timer class has the same resolution as the system clock. Это означает, что событие Elapsed будет срабатывать через интервал, определенный разрешением системных часов, если свойство Interval меньше, чем разрешение системных часов.This means that the Elapsed event will fire at an interval defined by the resolution of the system clock if the Interval property is less than the resolution of the system clock. Дополнительные сведения см. в описании свойства Interval.For more information, see the Interval property.

Если AutoReset имеет значение false, то System.Timers.Timer объект вызывает событие Elapsed только один раз, после истечения первого Interval.When AutoReset is set to false, a System.Timers.Timer object raises the Elapsed event only once, after the first Interval has elapsed. Чтобы регулярно вызывать событие Elapsed с интервалом, определенным в Interval, задайте для AutoReset значение true, которое является значением по умолчанию.To keep raising the Elapsed event regularly at the interval defined by the Interval, set AutoReset to true, which is the default value.

Компонент Timer перехватывает и подавляет все исключения, вызываемые обработчиками событий для события Elapsed.The Timer component catches and suppresses all exceptions thrown by event handlers for the Elapsed event. Это поведение может быть изменено в будущих выпусках .NET Framework.This behavior is subject to change in future releases of the .NET Framework. Однако обратите внимание, что это не относится к обработчикам событий, которые выполняются асинхронно и включают оператор await ( C#в) или оператор Await (в Visual Basic).Note, however, that this is not true of event handlers that execute asynchronously and include the await operator (in C#) or the Await operator (in Visual Basic). Исключения, возникающие в этих обработчиках событий, передаются обратно в вызывающий поток, как показано в следующем примере.Exceptions thrown in these event handlers are propagated back to the calling thread, as the following example illustrates. Дополнительные сведения об исключениях, возникающих в асинхронных методах, см. в разделе обработка исключений.For more information on exceptions thrown in asynchronous methods, see Exception Handling.

using System;
using System.Threading.Tasks;
using System.Timers;

class Example
{
   static void Main()
   {
      Timer timer = new Timer(1000);
      timer.Elapsed += async ( sender, e ) => await HandleTimer();
      timer.Start();
      Console.Write("Press any key to exit... ");
      Console.ReadKey();
   }

   private static Task HandleTimer()
   {
     Console.WriteLine("\nHandler not implemented..." );
     throw new NotImplementedException();
   }
}
// The example displays output like the following:
//   Press any key to exit...
//   Handler not implemented...
//   
//   Unhandled Exception: System.NotImplementedException: The method or operation is not implemented.
//      at Example.HandleTimer()
//      at Example.<<Main>b__0>d__2.MoveNext()
//   --- End of stack trace from previous location where exception was thrown ---
//      at System.Runtime.CompilerServices.AsyncMethodBuilderCore.<>c__DisplayClass2.<ThrowAsync>b__5(Object state)
//      at System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state, Boolean preserveSyncCtx)
//      at System.Threading.ExecutionContext.Run(ExecutionContext executionContext, ContextCallback callback, Object state, Boolean preserveSyncCtx)
//      at System.Threading.QueueUserWorkItemCallback.System.Threading.IThreadPoolWorkItem.ExecuteWorkItem()
//      at System.Threading.ThreadPoolWorkQueue.Dispatch()
Imports System.Threading.Tasks
Imports System.Timers

Public Module Example
   Public Sub Main()
      Dim timer As New Timer(1000)  
      AddHandler timer.Elapsed, AddressOf Example.HandleTimer     
      'timer.Elapsed = Async ( sender, e ) => await HandleTimer()
      timer.Start()
      Console.Write("Press any key to exit... ")
      Console.ReadKey()
   End Sub

   Private Async Sub HandleTimer(sender As Object, e As EventArgs)
      Await Task.Run(Sub()
                        Console.WriteLine()
                        Console.WriteLine("Handler not implemented..." )
                        Throw New NotImplementedException()
                     End Sub)   
   End Sub
End Module
' The example displays output like the following:
'   Press any key to exit...
'   Handler not implemented...
'   
'   Unhandled Exception: System.NotImplementedException: The method or operation is not implemented.
'      at Example._Lambda$__1()
'      at System.Threading.Tasks.Task.Execute()
'   --- End of stack trace from previous location where exception was thrown ---
'      at System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess(Task task)
'      at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
'      at Example.VB$StateMachine_0_HandleTimer.MoveNext()
'   --- End of stack trace from previous location where exception was thrown ---
'      at System.Runtime.CompilerServices.AsyncMethodBuilderCore.<>c__DisplayClass2.<ThrowAsync>b__5(Object state)
'      at System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state, Boolean preserveSyncCtx)
'      at System.Threading.ExecutionContext.Run(ExecutionContext executionContext, ContextCallback callback, Object state, Boolean preserveSyncCtx)
'      at System.Threading.QueueUserWorkItemCallback.System.Threading.IThreadPoolWorkItem.ExecuteWorkItem()
'      at System.Threading.ThreadPoolWorkQueue.Dispatch()

Если свойство SynchronizingObject null, то в ThreadPool потоке возникает событие Elapsed.If the SynchronizingObject property is null, the Elapsed event is raised on a ThreadPool thread. Если обработка события Elapsed длится дольше, чем Interval, событие может возникать снова в другом ThreadPoolом потоке.If processing of the Elapsed event lasts longer than Interval, the event might be raised again on another ThreadPool thread. В этом случае обработчик событий должен быть повторным.In this situation, the event handler should be reentrant.

Примечание

Метод обработки событий может выполняться в одном потоке в то же время, когда другой поток вызывает метод Stop или задает для свойства Enabled значение false.The event-handling method might run on one thread at the same time that another thread calls the Stop method or sets the Enabled property to false. Это может привести к возникновению Elapsed события после остановки таймера.This might result in the Elapsed event being raised after the timer is stopped. В примере кода для метода Stop показан один из способов избежать этого состояния гонки.The example code for the Stop method shows one way to avoid this race condition.

Даже если SynchronizingObject не null, Elapsed события могут возникать после вызова метода Dispose или Stop или после того, как свойство Enabled установлено в false, поскольку сигнал для вызова события Elapsed всегда ставится в очередь для выполнения в потоке пула потоков.Even if SynchronizingObject is not null, Elapsed events can occur after the Dispose or Stop method has been called or after the Enabled property has been set to false, because the signal to raise the Elapsed event is always queued for execution on a thread pool thread. Одним из способов устранения этого состояния гонки является установка флага, сообщающего обработчику событий Elapsed пропускать последующие события.One way to resolve this race condition is to set a flag that tells the event handler for the Elapsed event to ignore subsequent events.

При использовании класса System.Timers.Timer с элементом пользовательского интерфейса, например формой или элементом управления, без помещения таймера в этот элемент пользовательского интерфейса, назначьте форму или элемент управления, содержащий Timer, в свойство SynchronizingObject, чтобы событие было упаковано в поток пользовательского интерфейса.If you use the System.Timers.Timer class with a user interface element, such as a form or control, without placing the timer on that user interface element, assign the form or control that contains the Timer to the SynchronizingObject property, so that the event is marshaled to the user interface thread.

Список значений свойств по умолчанию для экземпляра Timerсм. в разделе Конструктор Timer.For a list of default property values for an instance of Timer, see the Timer constructor.

Совет

Имейте в виду, что в .NET есть четыре класса с именем Timer, каждый из которых предоставляет различные функциональные возможности:Be aware that .NET includes four classes named Timer, each of which offers different functionality:

  • System.Timers.Timer (в этом разделе): запускает событие через регулярные интервалы.System.Timers.Timer (this topic): fires an event at regular intervals. Класс предназначен для использования в качестве серверного компонента или компонент службы в многопоточной среде. Он не имеет пользовательского интерфейса и не отображается во время выполнения.The class is intended for use as a server-based or service component in a multithreaded environment; it has no user interface and is not visible at runtime.
  • System.Threading.Timer: выполняет один метод обратного вызова в потоке пула потоков через регулярные интервалы.System.Threading.Timer: executes a single callback method on a thread pool thread at regular intervals. Метод обратного вызова определяется при создании экземпляра таймера и не может быть изменен.The callback method is defined when the timer is instantiated and cannot be changed. Как и класс System.Timers.Timer, этот класс предназначен для использования в многопоточной среде в качестве серверного компонента или компонент службы. Он не имеет пользовательского интерфейса и не отображается во время выполнения.Like the System.Timers.Timer class, this class is intended for use as a server-based or service component in a multithreaded environment; it has no user interface and is not visible at runtime.
  • System.Windows.Forms.Timer (только .NET Framework): компонент Windows Forms, который запускает событие через регулярные интервалы.System.Windows.Forms.Timer (.NET Framework only): a Windows Forms component that fires an event at regular intervals. У этого компонента нет интерфейса пользователя. Он предназначен для однопоточной среды.The component has no user interface and is designed for use in a single-threaded environment.
  • System.Web.UI.Timer (только .NET Framework): компонент ASP.NET, выполняющий асинхронные или синхронные обратные передачи веб-страниц через равные промежутки времени.System.Web.UI.Timer (.NET Framework only): an ASP.NET component that performs asynchronous or synchronous web page postbacks at a regular interval.

Конструкторы

Timer()

Инициализирует новый экземпляр класса Timer и задает всем свойствам начальные значения.Initializes a new instance of the Timer class, and sets all the properties to their initial values.

Timer(Double)

Инициализирует новый экземпляр класса Timer и задает свойству Interval указанное значение в миллисекундах.Initializes a new instance of the Timer class, and sets the Interval property to the specified number of milliseconds.

Свойства

AutoReset

Возвращает или задает логическое значение, определяющее, должен ли объект Timer вызывать событие Elapsed один раз (false) или неоднократно (true).Gets or sets a Boolean indicating whether the Timer should raise the Elapsed event only once (false) or repeatedly (true).

CanRaiseEvents

Возвращает значение, показывающее, может ли компонент вызывать событие.Gets a value indicating whether the component can raise an event.

(Унаследовано от Component)
Container

Возвращает контейнер IContainer, содержащий компонент Component.Gets the IContainer that contains the Component.

(Унаследовано от Component)
DesignMode

Возвращает значение, указывающее, находится ли данный компонент Component в режиме конструктора в настоящее время.Gets a value that indicates whether the Component is currently in design mode.

(Унаследовано от Component)
Enabled

Возвращает или задает значение, определяющее, должен ли объект Timer вызывать событие Elapsed.Gets or sets a value indicating whether the Timer should raise the Elapsed event.

Events

Возвращает список обработчиков событий, которые прикреплены к этому объекту Component.Gets the list of event handlers that are attached to this Component.

(Унаследовано от Component)
Interval

Возвращает или задает интервал в миллисекундах, по истечении которого возникает событие Elapsed.Gets or sets the interval, expressed in milliseconds, at which to raise the Elapsed event.

Site

Возвращает или задает сайт, который привязывает Timer к его контейнеру в режиме конструктора.Gets or sets the site that binds the Timer to its container in design mode.

SynchronizingObject

Получает или задает объект, используемый для маршалирования вызовов обработчика событий, осуществленных после истечения интервала времени.Gets or sets the object used to marshal event-handler calls that are issued when an interval has elapsed.

Методы

BeginInit()

Начинает во время выполнения инициализацию класса Timer, используемого в форме или другим компонентом.Begins the run-time initialization of a Timer that is used on a form or by another component.

Close()

Освобождает ресурсы, используемые объектом Timer.Releases the resources used by the Timer.

CreateObjRef(Type)

Создает объект, который содержит всю необходимую информацию для создания прокси-сервера, используемого для взаимодействия с удаленным объектом.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Унаследовано от MarshalByRefObject)
Dispose()

Освобождает все ресурсы, занятые модулем Component.Releases all resources used by the Component.

(Унаследовано от Component)
Dispose(Boolean)

Освобождает все ресурсы, используемые текущим объектом Timer.Releases all resources used by the current Timer.

EndInit()

Заканчивает во время выполнения инициализацию класса Timer, используемого в форме или другим компонентом.Ends the run-time initialization of a Timer that is used on a form or by another component.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
GetHashCode()

Служит в качестве хэш-функции по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetLifetimeService()

Извлекает объект обслуживания во время существования, который управляет политикой времени существования данного экземпляра.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Унаследовано от MarshalByRefObject)
GetService(Type)

Возвращает объект, представляющий службу, обеспечиваемую компонентом Component или его контейнером Container.Returns an object that represents a service provided by the Component or by its Container.

(Унаследовано от Component)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
InitializeLifetimeService()

Получает объект службы времени существования для управления политикой времени существования для этого экземпляра.Obtains a lifetime service object to control the lifetime policy for this instance.

(Унаследовано от MarshalByRefObject)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
MemberwiseClone(Boolean)

Создает неполную копию текущего объекта MarshalByRefObject.Creates a shallow copy of the current MarshalByRefObject object.

(Унаследовано от MarshalByRefObject)
Start()

Начинает вызывать событие Elapsed, задавая для свойства Enabled значение true.Starts raising the Elapsed event by setting Enabled to true.

Stop()

Прекращает вызывать событие Elapsed, задавая для свойства Enabled значение false.Stops raising the Elapsed event by setting Enabled to false.

ToString()

Возвращает объект String, содержащий имя Component, если оно есть.Returns a String containing the name of the Component, if any. Этот метод не следует переопределять.This method should not be overridden.

(Унаследовано от Component)

События

Disposed

Происходит при удалении компонента вызовом метода Dispose().Occurs when the component is disposed by a call to the Dispose() method.

(Унаследовано от Component)
Elapsed

Происходит по истечении интервала времени.Occurs when the interval elapses.

Применяется к

Потокобезопасность

Все открытые static членов этого типа являются потокобезопасными.Any public static members of this type are thread safe. Потокобезопасность членов экземпляров не гарантируется.Any instance members are not guaranteed to be thread safe.

Дополнительно