Remoting über TCP-Channel (Ohne Config-Datei und mit Config-Datei)

    • VB.NET

      Remoting über TCP-Channel (Ohne Config-Datei und mit Config-Datei)

      Hier mal ein kleiner Beispiel-Code für Remoting über TCP-Channels.

      Die Erklärung des Codes, steht in den Kommentaren.

      Ohne Config-Dateien

      Beispielprojekt ist im Anhang: RemotingVB.zip

      Man benötigt:
      Zwei WinForms Anwendungen (RemotingServer und RemotingClient) und eine DLL (RemoteableObject).

      Auf die Form des Servers (Server.vb) kommt eine TextBox (Multiline) und ein Button um die TextBox zu leeren.

      Auf die Form des Clients (Client.vb) kommt eine TextBox und ein Button zum Senden.

      Code Server:
      Spoiler anzeigen

      VB.NET-Quellcode

      1. Imports RemoteableObject
      2. Imports System.Runtime.Remoting
      3. Imports System.Runtime.Remoting.Channels
      4. Imports System.Runtime.Remoting.Channels.Tcp
      6. Public Class Server
      7. 'Implementiert das IObserver Interface, um die aktuelle Instanz des Servers, an die aktuelle Instanz des Caches anzuhängen und um die Methode Notify bereit zu stellen
      8. Implements RemoteableObject.IObserver
      10. ''' <summary>
      11. ''' Definiert den Port, über den die TCP-Verbindung stattfindet.
      12. ''' </summary>
      13. ''' <remarks></remarks>
      14. Const PORT = 1234
      16. ''' <summary>
      17. ''' Definiert den Namen des DienstObjekts
      18. ''' </summary>
      19. ''' <remarks></remarks>
      20. Const ServiceName As String = "SendMessage"
      22. ''' <summary>
      23. ''' Dieser Delegat schreibt Text in die TextBox, im Kontext des UI-Threads.
      24. ''' </summary>
      25. ''' <param name="text"></param>
      26. ''' <remarks></remarks>
      27. Delegate Sub SetTextFromUIThread(ByVal text As String)
      29. ''' <summary>
      30. ''' Das Objekt, welches über Remoting verfügbar gemacht wird.
      31. ''' </summary>
      32. ''' <remarks></remarks>
      33. Private _remotableObject As MyRemotableObject
      37. Private Sub Form1_Load(sender As Object, e As System.EventArgs) Handles Me.Load
      38. _remotableObject = New MyRemotableObject()
      40. 'Hier wird ein neuer TcpChannel mit dem gewünschten Port erstellt.
      41. Dim channel As TcpChannel = New TcpChannel(PORT)
      43. 'Vor der ersten Verwendung muss der Channel registriert werden
      44. ChannelServices.RegisterChannel(channel, False)
      46. 'Damit die Übertragung funktioniert, muss der Typ, welcher beim Remoting verwendet werden soll, als WellKnownServiceType registriert werden.
      47. 'Man kann diesen auf zwei Arten registrieren. Als Singleton oder SingleCall.
      49. 'SingleCall: Für jeden Aufruf durch einen Client wird eine neue Instanz erstellt. Es werden keine Statusinformationen gespeichert und die Instanz des Objekts
      50. ' wird nach dem Aufruf zerstört und vom GC abgeholt.
      51. RemotingConfiguration.RegisterWellKnownServiceType(GetType(MyRemotableObject), ServiceName, WellKnownObjectMode.SingleCall)
      53. 'Singleton: Ein Instanz, wird für alle Aufrufe durch Clients verwendet. Es können Statusinformationen gespeichert werden.
      54. ' Diese Methode kann verwendet werden, um Daten zwischen zwei Clients austauschen zu können. Die Instanz des Objekts wird nach dem Aufruf nicht zerstört,
      55. ' sondern bleibt noch für eine gewisse Zeit erhalten (Lease-Time).
      56. 'RemotingConfiguration.RegisterWellKnownServiceType(GetType(MyRemotableObject), ServiceName, WellKnownObjectMode.Singleton)
      58. 'Fügt sich selbst dem Cache als IObserver-Objekt hinzu.
      59. RemoteableObject.Cache.Attach(Me)
      60. End Sub
      62. 'Diese Methode wird am Server ausgeführt, wenn der Client die Methode _remotableObject.SetMessage aufgerufen wird.
      63. Public Sub Notify(ByVal text As String) Implements IObserver.Notify
      64. 'Ruft den Delegaten zum befüllen der Textbox, im Kontext des UI-Threads auf
      65. Me.Invoke(write, text)
      66. End Sub
      68. 'Erstellt einen neuen Delegaten (SetTextFromUIThread: Siehe oben), der auf die Methode TextReceived verweist.
      69. Private write As New SetTextFromUIThread(AddressOf TextReceived)
      71. 'Diese Methode wird durch den Delegaten aufgerufen.
      72. Private Sub TextReceived(ByVal text As String)
      73. TextBox1.Text &= String.Concat(text, vbCrLf)
      74. End Sub
      76. Private Sub Button1_Click(sender As System.Object, e As System.EventArgs) Handles Button1.Click
      77. TextBox1.Clear()
      78. End Sub
      79. End Class


      Code Client:
      Spoiler anzeigen

      VB.NET-Quellcode

      1. Imports RemoteableObject
      2. Imports System.Runtime.Remoting
      3. Imports System.Runtime.Remoting.Channels
      4. Imports System.Runtime.Remoting.Channels.Tcp
      6. Public Class Client
      7. ''' <summary>
      8. ''' Die lokale Instanz, des RemoteObjekts
      9. ''' </summary>
      10. ''' <remarks></remarks>
      11. Private _remoteObject As MyRemotableObject
      13. Private Sub Form1_Load(sender As System.Object, e As System.EventArgs) Handles MyBase.Load
      14. 'Hier wird ein neuer TcpChannel ohne vorgegebenen Port erstellt, um eine Kommunikation zu ermöglichen.
      15. Dim chan As TcpChannel = New TcpChannel()
      17. 'Vor der ersten Verwendung muss der Channel registriert werden
      18. ChannelServices.RegisterChannel(chan, False)
      20. 'Hier wird das RemoteObjekt vom Server geholt und in _remoteObject gespeichert.
      21. Dim ServerNameOrIP As String = "localhost"
      22. Dim Port As Integer = 1234
      23. Dim ServiceName As String = "SendMessage"
      24. _remoteObject = DirectCast(Activator.GetObject(GetType(MyRemotableObject), String.Concat("tcp://", ServerNameOrIP, ":", Port.ToString, "/", ServiceName)), MyRemotableObject)
      25. End Sub
      27. Private Sub Button1_Click(sender As System.Object, e As System.EventArgs) Handles Button1.Click
      28. 'Hier wird durch die Methode SetMessage, bereits am Server auseführt.
      29. _remoteObject.SetMessage(TextBox1.Text)
      30. End Sub
      32. ''' <summary>
      33. ''' Kann verwendet werden, um die Laufzeit eines Singleton-Objekts aktiv zu verlängern.
      34. ''' </summary>
      35. ''' <param name="Time"></param>
      36. ''' <remarks></remarks>
      37. Private Sub ExtendRemotingLifetime(ByVal Time As TimeSpan)
      38. DirectCast(RemotingServices.GetLifetimeService(_remoteObject), Lifetime.ILease).Renew(Time)
      39. End Sub
      40. End Class


      Die DLL besteht aus drei Dateien.

      Cache.vb
      Spoiler anzeigen

      VB.NET-Quellcode

      1. ''' <summary>
      2. ''' Durch den Cache kann gewährleistet werden, dass alle Aufrufe auf das selbe Instanz zugreifen.
      3. ''' </summary>
      4. ''' <remarks></remarks>
      5. Public Class Cache
      7. ''' <summary>
      8. ''' Die aktuelle Instanz des Cache.
      9. ''' </summary>
      10. ''' <remarks></remarks>
      11. Private Shared myInstance As Cache
      13. ''' <summary>
      14. ''' Das aktuelle IObserver-Objekt.
      15. ''' </summary>
      16. ''' <remarks></remarks>
      17. Public Shared Observer As IObserver
      19. Sub New()
      20. MyBase.New()
      21. End Sub
      23. ''' <summary>
      24. ''' Hängt ein IObserver-Objekt an den Cache.
      25. ''' </summary>
      26. ''' <param name="observer"></param>
      27. ''' <remarks></remarks>
      28. Public Shared Sub Attach(ByRef observer As IObserver)
      29. Cache.Observer = observer
      30. End Sub
      32. ''' <summary>
      33. ''' Holt die aktuelle Instanz oder erstellt eine Neue.
      34. ''' </summary>
      35. ''' <returns></returns>
      36. ''' <remarks></remarks>
      37. Public Shared Function GetInstance() As Cache
      38. If Object.ReferenceEquals(myInstance, Nothing) Then
      39. myInstance = New Cache()
      40. End If
      41. Return myInstance
      42. End Function
      44. 'Diese WriteOnly Eigenschaft wird verwendet, um die Aufrufe vom Client an den Server weiterzuleiten. (Man könnte auch eine Sub verwenden)
      45. Public WriteOnly Property MessageString() As String
      46. Set(value As String)
      47. Observer.Notify(value)
      48. End Set
      49. End Property
      50. End Class


      IObserver.vb
      Spoiler anzeigen

      VB.NET-Quellcode

      1. ''' <summary>
      2. ''' Das IObserver Interface, definiert die Signatur der Methode, die der Server ausführt.
      3. ''' </summary>
      4. ''' <remarks></remarks>
      5. Public Interface IObserver
      6. Sub Notify(ByVal text As String)
      7. End Interface


      MyRemoteableObject.vb
      Spoiler anzeigen

      VB.NET-Quellcode

      1. Imports System.Runtime.Remoting
      2. Imports System.Runtime.Remoting.Channels
      4. ''' <summary>
      5. ''' This Object is used for the Remoting
      6. ''' </summary>
      7. ''' <remarks></remarks>
      8. Public Class MyRemotableObject
      9. Inherits MarshalByRefObject
      11. Public Sub New()
      12. MyBase.New()
      13. End Sub
      15. 'Die Einstellungen der LeaseTime sind die Default-Einstellungen
      17. ''' <summary>
      18. ''' Die Zeit, die ein Singleton Objekt grundsätzlich lebt. (Minuten)
      19. ''' </summary>
      20. ''' <remarks></remarks>
      21. Const TimeToLive As Integer = 5
      23. ''' <summary>
      24. ''' Wann soll abgefragt werden, ob die LeaseTime überschritten wurde. (Sekunden)
      25. ''' </summary>
      26. ''' <remarks></remarks>
      27. Const PollEvery As Integer = 10
      29. ''' <summary>
      30. ''' Um wie viel soll die Zeit, bei einem aufruf durch einen Client, verlängert werden (Minuten)
      31. ''' </summary>
      32. ''' <remarks></remarks>
      33. Const AddForRemoteCall = 2
      35. ''' <summary>
      36. ''' Hiermit kann die Lebensdauer eines Singleton-Objektes bestimmt werden.
      37. ''' </summary>
      38. ''' <returns></returns>
      39. ''' <remarks></remarks>
      40. Public Overrides Function InitializeLifetimeService() As Object
      41. Dim lease As Lifetime.ILease = DirectCast(MyBase.InitializeLifetimeService, Lifetime.ILease)
      42. If lease.CurrentState = Lifetime.LeaseState.Initial Then
      43. lease.InitialLeaseTime = TimeSpan.FromMinutes(5)
      44. lease.SponsorshipTimeout = TimeSpan.FromSeconds(10)
      45. lease.RenewOnCallTime = TimeSpan.FromMinutes(2)
      46. End If
      47. Return lease
      48. End Function
      50. ''' <summary>
      51. ''' SetMessage schreibt den Text des Parameters "message", in die Eigenschaft des Observer-Objekts, das in der aktuellen Instanz von Cache gespeichert wird.
      52. ''' </summary>
      53. ''' <param name="message"></param>
      54. ''' <remarks></remarks>
      55. Public Sub SetMessage(ByVal message As String)
      56. Cache.GetInstance().MessageString = message
      57. End Sub
      59. End Class




      Mit Config-Dateien

      Um Config-Dateien zu verwenden, wird beim Server in der Sub Load folgender Code gelöscht:
      Spoiler anzeigen

      VB.NET-Quellcode

      1. 'Hier wird ein neuer TcpChannel mit dem gewünschten Port erstellt.
      2. Dim channel As TcpChannel = New TcpChannel(PORT)
      4. 'Vor der ersten Verwendung muss der Channel registriert werden
      5. ChannelServices.RegisterChannel(channel, False)
      7. 'Damit die Übertragung funktioniert, muss der Typ, welcher beim Remoting verwendet werden soll, als WellKnownServiceType registriert werden.
      8. 'Man kann diesen auf zwei Arten registrieren. Als Singleton oder SingleCall.
      10. 'SingleCall: Für jeden Aufruf durch einen Client wird eine neue Instanz erstellt. Es werden keine Statusinformationen gespeichert und die Instanz des Objekts
      11. ' wird nach dem Aufruf zerstört und vom GC abgeholt.
      12. RemotingConfiguration.RegisterWellKnownServiceType(GetType(MyRemotableObject), ServiceName, WellKnownObjectMode.SingleCall)
      14. 'Singleton: Ein Instanz, wird für alle Aufrufe durch Clients verwendet. Es können Statusinformationen gespeichert werden.
      15. ' Diese Methode kann verwendet werden, um Daten zwischen zwei Clients austauschen zu können. Die Instanz des Objekts wird nach dem Aufruf nicht zerstört,
      16. ' sondern bleibt noch für eine gewisse Zeit erhalten (Lease-Time).
      17. 'RemotingConfiguration.RegisterWellKnownServiceType(GetType(MyRemotableObject), ServiceName, WellKnownObjectMode.Singleton)
      19. 'Fügt sich selbst dem Cache als IObserver-Objekt hinzu.


      Stattdessen fügt man folgenden Code an dessen Stelle ein:
      Spoiler anzeigen

      VB.NET-Quellcode

      1. 'Lädt die Konfiguration aus der Datei "RemotingServer.config"
      2. RemotingConfiguration.Configure("RemotingServer.config", False)


      Beim Client löscht man (ebenfalls in der Sub Load):
      Spoiler anzeigen

      VB.NET-Quellcode

      1. 'Hier wird ein neuer TcpChannel ohne vorgegebenen Port erstellt, um eine Kommunikation zu ermöglichen.
      2. Dim chan As TcpChannel = New TcpChannel()
      4. 'Vor der ersten Verwendung muss der Channel registriert werden
      5. ChannelServices.RegisterChannel(chan, False)
      7. 'Hier wird das RemoteObjekt vom Server geholt und in _remoteObject gespeichert.
      8. Dim ServerNameOrIP As String = "localhost"
      9. Dim Port As Integer = 1234
      10. Dim ServiceName As String = "SendMessage"
      11. _remoteObject = DirectCast(Activator.GetObject(GetType(MyRemotableObject), String.Concat("tcp://", ServerNameOrIP, ":", Port.ToString, "/", ServiceName)), MyRemotableObject)


      und fügt folgenden Code ein:
      Spoiler anzeigen

      VB.NET-Quellcode

      1. 'Lädt die Konfiguration aus der Datei "RemotingServer.config"
      2. RemotingConfiguration.Configure("RemotingClient.config", False)
      4. 'Erstellt das RemoteObjekt mit der geladenen Konfiguration
      5. _remoteObject = DirectCast(Activator.GetObject(GetType(MyRemotableObject), RemotingConfiguration.GetRegisteredWellKnownClientTypes(0).ObjectUrl), MyRemotableObject)


      Nun legt man eine beim Server eine neue TextDatei mit dem Namen "RemoteServer.config" und beim Client eine neue TextDatei mit dem Namen "RemoteClient.config" an.

      Diese Dateien müssen immer ins Ausgabeverzeichnis kopiert werden.

      in die RemotingServer.config kommt folgendes:
      Spoiler anzeigen

      XML-Quellcode

      1. <configuration>
      2. <system.runtime.remoting>
      3. <application name="RemotingServer">
      4. <service>
      5. <wellknown mode="SingleCall" type="RemoteableObject.MyRemotableObject, RemoteableObject" objectUri="SendMessage"/>
      6. </service>
      7. <channels>
      8. <channel ref="tcp" port="1234">
      9. <serverProviders>
      10. <formatter ref="binary" typeFilterLevel="Full"/>
      11. </serverProviders>
      12. <clientProviders>
      13. <formatter ref="binary"/>
      14. </clientProviders>
      15. </channel>
      16. </channels>
      17. </application>
      18. </system.runtime.remoting>
      19. </configuration>


      in die RemotingClient.config kommt folgendes:
      Spoiler anzeigen

      XML-Quellcode

      1. <configuration>
      2. <system.runtime.remoting>
      3. <application name="RemotingClient">
      4. <client>
      5. <wellknown type="RemoteableObject.MyRemotableObject, RemoteableObject" url="tcp://localhost:1234/SendMessage"/>
      6. </client>
      7. <channels>
      8. <channel ref="tcp" port="0">
      9. <serverProviders>
      10. <formatter ref="binary" typeFilterLevel="Full"/>
      11. </serverProviders>
      12. <clientProviders>
      13. <formatter ref="binary"/>
      14. </clientProviders>
      15. </channel>
      16. </channels>
      17. </application>
      18. </system.runtime.remoting>
      19. </configuration>


      Eine vollständige Erklärung zu den Config-Dateien findet ihr auf MSDN

      Hier noch ein Beispiel Projekt, mit den Config-Dateien: RemotingVBwConfig.zip

      Edit: Getestet in FW 2.0, 3.5 und 4.0.

      Wenn man die DLL (RemoteableObject.dll) mit FW 2.0 erstellt, kann man den Server und den Client mit verschiedenen Frameworks bauen. Somit ist es möglich, den Client mit FW 2.0 zu erstellen (max. Kompatibilität) und den Server mit FW 4.0 (max. Funktionalität).
      SWYgeW91IGNhbiByZWFkIHRoaXMsIHlvdSdyZSBhIGdlZWsgOkQ=

      Weil einfach, einfach zu einfach ist! :D

      Dieser Beitrag wurde bereits 1 mal editiert, zuletzt von „BiedermannS“ ()