ObjectDeliverer CSharp

ObjectDeliverer-CSharp

NuGet-Pakete

https://www.nuget.org/packages/ObjectDeliverer/

Um mit NuGet zu installieren, installieren Sie einfach das ObjectDeliverer-Paket:

 Install-Package ObjectDeliverer

Beschreibung

ObjectDeliverer ist eine Datenübertragungs-/Empfangsbibliothek für C#.

Es handelt sich um eine gleichnamige Schwesterbibliothek für UE4.

https://github.com/ayumax/ObjectDeliverer

Es verfügt über die folgenden Funktionen.

• Kommunikationsprotokoll, Datenaufteilungsregel und Serialisierungsmethode können durch Teileaustausch umgeschaltet werden.
• Es ist auch möglich, eine eigene Methode zur Objektserialisierung anzuwenden

Kommunikationsprotokoll

Die folgenden Protokolle können mit integrierter Funktion verwendet werden. Sie können auch Ihr eigenes Protokoll hinzufügen.

• TCP/IP-Server (mit mehreren Clients verbindbar)
• TCP/IP-Client
• UDP (Absender)
• UDP (Empfänger)
• Gemeinsamer Speicher
• LogFile Writer
• LogFile-Reader

Datenteilungsregel

Die folgenden Regeln stehen für integrierte Aufteilungsregeln für gesendete und empfangene Daten zur Verfügung.

• Feste Größe
  Beispiel) Bei festen 1024 Bytes

• Header(BodySize) + Body
  Beispiel) Wenn der Größenbereich 4 Byte beträgt
  

• Aufteilung nach Terminalsymbol
  Beispiel) Wenn 0x00 das Ende ist

Serialisierungsmethode

• Byte-Array
• UTF-8-Zeichenfolge
• Objekt (Json)

Schnellstart

Erstellen Sie ObjectDelivererManager und erstellen Sie verschiedene Kommunikationspfade, indem Sie „Communication Protocol“, „Packet Split Rule“ und „Serialization Method“ an die Argumente der StartAsync-Methode übergeben.

 // Create an ObjectDelivererManager
var deliverer = new ObjectDelivererManager < string > ( ) ;

// Watching for connection events
deliverer . Connected . Subscribe ( async x =>
{
    Console . WriteLine ( "connected" ) ;

    // Sending data to a connected party
    await deliverer . SendAsync ( new byte [ ] { 0x00 , 0x12 } ) ;
    await deliverer . SendAsync ( new byte [ ] { 0x00 , 0x12 , 0x23 } ) ;
} ) ;

// Watching for disconnection events
deliverer . Disconnected . Subscribe ( x => Console . WriteLine ( "disconnected" ) ) ;
	    
// Watching for incoming events
deliverer . ReceiveData . Subscribe ( x => 
{
    Console . WriteLine ( $ "received buffer length = { x . Buffer . Length } " ) ;
    Console . WriteLine ( $ "received message = { x . Message } " ) ;
} ) ;

// Start the ObjectDelivererManager
await deliverer . StartAsync (
    new ProtocolTcpIpClient ( ) { IpAddress = "127.0.0.1" , Port = 9013 } ,
    new PacketRuleFixedLength ( ) { FixedSize = 10 } ,
    new DeliveryBoxString ( ) ) ;

Kommunikationsprotokoll ändern

Sie können zu verschiedenen Kommunikationsprotokollen wechseln, indem Sie das an die StartAsync-Methode übergebene Protokoll ändern.

 // TCP/IP Client
await deliverer . StartAsync (
    new ProtocolTcpIpClient ( ) { IpAddress = "127.0.0.1" , Port = 9013 } ,
    new PacketRuleFixedLength ( ) { FixedSize = 10 } ) ;

// TCP/IP Server
await deliverer . StartAsync (
    new ProtocolTcpIpServer ( ) { ListenPort = 9013 } ,
    new PacketRuleFixedLength ( ) { FixedSize = 10 } ) ;

// UDP Sender
await deliverer . StartAsync (
    new ProtocolUdpSocketSender ( ) { DestinationIpAddress = "127.0.0.1" , DestinationPort = 9013 } ,
    new PacketRuleFixedLength ( ) { FixedSize = 10 } ) ;

// UDP Receiver
await deliverer . StartAsync (
    new ProtocolUdpSocketReceiver ( ) { BoundPort = 9013 } ,
    new PacketRuleFixedLength ( ) { FixedSize = 10 } ) ;

// SharedMemory
await deliverer . StartAsync (
    new ProtocolSharedMemory ( ) { SharedMemoryName = "SharedMemory" , SharedMemorySize = 1024 } ,
    new PacketRuleFixedLength ( ) { FixedSize = 10 } ) ;

// Log File Writer
await deliverer . StartAsync (
    new ProtocolLogWriter ( ) { FilePath = @"C:logcomlog.txt" } ,
    new PacketRuleFixedLength ( ) { FixedSize = 10 } ) ;

