ObjectDeliverer CSharp

ObjectDeliverer-CSharp

Pacotes NuGet

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

Para instalar com NuGet, basta instalar o pacote ObjectDeliverer:

 Install-Package ObjectDeliverer

Descrição

ObjectDeliverer é uma biblioteca de transmissão/recepção de dados para C#.

É uma biblioteca irmã com o mesmo nome do UE4.

https://github.com/ayumax/ObjectDeliverer

Possui os seguintes recursos.

• Protocolo de comunicação, regra de divisão de dados e método de serialização podem ser alterados por substituição de peças.
• Também é possível aplicar seu próprio método de serialização de objetos

Protocolo de comunicação

Os seguintes protocolos podem ser usados ​​com built-in. Você também pode adicionar seu próprio protocolo.

• Servidor TCP/IP (conectável a vários clientes)
• Cliente TCP/IP
• UDP (remetente)
• UDP (Receptor)
• Memória Compartilhada
• Gravador de arquivo de log
• Leitor de arquivos de log

Regra de divisão de dados

As regras a seguir estão disponíveis para regras de divisão integradas de dados transmitidos e recebidos.

• Tamanho fixo
  Exemplo) No caso de 1024 bytes fixos

• Cabeçalho (BodySize) + Corpo
  Exemplo) Quando o tamanho da área é de 4 bytes
  

• Dividir por símbolo de terminal
  Exemplo) Quando 0x00 é o fim

Método de serialização

• Matriz de Bytes
• Sequência UTF-8
• Objeto (Json)

Início rápido

Crie ObjectDelivererManager e crie vários caminhos de comunicação passando "Protocolo de Comunicação", "Regra de Divisão de Pacotes" e "Método de Serialização" para os argumentos do método 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 ( ) ) ;

Alterar protocolo de comunicação

Você pode alternar para vários protocolos de comunicação alterando o protocolo passado para o método 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 } ) ;

Alteração da regra de divisão de dados

Você pode alterar facilmente a regra de divisão de pacotes.

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

Mudança de método de serialização

O uso do DeliveryBox permite o envio e recebimento de dados não binários (sequências de caracteres e objetos).

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

Criando um DeliveryBox personalizado

Você pode criar um DeliveryBox com seu próprio método de serialização.

Ex) Ao aplicar um serializador usando 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 ) ;