Grundlegendes zu Zustandsänderungen

In diesem Thema werden die Zustände und Übergänge in Kanälen, die Typen zum Strukturieren von Kanalzuständen und deren Implementierung erläutert.

Statuscomputer und Kanäle

Objekte, die die Kommunikation behandeln, wie z. B. Sockets, weisen in der Regel einen Statuscomputer auf, dessen Zustandsübergänge sich auf das Zuordnen von Netzwerkressourcen, Herstellen oder Annehmen von Verbindungen oder das Schließen und Beenden einer Kommunikation beziehen. Der Kanalstatuscomputer stellt ein einheitliches Modell der Zustände eines Kommunikationsobjekt bereit, das die zugrunde liegende Implementierung dieses Objekts abstrahiert. Die ICommunicationObject-Schnittstelle umfasst eine Reihe von Zuständen, Zustandsübergangsmethoden und Zustandsübergangsereignisse. Alle Kanäle, Kanalfactorys und Kanallistener implementieren den Kanalstatuscomputer.

Die Ereignisse Closed, Closing, Faulted, Opened und Opening informieren einen externen Beobachter über einen stattgefundenen Zustandsübergang.

Die Methoden Abort, Close und Open (und deren asynchrone Entsprechungen) verursachen Zustandsübergänge.

Die Zustandseigenschaft gibt den von CommunicationState definierten aktuellen Zustand zurück:

ICommunicationObject, CommunicationObject, Zustände und Zustandsübergänge

Ein ICommunicationObject beginnt im Created-Zustand, in dem seine verschiedenen Eigenschaften konfiguriert werden können. Sobald sich das Objekt im Opened-Zustand befindet, kann es zum Senden und Empfangen von Nachrichten verwendet werden, seine Eigenschaften sind jedoch unveränderlich. Im Closing-Zustand kann das Objekt keine neuen Anforderungen senden oder empfangen. Vorhandene Anforderungen können jedoch abgeschlossen werden, sofern der Close-Timeout nicht überschritten wird. Bei einem nicht behebbaren Fehler geht das Objekt in den Faulted-Zustand über und kann auf Informationen zum Fehler überprüft und letztendlich geschlossen werden. Im Closed-Zustand hat das Objekt im Wesentlichen das Ende des Statuscomputers erreicht. Nachdem ein Objekt aus einen Zustand in den nächsten übergegangen ist, wechselt es nicht mehr zurück in einen früheren Zustand.

Das folgende Diagramm veranschaulicht die Zustände und Zustandsübergänge von ICommunicationObject. Zustandsübergänge können durch einen Aufruf der folgenden drei Methoden verursacht werden: Abort, Open oder Close. Sie können auch durch einen Aufruf anderer Methoden, die von der Implementierung abhängen, verursacht werden. Ein Übergang in den Faulted-Zustand kann das Ergebnis von Fehlern beim oder nach dem Öffnen eines Kommunikationsobjekts sein.

Jedes ICommunicationObject beginnt im Created-Zustand. In diesem Zustand kann eine Anwendung das Objekt konfigurieren, indem dessen Eigenschaften festgelegt werden. Sobald sich ein Objekt in einen anderen Zustand als Created befindet, gilt es als unveränderlich.

Windows Communication Foundation (WCF) stellt eine abstrakte Basisklasse mit dem Namen CommunicationObject bereit, die ICommunicationObject und den Kanalstatuscomputer implementiert. In der folgenden Grafik wird ein Diagramm mit Zustandsänderungen dargestellt, das sich auf CommunicationObject bezieht. Neben dem ICommunicationObject-Statuscomputer zeigt es die zeitliche Steuerung, nach der weitere CommunicationObject-Methoden aufgerufen werden.

ICommunicationObject-Ereignisse

CommunicationObject macht die fünf von ICommunicationObject definierten Ereignisse verfügbar. Diese Ereignisse sind für Code vorgesehen, in dem das Kommunikationsobjekt für eine Benachrichtigung über Zustandsübergänge verwendet wird. Wie oben in Abbildung 2 dargestellt, wird jedes Ereignis einmal ausgelöst, nachdem der Zustand des Objekts in den durch das Ereignis bezeichneten Zustand übergegangen ist. Alle fünf Ereignisse sind vom Typ EventHandler, der folgendermaßen definiert wird:

public delegate void EventHandler(object sender, EventArgs e);

