https://github.com/disruptor-net/Disruptor-net

Port of LMAX Disruptor to .NET
https://github.com/disruptor-net/Disruptor-net

Last synced: 7 days ago
JSON representation

Port of LMAX Disruptor to .NET

• Host: GitHub
• URL: https://github.com/disruptor-net/Disruptor-net
• Owner: disruptor-net
• License: other
• Created: 2011-12-18T20:38:00.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2024-02-24T14:57:09.000Z (9 months ago)
• Last Synced: 2024-11-04T18:12:14.016Z (8 days ago)
• Language: C#
• Homepage:
• Size: 14.1 MB
• Stars: 1,197
• Watchers: 106
• Forks: 226
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-dot-net-performance - Disruptor-Net - .NET port of LMAX Disruptor, a faster alternative to BlockingCollection. (High Performance Libraries / Application Insights)

README

        
# Disruptor-net

[![Build](https://github.com/Disruptor-net/Disruptor-net/workflows/Build/badge.svg)](https://github.com/Disruptor-net/Disruptor-net/actions?query=workflow%3ABuild)

[![NuGet](https://buildstats.info/nuget/Disruptor)](http://www.nuget.org/packages/Disruptor/)

## Overview

The Disruptor is a high performance inter-thread message passing framework. This project is the .NET port of [LMAX Disruptor](https://github.com/LMAX-Exchange/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](https://github.com/disruptor-net/Disruptor-net/wiki/Event-Handlers).

- Optionally lock-free.

- Configurable [wait strategies](https://github.com/disruptor-net/Disruptor-net/wiki/Wait-Strategies).

## Release notes

[Version 5.0.0](https://github.com/disruptor-net/Disruptor-net/releases/tag/5.0.0) has been released and is available on [NuGet](https://www.nuget.org/packages/Disruptor).

## Supported runtimes

- .NET 5.0+

- .NET Standard 2.1

## Basic usage

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

```cs

public class SampleEvent

{

    public int Id { get; set; }

    public double Value { get; set; }

}

```

You also need to create a consumer:

```cs

public class SampleEventHandler : IEventHandler

{

    public void OnEvent(SampleEvent data, long sequence, bool endOfBatch)

    {

        Console.WriteLine($"Event: {data.Id} => {data.Value}");

    }

}

```

Then you can setup the Disruptor:

```cs

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

disruptor.HandleEventsWith(new SampleEventHandler());

disruptor.Start();

```

Finally, you can publish events:

```cs

using (var scope = disruptor.PublishEvent())

{

    var data = scope.Event();

    data.Id = 42;

    data.Value = 1.1;

}

```

Go to the wiki for a [more detailed introduction](https://github.com/disruptor-net/Disruptor-net/wiki/Getting-Started).

## 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.