// Log File Reader
await deliverer . StartAsync (
    new ProtocolLogReader ( ) { FilePath = @"C:logcomlog.txt" } ,
    new PacketRuleFixedLength ( ) { FixedSize = 10 } ) ;

Änderung der Datenaufteilungsregel

Sie können die Paketaufteilungsregel ganz einfach ändern.

 // FixedSize
await deliverer . StartAsync (
    new ProtocolTcpIpClient ( ) { IpAddress = "127.0.0.1" , Port = 9013 } ,
    new PacketRuleFixedLength ( ) { FixedSize = 10 } ) ;

// Header(BodySize) + Body
await deliverer . StartAsync (
    new ProtocolTcpIpClient ( ) { IpAddress = "127.0.0.1" , Port = 9013 } ,
    new PacketRuleSizeBody ( ) { SizeLength = 4 , SizeBufferEndian = ECNBufferEndian . Big } ) ;

// Split by terminal symbol
await deliverer . StartAsync (
        new ProtocolTcpIpClient ( ) { IpAddress = "127.0.0.1" , Port = 9013 } ,
        new PacketRuleTerminate ( ) { Terminate = new byte [ ] { 0xFE , 0xFF } } ) ;

// Nodivision
await deliverer . StartAsync (
    new ProtocolTcpIpClient ( ) { IpAddress = "127.0.0.1" , Port = 9013 } ,
    new PacketRuleNodivision ( ) ) ;

Änderung der Serialisierungsmethode

Die Verwendung von DeliveryBox ermöglicht das Senden und Empfangen nicht-binärer Daten (Zeichenfolgen und Objekte).

 // UTF-8 string
var deliverer = new ObjectDelivererManager < string > ( ) ;

await deliverer . StartAsync (
    new ProtocolTcpIpClient ( ) { IpAddress = "127.0.0.1" , Port = 9013 } ,
    new PacketRuleFixedLength ( ) { FixedSize = 10 } ,
    new DeliveryBoxString ( ) ) ;

deliverer . ReceiveData . Subscribe ( x => Console . WriteLine ( x . Message ) ) ;

await deliverer . SendMessageAsync ( "ABCDEFG" ) ; 

 // Object
public class SampleObj
{
    public int Prop { get ; set ; }
    public string StringProp { get ; set ; }

    public string Hoge ( ) => $ " { Prop } _ { StringProp } " ;
}

var deliverer = new ObjectDelivererManager < SampleObj > ( ) ;

await deliverer . StartAsync (
    new ProtocolTcpIpClient ( ) { IpAddress = "127.0.0.1" , Port = 9013 } ,
    new PacketRuleSizeBody ( ) { SizeLength = 4 , SizeBufferEndian = ECNBufferEndian . Big } ,
    new DeliveryBoxObjectJson < SampleObj > ( ) ) ;

deliverer . ReceiveData . Subscribe ( x => Console . WriteLine ( x . Message . Hoge ( ) ) ) ;

var sampleObj = new SampleObj ( ) { Prop = 1 , StringProp = "abc" } ;
await deliverer . SendMessageAsync ( sampleObj ) ;

Erstellen einer benutzerdefinierten DeliveryBox

Sie können eine DeliveryBox mit Ihrer eigenen Serialisierungsmethode erstellen.

Bsp.) Beim Anwenden eines Serialisierers mit MessagePack (https://github.com/neuecc/MessagePack-CSharp)

 [ MessagePackObject ]
public class SampleObj2
{
    [ Key ( 0 ) ]
    public int Prop { get ; set ; }

    [ Key ( 1 ) ]
    public string StringProp { get ; set ; }

    public string Hoge ( ) => $ " { Prop } _ { StringProp } " ;
}

// Definition of DeliveryBox using MessagePack
public class ObjectDeliveryBoxUsingMessagePack < T > : IDeliveryBox < T >
{
    public override ReadOnlyMemory < byte > MakeSendBuffer ( T message ) => MessagePackSerializer . Serialize ( message ) ;

    public override T BufferToMessage ( ReadOnlyMemory < byte > buffer ) => MessagePackSerializer . Deserialize < T > ( buffer ) ;
}

var deliverer = new ObjectDelivererManager < SampleObj2 > ( ) ;

await deliverer . StartAsync (
    new ProtocolTcpIpClient ( ) { IpAddress = "127.0.0.1" , Port = 9013 } ,
    new PacketRuleSizeBody ( ) { SizeLength = 4 , SizeBufferEndian = ECNBufferEndian . Big } ,
    new ObjectDeliveryBoxUsingMessagePack < SampleObj2 > ( ) ) ;

deliverer . ReceiveData . Subscribe ( x => Console . WriteLine ( x . Message . Hoge ( ) ) ) ;

var sampleObj = new SampleObj2 ( ) { Prop = 1 , StringProp = "abc" } ;
await deliverer . SendMessageAsync ( sampleObj ) ;