In der CommunicationObject-Implementierung ist der Absender entweder CommunicationObject direkt oder das, was darin als Absender an den CommunicationObject-Konstruktor übergeben wurde (wenn diese Konstruktorüberladung verwendet wurde). Der EventArgs-Parameter e ist immer EventArgs.Empty.

Abgeleitete Objektrückrufe

Abgesehen von den fünf Ereignissen deklariert CommunicationObject acht geschützte virtuelle Methoden, mit denen ein abgeleitetes Objekt vor und nach dem Eintreten eines Zustandsübergang zurückgerufen werden kann.

Den Methoden System.ServiceModel.Channels.CommunicationObject.Open und System.ServiceModel.Channels.CommunicationObject.Close sind jeweils drei solcher Rückrufe zugeordnete. Beispielsweise gehören zu System.ServiceModel.Channels.CommunicationObject.Open die Rückrufe System.ServiceModel.Channels.CommunicationObject.OnOpening, System.ServiceModel.Channels.CommunicationObject.OnOpen(System.TimeSpan) und System.ServiceModel.Channels.CommunicationObject.OnOpened. System.ServiceModel.Channels.CommunicationObject.Close sind die Methoden System.ServiceModel.Channels.CommunicationObject.OnClose(System.TimeSpan), System.ServiceModel.Channels.CommunicationObject.OnClosing und System.ServiceModel.Channels.CommunicationObject.OnClosed zugeordnet.

Entsprechend verfügt die System.ServiceModel.Channels.CommunicationObject.Abort-Methode über eine zugehörige System.ServiceModel.Channels.CommunicationObject.OnAbort-Methode.

System.ServiceModel.Channels.CommunicationObject.OnOpen(System.TimeSpan), System.ServiceModel.Channels.CommunicationObject.OnClose(System.TimeSpan) und System.ServiceModel.Channels.CommunicationObject.OnAbort weisen keine Standardimplementierung auf. Die anderen Rückrufe besitzen hingegen eine Standardimplementierung, die für die Richtigkeit des Statuscomputers erforderlich ist. Stellen Sie beim Überschreiben dieser Methoden sicher, dass Sie die Basisimplementierung aufrufen oder ordnungsgemäß ersetzen.

System.ServiceModel.Channels.CommunicationObject.OnOpening, System.ServiceModel.Channels.CommunicationObject.OnClosing und System.ServiceModel.Channels.CommunicationObject.OnFaulted lösen die entsprechenden Ereignisse System.ServiceModel.Channels.CommunicationObject.Opening, System.ServiceModel.Channels.CommunicationObject.Closing und System.ServiceModel.Channels.CommunicationObject.Faulted aus. System.ServiceModel.Channels.CommunicationObject.OnOpened und System.ServiceModel.Channels.CommunicationObject.OnClosed legen den Objektstatus auf jeweils Opened und Closed fest und lösen dann die entsprechenden Ereignisse System.ServiceModel.Channels.CommunicationObject.Opened und System.ServiceModel.Channels.CommunicationObject.Closed aus.

Zustandsübergangsmethoden

CommunicationObject stellt Implementierungen von Abort, Close und Open bereit. Bereitgestellt wird außerdem eine Fault-Methode, die einen Zustandsübergang in den Faulted-Zustand verursacht. Abbildung 2 zeigt den ICommunicationObject-Statuscomputer. Dabei wird jeder Übergang durch die Methode bezeichnet, die ihn verursacht hat (nicht bezeichnete Übergänge treten innerhalb der Implementierung der Methode auf, die den letzten bezeichneten Übergang verursacht hat).

Tipp

Bei allen CommunicationObject-Implementierungen des Kommunikationszustands gets/sets sind die Threads synchronisiert.

Konstruktor

CommunicationObject stellt drei Konstruktoren bereit, von denen alle das Objekt im Created-Zustand belassen. Die Konstruktoren werden wie folgt definiert:

Der erste Konstruktor ist ein Standardkonstruktor und führt eine Delegierung an die Konstruktorüberladung aus, die ein Objekt akzeptiert:

protected CommunicationObject() : this(new object()) { … }

Der Konstruktor, der ein Objekt akzeptiert, verwendet diesen Parameter als das zu sperrende Objekt, wenn der Zugriff auf den Zustand des Kommunikationsobjekts synchronisiert wird:

protected CommunicationObject(object mutex) { … }

