Transport: WSE 3.0-TCP-Interoperabilität

  • Artikel

Das Transportbeispiel „WSE 3.0 TCP-Interoperabilität“ veranschaulicht, wie Sie eine TCP-Duplexsitzung als benutzerdefinierten WCF-Transport (Windows Communication Foundation) implementieren. Außerdem zeigt es, wie Sie die Erweiterbarkeit der Kanalschicht verwenden können, um über das Netzwerk auf vorhandene bereitgestellte Systeme zuzugreifen. Die folgenden Schritte veranschaulichen, wie dieser benutzerdefinierte WCF-Transport erstellt wird:

  1. Beginnen Sie mit einem TCP-Socket. Erstellen Sie Client- und Serverimplementierungen von IDuplexSessionChannel, die Nachrichtenbegrenzungen mittels DIME Framing voneinander abgrenzen.

  2. Erstellen Sie eine Kanalfactory, die mit einem WSE-TCP-Dienst verbunden wird und begrenzte Nachrichten über die IDuplexSessionChannels sendet.

  3. Erstellen Sie einen Kanallistener zum Entgegennehmen eingehender TCP-Verbindungen, und generieren Sie entsprechende Kanäle.

  4. Stellen Sie sicher, dass alle netzwerkspezifischen Ausnahmen zu der entsprechenden abgeleiteten Klasse von CommunicationException normalisiert werden.

  5. Fügen Sie ein Bindungselement hinzu, das den benutzerdefinierten Transport einem Kanalstapel hinzufügt. Weitere Informationen finden Sie unter [Hinzufügen eines Bindungselements].

Erstellen von IDuplexSessionChannel

Der erste Schritt beim Schreiben des WSE 3.0-TCP-Interoperabilitätstransports besteht im Erstellen einer Implementierung von IDuplexSessionChannel auf einem Socket. WseTcpDuplexSessionChannel wird von ChannelBase abgeleitet. Die Logik zum Senden von Nachrichten besteht aus zwei Hauptteilen: (1) dem Codieren der Nachricht in Bytes und (2) dem Einrahmen und Senden dieser Bytes über das Netzwerk.

ArraySegment<byte> encodedBytes = EncodeMessage(message);

WriteData(encodedBytes);

Außerdem wird eine Sperre angewendet, sodass die Send()-Aufrufe die IduplexSessionChannel-Reihenfolgen-Garantie beibehalten und Aufrufe an den zugrunde liegenden Socket korrekt synchronisiert werden.

WseTcpDuplexSessionChannel verwendet einen MessageEncoder zum Übersetzen eines Message in und aus Byte[]. Da es sich um einen Transport handelt, ist WseTcpDuplexSessionChannel auch dafür verantwortlich, dass die Remoteadresse angewendet wird, mit der der Kanal konfiguriert wurde. EncodeMessage kapselt die Logik für diese Konvertierung.

this.RemoteAddress.ApplyTo(message);

return encoder.WriteMessage(message, maxBufferSize, bufferManager);

Wenn die Message-Instanz in Bytes codiert ist, muss sie über das Netzwerk gesendet werden. Dazu ist ein System zum Definieren von Nachrichtenbegrenzungen erforderlich. WSE 3.0 verwendet eine Version von DIME als Framingprotokoll. WriteData kapselt die Framinglogik zum Einschließen eines Byte[] in einen Satz von DIME-Datensätzen.

Die Logik zum Empfangen von Nachrichten ist ähnlich. Das Hauptproblem besteht darin, mit dem Umstand umzugehen, dass ein Socketlesevorgang weniger Bytes als angefordert zurückgeben kann. Zum Empfangen einer Nachricht liest WseTcpDuplexSessionChannel Bytes aus dem Netzwerk, decodiert das DIME-Framing und wandelt dann mithilfe von MessageEncoder das Byte[] in eine Message um.

Der Basis-WseTcpDuplexSessionChannel geht davon aus, dass er einen verbundenen Socket empfängt. Die Basisklasse behandelt das Herunterfahren des Sockets. Es gibt drei Stellen, die mit einer Schließung des Sockets in Verbindung stehen:

  • OnAbort -- schließt den Socket nicht ordnungsgemäß ("hartes" Schließen).

  • On[Begin]Close -- schließt den Socket ordnungsgemäß ("weiches" Schließen).

  • session.CloseOutputSession: fährt den ausgehenden Datenstream herunter („halbes“ Schließen).

