Acl.CommStreamLog 4.1.0

Acl.CommStreamLog

A binary communication-stream log library. It persists the raw binary payloads exchanged between communicating peers into self-describing binary files, supporting per-hour / per-day / permanent storage, automatic rollover by size or record count, expiry cleanup, memory-mapped fast reading, and a pluggable parser framework.

Usage

using System;
using System.Threading;
using Acl.CommStreamLog;
using Acl.CommStreamLog.Data;
using Acl.CommStreamLog.IO;

// 1. Configure and create a writer (writers with the same LogKey are reused).
var settings = LogFileSettings.Create("ATS-ATP", @"D:\ATS\CommLog", 0x1001, 0x2001);
settings.StorageType = StorageType.Daily;   // SharpHourly / Daily / Permanent
settings.ExpiredDays = 7;
settings.MaxFileSize = 8 * 1024 * 1024;     // optional rollover threshold

var writer = CommStreamLogManager.CreateLogWriter(settings);

// 2. Write a record (payload <= 64 KB).
var record = CommStreamLogFile.NewRecord();
record.Content = payloadBytes;              // raw communication bytes
record.Header.Direction = StreamDirection.Input;
record.Header.TimeStamp = DateTime.Now;
writer.Write(record);

// 3. Dispose all writers before process exit.
CommStreamLogManager.Close();

Reading back:

using var reader = CommStreamLogManager.CreateFileStreamLogReader(@"D:\ATS\CommLog\... .commStreamLog");
var fileHeader = await reader.ReadFileHeaderAsync(CancellationToken.None);
await reader.ReadRecordHeadersAsync(CancellationToken.None);  // build the record index
var record = reader.GetRecord(0);                             // random access by index

A memory-mapped reader is available via CommStreamLogManager.CreateMemMappedLogReader(path).

Parser framework

Parsers are external assemblies that implement ICommLogRecordParser (or IPayloadLogRecordParser / IBytesParserSimilarityMatchable). They are auto-discovered by ParserManager.LoadParsers(paths) and can also be added globally through parsers\load.json next to the application:

{
  "extraPaths": [
    { "path": "D:\\Parsers", "includeSubDirectories": true },
    { "path": "D:\\ATS\\",   "includeSubDirectories": false }
  ]
}

License

MIT. See the repository root for the full license and the in-depth documentation.