.NET port of LMAX Disruptor

Port of LMAX Disruptor to .NET

Description

This project aims to provide the full functionality of the Disruptor to CLR projects.

Programming language: C#

License: GNU General Public License v3.0 or later

Tags: Concurrency     Performance     Threading     Queues     Multi-threading     Zero-allocation    

Latest version: v4.0

README

Disruptor-net

Overview

The Disruptor is a high performance inter-thread message passing framework. This project is the .NET port of LMAX Disruptor.

The Disruptor can be succinctly defined as a circular queue with a configurable sequence of consumers. The key features are:

• Zero memory allocation after initial setup (the events are pre-allocated).
• Push-based consumers.
• Optionally lock-free.
• Configurable wait strategies.

Most of the information from the Java documentation is applicable to the .NET version, especially the core concepts.

The quickest way to get started with the disruptor is by using the NuGet package.

Sample code

First, you need to define your event (message) type:

public class SampleEvent
{
    public int Id { get; set; }
    public double Value { get; set; }
}

You also need to create a consumer:

public class SampleEventHandler : IEventHandler<SampleEvent>
{
    public void OnEvent(SampleEvent data, long sequence, bool endOfBatch)
    {
        Console.WriteLine($"Event: {data.Id} => {data.Value}");
    }
}

Then you can setup the Disruptor:

var disruptor = new Disruptor<SampleEvent>(() => new SampleEvent(), bufferSize: 1024);

disruptor.HandleEventsWith(new SampleEventHandler());

disruptor.Start();

Finally, you can publish events:

using (var scope = disruptor.PublishEvent())
{
    var data = scope.Event();
    data.Id = 42;
    data.Value = 1.1;
}

Other event publication options are described in the Wiki.

Roadmap

• Include latest changes made to the future Java versions
• Remove exception-based APIs
• Improve documentation

Build from source and run tests

You may build the Disruptor directly from the source, run Cake-Build.bat: it will compile, run the tests and output binaries and results into \output\assembly folder You can also run all the performance tests by running Cake-Perf.bat.

License

Copyright Olivier Deheurles

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License.

You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.