Kanalfactory

Der nächste Schritt beim Schreiben des TCP-Transports besteht im Erstellen einer Implementierung von IChannelFactory für Clientkanäle.

  • WseTcpChannelFactory wird von ChannelFactoryBase<IDuplexSessionChannel> abgeleitet. Das ist eine Factory, die OnCreateChannel überschreibt, um Clientkanäle zu erzeugen.

protected override IDuplexSessionChannel OnCreateChannel(EndpointAddress remoteAddress, Uri via)

{

return new ClientWseTcpDuplexSessionChannel(encoderFactory, bufferManager, remoteAddress, via, this);

}

  • ClientWseTcpDuplexSessionChannel fügt dem Basis-WseTcpDuplexSessionChannel Logik hinzu, um zum Zeitpunkt von channel.Open eine Verbindung mit einem TCP-Server herzustellen. Zuerst wird der Hostname zu einer IP-Adresse aufgelöst, wie im folgenden Code dargestellt.

hostEntry = Dns.GetHostEntry(Via.Host);

  • Dann wird der Hostname in einer Schleife mit der ersten verfügbaren IP-Adresse verbunden, wie im folgenden Code dargestellt.

IPAddress address = hostEntry.AddressList[i];

socket = new Socket(address.AddressFamily, SocketType.Stream, ProtocolType.Tcp);

socket.Connect(new IPEndPoint(address, port));

  • Als Teil des Kanalvertrags werden alle domänenspezifischen Ausnahmen eingebunden (wie SocketException in CommunicationException).

Kanallistener

Im nächsten Schritt wird eine Implementierung von IChannelListener zum Entgegennehmen von Serverkanälen erstellt.

  • WseTcpChannelListener ist von ChannelListenerBase<IDuplexSessionChannel> abgeleitet und überschreibt On[Begin]Open und On[Begin]Close, um die Lebensdauer seines Lauschsockets zu steuern. In OnOpen wird ein Socket zum Lauschen an IP_ANY erstellt. Weiter fortgeschrittene Implementierungen können einen zweiten Socket erstellen, um auch an IPv6 zu lauschen. Sie können außerdem zulassen, dass die IP-Adresse im Hostnamen angegeben wird.

IPEndPoint localEndpoint = new IPEndPoint(IPAddress.Any, uri.Port);

this.listenSocket = new Socket(localEndpoint.AddressFamily, SocketType.Stream, ProtocolType.Tcp);

this.listenSocket.Bind(localEndpoint);

this.listenSocket.Listen(10);

Wenn ein neuer Socket entgegengenommen ist, wird ein Serverkanal mit diesem Socket initialisiert. Alle Ein- und Ausgaben sind bereits in der Basisklasse implementiert, daher dient dieser Kanal zum Initialisieren des Sockets.

Hinzufügen eines Bindungselements

Nachdem nun die Factorys und Kanäle erstellt sind, müssen Sie der ServiceModel-Laufzeit über eine Bindung verfügbar gemacht werden. Eine Bindung ist eine Auflistung von Bindungselementen, die den mit einer Dienstadresse verknüpften Kommunikationsstapel darstellt. Jedes Element im Stapel wird durch ein Element vom Typ binding dargestellt.

Im Beispiel ist das Bindungselement WseTcpTransportBindingElement, das von TransportBindingElement abgeleitet wird. Es unterstützt IDuplexSessionChannel und überschreibt die folgenden Methoden, um die mit unserer Bindung verknüpften Factorys zu erstellen.

public IChannelFactory<TChannel> BuildChannelFactory<TChannel>(BindingContext context)

{

return (IChannelFactory<TChannel>)(object)new WseTcpChannelFactory(this, context);

}

public IChannelListener<TChannel> BuildChannelListener<TChannel>(BindingContext context)

{

return (IChannelListener<TChannel>)(object)new WseTcpChannelListener(this, context);

}