Ein dritter Konstruktor akzeptiert einen weiteren Parameter, der als Absenderargument verwendet, wenn ICommunicationObject-Ereignisse ausgelöst werden.

protected CommunicationObject(object mutex, object eventSender) { … }

Die vorherigen beiden Konstruktoren legen den Absender auf dieses Argument fest.

Open-Methode

Vorbedingung: Der Zustand ist Created.

Nachbedingung: Der Zustand ist Opened oder Faulted. Möglicherweise wird eine Ausnahme ausgelöst.

Die Open()-Methode versucht, das Kommunikationsobjekt zu öffnen und den Zustand auf Opened festzulegen. Falls ein Fehler auftritt, legt sie den Zustand auf Faulted festgelegt.

Die Methode, überprüft zuerst, ob Created der aktuelle Zustand ist. Wenn der aktuelle Zustand Opening oder Opened lautet, löst sie InvalidOperationException aus. Ist Closing oder Closed der aktuelle Zustand, löst sie CommunicationObjectAbortedException aus, wenn das Objekt beendet worden ist, andernfalls löst sie ObjectDisposedException aus. Ist Faulted der aktuelle Zustand, löst sie CommunicationObjectFaultedException aus.

Anschließend legt sie den Zustand auf Opening fest und ruft OnOpening() (wodurch das Opening-Ereignis ausgelöst wird), OnOpen() und OnOpened() in dieser Reihenfolge auf. OnOpened() legt den Zustand auf Opened fest und löst das Opened-Ereignis aus. Wenn währenddessen eine Ausnahme ausgelöst wird, ruft Open() Fault() auf und übergibt die Ausnahme. Das folgende Diagramm zeigt den Open-Prozess im Detail.

Close-Methode

Vorbedingung: Keine.

Nachbedingung: Der Zustand ist Closed. Möglicherweise wird eine Ausnahme ausgelöst.

Die Close()-Methode kann bei jedem Zustand aufgerufen werden. Sie versucht, das Objekt ordnungsgemäß zu schließen. Bei einem Fehler beendet sie das Objekt. Die Methode bewirkt nichts, wenn der aktuelle Zustand Closing oder Closed lautet. Andernfalls legt sie den Zustand auf Closing fest. Wenn der ursprüngliche Zustand Created, Opening oder Faulted lautete, ruft sie Abort() auf (siehe folgendes Diagramm). Wenn der ursprüngliche Zustand Opened lautete, ruft sie OnClosing (wodurch das Opening-Ereignis ausgelöst wird), OnOpen() und OnOpened() in dieser Reihenfolge auf. Wenn währenddessen eine Ausnahme ausgelöst wird, ruft Close() Abort() auf und übergibt die Ausnahme. OnClosed() legt den Zustand auf Closed fest und löst das Closed-Ereignis aus. Das folgende Diagramm zeigt den Close-Prozess im Detail.

Abort-Methode

Vorbedingung: Keine.
Nachbedingung: Der Zustand ist Closed. Möglicherweise wird eine Ausnahme ausgelöst.

Die Abort()-Methode bewirkt nichts, wenn der aktuelle Zustand Closed lautet oder wenn das Objekt zuvor beendet worden ist (z. B. indem Abort() für einen anderen Thread ausgeführt wird). Andernfalls legt sie den Zustand auf Closing fest und ruft OnClosing() (wodurch das Closing-Ereignis ausgelöst wird), OnAbort() und OnClosed() in dieser Reihenfolge auf. (OnClose wird nicht aufgerufen, da das Objekt beendet, nicht geschlossen wird.) OnClosed() legt den Zustand auf Closed fest und löst das Closed-Ereignis aus. Wenn währenddessen eine Ausnahme ausgelöst wird, wird sie erneut für den Aufrufer von Abort ausgelöst. Implementierungen von OnClosing(), OnClosed() und OnAbort() sollten keine Blockierung hervorrufen (z. B. bei Ein-/Ausgaben). Das folgende Diagramm zeigt den Abort-Prozess im Detail.

Fault-Methode

Die Fault-Methode bezieht sich speziell auf CommunicationObject und ist kein Bestandteil der ICommunicationObject-Schnittstelle. Sie wird hier nur aus Gründen der Vollständigkeit aufgeführt.

Vorbedingung: Keine.

Nachbedingung: Der Zustand ist Faulted. Möglicherweise wird eine Ausnahme ausgelöst.

