Этап 2: определение члена-события

В C# член-событие объявляется ключевым словомevent. Каждому члену-событию определяется:

1. область действия

2. тип делегата, указывающий на прототип вызываемого метода (методов)

3. имя

Вот как выглядит член-событие нашего класса NewMail:

internal class MailManager

{

// Этап 2: определение члена-события

public event EventHandler<NewMailEventArgs> NewMail;

}

NewMail— имя события.

EventHandler<NewMailEventArgs> — тип члена-события.

Получатели уведомления о событии должны предоставлять метод обратного вызова, прототип которого совпадает с типом-делегатом EventHandler<NewMailEventArgs>.

Поскольку обобщенный делегат System.EventHandlerопределен так:

public delegate void EventHandler<TEventArgs>

(Object sender, TEventArgs e) where TEventArgs : EventArgs;

метод должен выглядеть так:

void MethodName(Object sender, NewMailEventArgs e);

Примечание:Многих удивляет, почему механизм событий требует, чтобы параметр sender был типа Object. Вообще-то, поскольку MailManager — единственный тип, реализующий события с объектом NewMailEventArgs, было бы разумнее использовать следующий прототип метода обратного вызова:

void MethodName(MailManager sender, NewMailEventArgs e);

Причина необходимости того, чтобы параметр sender был типа Object, — в наследовании. Что произойдет, если MailManager задействовать в качестве базового класса для создания класса SmtpMailManager? В методе обратного вызова придется в прототипе задать параметр sender как SmtpMailManager, а не MailManager, но этого делать нельзя, так как SmtpMailManager просто унаследовал событие NewMail. Поэтому код, ожидающий от SmtpMailManager информацию о событии, все равно будет вынужден приводить аргумент sender к типу SmtpMailManager. Иначе говоря, приведение все равно необходимо, поэтому проще всего сделать так, чтобы sender был типа Object.

Еще одна причина того, что sender относят к типу Object — простая гибкость. Это позволяет использовать делегат нескольким типам, которые поддерживают событие, передающее объект NewMailEventArgs. В частности, класс PopMailManager мог бы использовать делегат, даже если бы не наследовал классу MailManager.

Механизм событий требует, чтобы в имени делегата и методе обратного вызова производный от EventArgs параметр назывался е. Единственная причина — обеспечить дополнительное однообразие, облегчая и упрощая для разработчиков изучение и реализацию событий.

Механизм событий требует, чтобы все обработчики возвращали void. Это обязательно, потому что при возникновении события могут вызываться несколько методов обратного вызова и невозможно получить у них всех возвращаемое значение. Тип void просто запрещает методам возвращать какое бы то ни было значение. К сожалению, в библиотеке FCL есть обработчики событий, в частности ResolveEventHandler, в которых Microsoft не следует собственным правилам и возвращает объект типа Assembly.

Этап 3: определение метода, ответственного за уведомление зарегистрированных объектов о событии

В соответствии с соглашением, в классе должен быть виртуальный защищенный метод, вызываемый из кода класса и его потомков при возникновении события. Этот метод принимает один параметр, объект MailMsgEventArgs, содержащий дополнительные сведения о событии.

Реализация по умолчанию этого метода проверяет, есть ли объекты, зарегистрировавшиеся для получения уведомления о событии, и при положительном результате проверки уведомляет зарегистрированные методы о возникновении события. Вот как выглядит этот метод в нашем классе MailManager.

internal class MailManager

{

// Если этот класс изолированный, нужно сделать метод закрытым или невиртуальным.

protected virtual void OnNewMail(NewMailEventArgs e)

{

// Сохранить поле делегата во временном поле

// для обеспечения безопасности потоков.

EventHandler<NewMailEventArgs> temp = NewMail;

// Если есть объекты, зарегистрированные для получения

// уведомления о событии, уведомляем их.

if (temp != null)

temp(this, e);

}

}

Обратите внимание, что метод OnNewMail определяет временную локальную переменную temp, которая инициализируется самим членом-событием. Далее temp сравнивается с null и в случае неравенства используется для инициирования события. Эта временная переменная необходима для предотвращения возможных проблем с синхронизацией потоков.

Если вместо использования temp просто сослаться на NewMail, вполне возможно, что поток «увидит», что NewMail не равно null. Но позднее, непосредственно перед генерацией события, другой поток может переопределить NewMail, присвоив null. В такой ситуации при попытке инициировать событие CLR вернет исключение NullReferenceException. Временная переменная temp решает проблему и избавляет от возможности генерации исключения NullReferenceException.

Тип, производный от MailManager, может свободно переопределять метод OnNewMail, что позволяет производному типу контролировать срабатывание события. Таким образом, производный тип может обрабатывать новые сообщения любым способом по собственному усмотрению.

Обычно производный тип вызывает метод OnNewMail базового типа, в результате зарегистрированный объект получает уведомление. Однако производный тип может и отказаться от пересылки уведомления о событии.