Es enthält auch Members zum Klonen des BindingElement und Zurückgeben unseres Schemas (wse.tcp).

Die WSE-TCP-Testkonsole

Testcode zum Verwenden dieses Beispieltransports ist in TestCode.cs verfügbar. Die folgenden Anweisungen zeigen, wie das WSE-TcpSyncStockService-Beispiel erstellt wird.

Der Testcode erstellt eine benutzerdefinierte Bindung, die MTOM als Codierung und WseTcpTransport als Transport verwendet. Außerdem richtet er die AddressingVersion so ein, dass sie mit WSE 3.0 kompatibel ist, wie im folgenden Code dargestellt.

CustomBinding binding = new CustomBinding();

MtomMessageEncodingBindingElement mtomBindingElement = new MtomMessageEncodingBindingElement();

mtomBindingElement.MessageVersion = MessageVersion.Soap11WSAddressingAugust2004;

binding.Elements.Add(mtomBindingElement);

binding.Elements.Add(new WseTcpTransportBindingElement());

Er besteht aus zwei Tests: Der erste Test richtet einen typisierten Client mithilfe von aus WSE 3.0 WSDL generiertem Code ein. Der zweite Test verwendet WCF sowohl als Client als auch als Server, indem Nachrichten direkt über die Kanal-APIs gesendet werden.

Beim Ausführen des Beispiels sollte die Ausgabe wie folgt aussehen.

Client:

Calling soap://stockservice.contoso.com/wse/samples/2003/06/TcpSyncStockService

Symbol: FABRIKAM
        Name: Fabrikam, Inc.
        Last Price: 120

Symbol: CONTOSO
        Name: Contoso Corp.
        Last Price: 50.07
Press enter.

Received Action: http://SayHello
Received Body: to you.
Hello to you.
Press enter.

Received Action: http://NotHello
Received Body: to me.
Press enter.

Server:

Listening for messages at soap://stockservice.contoso.com/wse/samples/2003/06/TcpSyncStockService

Press any key to exit when done...

Request received.
Symbols:
        FABRIKAM
        CONTOSO

Einrichten, Erstellen und Ausführen des Beispiels

  1. Zum Ausführen dieses Beispiels müssen Sie WSE 3.0 (Web Services Enhancements, WSE) für Microsoft .NET und das WSE-Beispiel TcpSyncStockService installiert haben.

Hinweis

Da WSE 3.0 von Windows Server 2008 nicht unterstützt wird, können Sie das TcpSyncStockService-Beispiel unter diesem Betriebssystem nicht installieren und ausführen.

  1. Führen Sie nach der Installation des TcpSyncStockService-Beispiels folgende Schritte aus:

    1. Öffnen Sie in Visual Studio TcpSyncStockService. (Das Beispiel TcpSyncStockService wird mit WSE 3.0 installiert und ist nicht Teil dieses Beispielcodes.)

    2. Legen Sie das StockService-Projekt als Startprojekt fest.

    3. Öffnen Sie StockService.cs im StockService-Projekt, und kommentieren Sie das [Policy]-Attribut in der StockService-Klasse aus. Dadurch werden die Sicherheitsfunktionen im Beispiel deaktiviert. Obwohl WCF mit WSE 3.0-Sicherheitsendpunkten interagieren kann, ist die Sicherheit deaktiviert, um dieses Beispiel auf den benutzerdefinierten TCP-Transport zu konzentrieren.

    4. Drücken Sie F5, um TcpSyncStockService zu starten. Der Dienst wird in einem neuen Konsolenfenster gestartet.

    5. Öffnen Sie dieses TCP-Transportbeispiel in Visual Studio.

    6. Aktualisieren Sie die Variable "hostname" in TestCode.cs so, dass sie mit dem Namen des Computers übereinstimmt, auf dem TcpSyncStockService ausgeführt wird.

    7. Drücken Sie F5, um das TCP-Transportbeispiel zu starten.

    8. Der TCP-Transporttest-Client wird in einem neuen Konsolenfenster gestartet. Der Client fordert beim Dienst Aktienkurse an und zeigt die Ergebnisse dann in seinem Konsolenfenster an.