Die Fault()-Methode bewirkt nichts, wenn der aktuelle Zustand Faulted oder Closed lautet. Andernfalls legt sie den Zustand auf Faulted fest und ruft OnFaulted() auf, wodurch das Faulted-Ereignis ausgelöst wird. Wenn OnFaulted eine Ausnahme auslöst, wird sie erneut ausgelöst.

ThrowIfXxx-Methoden

CommunicationObject verfügt über drei geschützte Methoden, mit denen Ausnahmen ausgelöst werden können, wenn sich das Objekt in einem bestimmten Zustand befindet.

ThrowIfDisposed löst eine Ausnahme aus, wenn der Zustand Closing, Closed oder Faulted lautet.

ThrowIfDisposedOrImmutable löst eine Ausnahme aus, wenn der Zustand nicht Created lautet.

ThrowIfDisposedOrNotOpen löst eine Ausnahme aus, wenn der Zustand nicht Opened lautet.

Die ausgelösten Ausnahmen hängen vom Zustand ab. Die folgende Tabelle enthält die verschiedenen Zustände und den entsprechende Ausnahmetyp, der durch einen Aufruf von ThrowIfXxx zu diesem Zustand ausgelöst wird.

Zustand	Wurde Abort aufgerufen?	Ausnahme
Created	Nicht zutreffend	System.InvalidOperationException
Opening	Nicht zutreffend	System.InvalidOperationException
Opened	Nicht zutreffend	System.InvalidOperationException
Closing	Ja	System.ServiceModel.CommunicationObjectAbortedException
Closing	Nein	System.ObjectDisposedException
Closed	Ja	System.ServiceModel.CommunicationObjectAbortedException im Fall, dass ein Objekt durch einen vorherigen, expliziten Aufruf von Abort geschlossen wurde. Wenn Sie Close für das Objekt aufrufen, wird System.ObjectDisposedException ausgelöst.
Closed	Nein	System.ObjectDisposedException
Faulted	Nicht zutreffend	System.ServiceModel.CommunicationObjectFaultedException

Timeouts

Mehrere der besprochenen Methoden akzeptieren Timeoutparameter. Dazu gehören Close, Open (bestimmte Überladungen und asynchrone Versionen), OnClose und OnOpen. Diese Methoden wurden für langwierige Vorgänge entwickelt (z. B. das Blockieren bei Ein-/Ausgaben beim ordnungsgemäßen Schließen einer Verbindung)), damit mit dem Timeoutparameter angegeben werden kann, wie lange dieser Vorgang dauern darf, bevor er unterbrochen wird. Implementierungen dieser Methoden sollten den bereitgestellten Timeoutwert verwenden, um sicherzustellen, dass die Rückgabe an den Aufrufer innerhalb dieses Timeouts erfolgt. Implementierungen anderer Methoden, die keinen Timeoutwert akzeptieren, sind nicht für langwierige Vorgänge bestimmt und sollten bei Ein-/Ausgaben keine Blockierung verursachen.

Zu den Ausnahmen zählen die Überladungen Open() und Close(), die keinen Timeout akzeptieren. Diese Überladungen verwenden einen Timeoutwert, der von der abgeleiteten Klasse bereitgestellt wird. CommunicationObject macht zwei geschützte abstrakte Eigenschaften mit der Bezeichnung DefaultCloseTimeout und DefaultOpenTimeout verfügbar, die wie folgt definiert werden:

protected abstract TimeSpan DefaultCloseTimeout { get; }

protected abstract TimeSpan DefaultOpenTimeout { get; }

Eine abgeleitete Klasse implementiert diese Eigenschaften, um für die Überladungen Open() und Close(), die keinen Timeoutwert akzeptieren, den Standardtimeout bereitzustellen. Dann führen die Implementierungen von Open() und Close() eine Delegierung an die Überladung aus, die einen Timeout akzeptiert und übergeben ihr den Standardtimeoutwert. Beispiel:

public void Open()

{

this.Open(this.DefaultOpenTimeout);

}

IDefaultCommunicationTimeouts

Diese Schnittstelle verfügt über vier schreibgeschützte Eigenschaften, um Standardtimeoutwerte für Open, Send, Receive und Close bereitzustellen. Jede Implementierung muss die Standardwerte auf die entsprechend angebrachte Weise implementieren. Zur Vereinfachung lege ChannelFactoryBase und ChannelListenerBase diese Werte standardmäßig afúf jeweils 1 Minute fest.