Книга: C# для профессионалов. Том II

Класс ServiceBase

Класс ServiceBase

Класс ServiceBase является базовым для всех служб .NET. Наш класс QuoteService выводится из ServiceBase. Этот класс общается со служебным управляющим менеджером при помощи недокументированного вспомогательного класса System.ServiceProcess.NativeMethods, который служит просто классом-оболочкой для вызовов API Win32. Этот класс закрытый, поэтому мы не можем его использовать.

Следующая диаграмма последовательностей показывает взаимодействие SCM — класса QuoteService и классов из пространства имен System.ServiceProcess. На диаграмме последовательностей просматриваются вертикальные линии жизни объектов и коммуникация, проходящая в горизонтальном направлении. Коммуникация упорядочена по времени сверху вниз:

SCM запускает процесс службы. Вначале вызывается метод Main(). В методе Main() нашей службы вызывается метод Run() базового класса ServiceBase. Run() регистрирует метод ServiceMainCallback() с помощью NativeMethods.StartServiceCtrlDispatcher() в SCM и записывает вход в журнал событий.

Следующий шаг — SCM вызывает зарегистрированный метод ServiceMainCallback() в нашей программе службы. ServiceMainCallback сам регистрирует обработчик с помощью NativeMethods.RegisterServiceCtrlHandler[Ex]() и задает статус службы в SCM. Затем вызывается метод OnStart(), в котором мы должны реализовать код запуска. Если OnStart() выполнился успешно, то значение ресурса для StartSuccessful записывается в журнал событий.

Обработчик реализуется в методе ServiceCommandCallback(). SCM вызывает этот метод, когда служба запрашивает изменения. Метод ServiceCommandCallback() направляет запросы далее в OnPause(), OnContinue(), OnStop(), OnCustomCommand() и OnPowerEvent().

Рассмотрим сгенерированную основную функцию служебного процесса. В ней объявляются массив ServiceToRun классов ServiceBase. Один экземпляр класса QuoteService создается и передается как первый элемент массива ServiceToRun. Если должно выполняться более одной службы внутри этого служебного процесса, то необходимо добавить в массив больше экземпляров специальных служебных классов. Этот массив передается затем в статический метод Run() класса ServiceBase. С помощью метода Run() из ServiceBase мы задаем ссылки SCM для точек входа служб. Основной поток выполнения служебного процесса теперь заблокирован и ожидает завершения службы.

Вот автоматически сгенерированный код:

// Основная точка входа для процесса
static void Main() {
 System.ServiceProcess.ServiceBase[] ServicesToRun;
 // Более одной службы пользователя может выполняться в одном процессе.
 // Чтобы добавить другую службу в этот процесс, измените следующую
 // строку для создания второго служебного объекта. Например:
 // ServiceToRun = New System.ServiceProcess.ServiceBase[]
 // {
 // new WinService1(), new MySecondUserService()
 // };
 ServiceToRun = new System.ServiceProcess.ServiceBase[] {
  new QuoteService()
 };
 System.ServiceProcess.ServiceBase.Run(ServiceToRun);
}

При наличии только одной службы можно удалить в процессе массив. Метод Run() получает один объект, производный из класса ServiceBase, поэтому функцию Main можно сократить до приведенного здесь кода:

System,ServiceProcess.ServiceBase.Run(new QuoteService());

Если существует более одной службы и для них требуется некоторая общая инициализация, то эта общая инициализация должна делаться до метода Run(), так как основной поток выполнения блокируется, пока служебный процесс не будет остановлен. Последующие инструкции остаются недоступными до конца службы.

Инициализация не может продолжаться слишком долго, время выполнения не должно превышать 30 с. Если код инициализации будет более длительным, то служебный управляющий менеджер предположит, что запуск службы отказал. Но необходимо принимать в расчет самые медленные машины, где эта служба также должна выполняться с учетом ограничения в 30 с. Если процесс продолжается дольше, можно запустить инициализацию в другом потоке выполнения, чтобы основной поток выполнения вызывал Run() вовремя. Объект события может затем использоваться для сигнализации того, что поток выполнения закончил свою работу.

При запуске службы вызывается метод OnStart(). Здесь может начать работу сервер сокета. Чтобы использовать QuoteServer, должна быть указана сборка Quote.Server.dll. Поток выполнения, вызывающий OnStart(), не может быть блокирован, этот метод возвращает управление вызывающей стороне, которая является методом ServiceMainCallback() класса ServiceBase. Класс ServiceBase регистрирует обработчик и информирует SCM после вызова OnStart(), что служба успешно запущена:

/// <summary>
/// Задает вещи по ходу, чтобы служба могла делать свою работу.
/// </summary>
protected override void OnStart(string[] args) {
 quoteServer = new QuoteServer(@"c:Wroxquotes.txt", 5678);
 quoteServer.Start();
}

Переменная quoteServer объявляется как закрытый член класса:

namespace Wrox.ProfessionalCSharp {
 public class QuoteService : System.ServiceProcess.ServiceBase {
  /// <summary>
  /// Требуемые переменные проектировщика.
  /// </summary>
  private System.ComponentModel.Container components;
  private QuoteServer quoteServer;

Когда служба заканчивает работу, вызывается метод OnStop(). Необходимо остановить функциональность службы в этом методе:

/// <summary>
/// Остановить эту службу. /// </summary>
protected override void OnStop() {
 quoteServer.Stop();
}

В дополнение к OnStart() и OnStop() можно переопределить в классе следующие обработчики:

? OnPause() вызывается, когда служба должна быть временно остановлена.

? OnContinue() вызывается, когда служба возвращается к нормальной работе после временной остановки. Чтобы сделать возможным вызов перезагруженных методов OnPause() и OnContinue(), свойство CanPauseAndContinue должно быть задано как true.

? OnShutdown() вызывается, когда Windows осуществляет выключение системы. Обычно поведение этого метода аналогично реализации OnStop(): если для выключения потребуется больше времени, то запрашивается дополнительное время. Аналогично OnPause() и OnContinue имеется свойство, чтобы включить такое поведение,— CanShutdown, которое должно быть задано как true.

? OnCustomCommand() является обработчиком, который обслуживает специальные команды. С помощью специальной служебной управляющей программы службе посылаются особые команды. Как эти команды обрабатываются, определяет реализация OnCustomCommand(). Этот метод имеет аргумент типа int, где задается номер специальной команды. Значение может быть в диапазоне от 128 до 256, значения меньше 128 являются зарезервированными системой значениями. В нашей службе повторное чтение файла цитат выполняется с помощью специальной команды 128:

protected override void OnPause() {
 quoteServer.Suspend();
}
protected override void OnContinue() {
 quoteServer.Resume();
}
protected override void OnShutDown() {
 OnStop();
}
public const int commandRefresh = 128;
protected override void OnCustomCommand(int command) {
 switch(command) {
 case CommandRefresh:
  quoteServer.RefreshQuotes();
  break;
 default:
  break;
 }
}

Как и раньше, необходимо добавить ссылку на файл QuoteServer.dll.

Оглавление книги