Dreamine.Communication.Core 1.0.0

Dreamine.Communication.Core

Dreamine.Communication.Core is part of the Dreamine Communication package family.

This package provides the common runtime layer used by concrete communication adapters. It does not implement TCP, Serial, RabbitMQ, or WPF directly. Concrete transports should depend on this package and combine a protocol adapter with a frame codec.

➡️ 한국어 문서 보기

Description

Core message bus, routing, serialization, protocol adaptation, message framing, and transport-to-message-bus adapter utilities for Dreamine Communication.

Package Role

Dreamine.Communication.Abstractions
    ↑
Dreamine.Communication.Core
    ↑
Sockets / Serial / RabbitMQ / WPF

Core owns the transport-independent rules:

• How a MessageEnvelope is serialized.
• How an external payload is converted to a MessageEnvelope.
• How a byte stream is split into message frames.
• How messages are routed or published inside the application.

It must not own socket connection logic, serial port logic, RabbitMQ connection logic, or WPF UI logic.

Features

• In-memory message bus
• Message route dispatcher
• MessageEnvelope JSON serialization
• Protocol adapters for internal and external payload formats
• Stream frame codecs for TCP-like byte streams
• Transport-to-message-bus adapter

Main Components

Message Bus

Routing

Serialization

Protocol Adapters

Protocol adapters convert between raw payload bytes and Dreamine MessageEnvelope instances.

Frame Codecs

Frame codecs define how message boundaries are detected on a byte stream.

Frame Codec Selection Guide

RawAvailableMessageFrameCodec

RawAvailableMessageFrameCodec is a compatibility codec for simple raw byte receive scenarios. It reads the bytes returned by the underlying stream read operation and immediately returns them as a single frame.

This is useful when an external tool sends a simple string such as:

test1

without:

• a length prefix
• CRLF
• LF
• a fixed JSON envelope

Example usage:

using System.Text;
using Dreamine.Communication.Core.Framing;
using Dreamine.Communication.Core.Protocols;
using Dreamine.Communication.Sockets.Options;
using Dreamine.Communication.Sockets.Servers;

var server = new TcpServerTransport(
    new TcpServerTransportOptions
    {
        Host = "127.0.0.1",
        Port = 15002
    },
    new PlainTextProtocolAdapter(
        Encoding.UTF8,
        "tcp.raw.available",
        "Tcp.RawAvailable"),
    new RawAvailableMessageFrameCodec());

server.MessageReceived += (_, message) =>
{
    var text = Encoding.UTF8.GetString(message.Payload);
    Console.WriteLine($"RX: {text}");
};

await server.ConnectAsync();

Important TCP Note

TCP is a stream protocol, not a message protocol. RawAvailableMessageFrameCodec is intentionally permissive, but it does not guarantee application-level message boundaries.

For example, two quick sends may arrive as:

test1test2

or one send may be split as:

te
st1

Therefore, use RawAvailableMessageFrameCodec only for compatibility, debugging, temporary tests, or tools that do not provide framing. For production protocols, prefer LengthPrefixedMessageFrameCodec or DelimiterMessageFrameCodec.

Recommended Protocol Combinations

Design Principles

• Keep concrete transport implementations isolated from upper layers.
• Depend on Dreamine.Communication.Abstractions contracts.
• Keep package responsibilities small and explicit.
• Preserve one-way dependency flow.
• Separate payload protocol conversion from stream frame detection.
• Allow future adapters and codecs to be added without changing application logic.

Dependencies

• Dreamine.Communication.Abstractions

Target Framework

net8.0

Related Packages

• Dreamine.Communication.Abstractions
• Dreamine.Communication.Core
• Dreamine.Communication.Sockets
• Dreamine.Communication.Serial
• Dreamine.Communication.RabbitMQ
• Dreamine.Communication.FullKit
• Dreamine.Communication.Wpf

Text Encoding Policy

Text encoding is handled at the protocol adapter boundary when raw external bytes are converted to a MessageEnvelope, or when a MessageEnvelope payload is converted back to external bytes.

Encoding options are intended for external byte-based communication:

• TCP
• UDP
• Serial

PlainTextProtocolAdapter and RawJsonProtocolAdapter can be configured with an external text encoding such as UTF-8 or CP949. UTF-8 is recommended for modern systems. CP949 is useful when interoperating with legacy Windows tools, Korean industrial equipment, or test tools that do not send UTF-8 text.

InMemoryMessageBus does not need text encoding because it passes MessageEnvelope objects inside the same process. RabbitMQ also does not expose this option in the default Dreamine flow because the adapter serializes MessageEnvelope data as UTF-8 JSON.

License

This project is licensed under the MIT License.