ObjectDeliverer CSharp

ObjectDeliverer-CSharp

Forfaits NuGet

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

Pour installer avec NuGet, installez simplement le package ObjectDeliverer :

 Install-Package ObjectDeliverer

Description

ObjectDeliverer est une bibliothèque de transmission/réception de données pour C#.

Il s'agit d'une bibliothèque sœur du même nom pour UE4.

https://github.com/ayumax/ObjectDeliverer

Il présente les caractéristiques suivantes.

• Le protocole de communication, la règle de division des données et la méthode de sérialisation peuvent être commutés par remplacement de pièces.
• Il est également possible d'appliquer votre propre méthode de sérialisation d'objets

Protocole de communication

Les protocoles suivants peuvent être utilisés avec le protocole intégré. Vous pouvez également ajouter votre propre protocole.

• Serveur TCP/IP (connectable à plusieurs clients)
• Client TCP/IP
• UDP (expéditeur)
• UDP (récepteur)
• Mémoire partagée
• Auteur de fichiers journaux
• Lecteur de fichiers journaux

Règle de division des données

Les règles suivantes sont disponibles pour les règles de répartition intégrées des données transmises et reçues.

• Taille fixe
  Exemple) Dans le cas de 1024 octets fixes

• En-tête (BodySize) + Corps
  Exemple) Lorsque la zone de taille est de 4 octets
  

• Divisé par symbole de terminal
  Exemple) Quand 0x00 est la fin

Méthode de sérialisation

• Tableau d'octets
• Chaîne UTF-8
• Objet (Json)

Démarrage rapide

Créez ObjectDelivererManager et créez divers chemins de communication en passant « Protocole de communication », « Règle de division de paquets » et « Méthode de sérialisation » aux arguments de la méthode StartAsync.

 // 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 ( ) ) ;

Changer le protocole de communication

Vous pouvez basculer vers différents protocoles de communication en modifiant le protocole transmis à la méthode StartAsync.

 // 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 } ) ;

Changement de règle de division des données

Vous pouvez facilement modifier la règle de répartition des paquets.

 // 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 ( ) ) ;

Changement de méthode de sérialisation

L'utilisation de DeliveryBox permet l'envoi et la réception de données non binaires (chaînes de caractères et objets).

 // 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 ) ;

Création d'une DeliveryBox personnalisée

Vous pouvez créer une DeliveryBox avec votre propre méthode de sérialisation.

Ex) Lors de l'application d'un sérialiseur à l'aide de 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 ) ;