Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
Signed-off-by: Tomasz Maruszak <maruszaktomasz@gmail.com>
  • Loading branch information
zarusz committed Sep 10, 2023
1 parent a72d80c commit 7e4b2e7
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

- [About](#about)
- [Configuration](#configuration)
- [Transport](#transport)
- [IP / UDP Transport](#ip--udp-transport)
- [Serialization](#serialization)
- [JSON Serialization](#json-serialization)
- [Cluster Persistence](#cluster-persistence)
- [Local File Persistence](#local-file-persistence)
- [Transport](#transport)
- [IP / UDP Transport](#ip--udp-transport)
- [Serialization](#serialization)
- [JSON Serialization](#json-serialization)
- [Cluster Persistence](#cluster-persistence)
- [Local File Persistence](#local-file-persistence)
- [Cluster Membership](#cluster-membership)
- [SWIM Membership](#swim-membership)
- [Static Membership](#static-membership)
Expand Down Expand Up @@ -70,15 +70,15 @@ As part of the configuration we can set:
SlimCluster registers as an `IHostedService` that works with MS Hosting abstraction.
This ensures the cluster starts when any [NET Generic Host](https://learn.microsoft.com/en-us/dotnet/core/extensions/generic-host) compatible runtime starts (ASP.NET Core application).

## Transport
# Transport

Package: [SlimCluster.Transport](https://www.nuget.org/packages/SlimCluster.Transport)

The transport allows the Nodes in the cluster to exchange protocol messages.

Currently the only possible transport option is IP protocol, where the inter-Node communication happens using UDP sockets.

### IP / UDP Transport
## IP / UDP Transport

Package: [SlimCluster.Transport.Ip](https://www.nuget.org/packages/SlimCluster.Transport.Ip)

Expand All @@ -102,7 +102,7 @@ In this scenario consensus (Raft) and membership (SWIM) protocol messages go thr
The `MulticastGroupAddress` property allows to set the multicast group used in the initial member discovery.
In the future there will be also option to avoid multicast groups.

## Serialization
# Serialization

Package: [SlimCluster.Serialization](https://www.nuget.org/packages/SlimCluster.Serialization)

Expand All @@ -113,7 +113,7 @@ In the near future there are plans to add [ProtoBuf](https://github.com/protocol

To write a custom serializer, simply provide and implementation for [ISerializer](../src/SlimCluster.Serialization/ISerializer.cs) in the MSDI container.

### JSON Serialization
## JSON Serialization

Package: [SlimCluster.Serialization.Json](https://www.nuget.org/packages/SlimCluster.Serialization.Json)

Expand All @@ -122,7 +122,7 @@ Package: [SlimCluster.Serialization.Json](https://www.nuget.org/packages/SlimClu
cfg.AddJsonSerialization();
```

## Cluster Persistence
# Cluster Persistence

Package: [SlimCluster.Persistence](https://www.nuget.org/packages/SlimCluster.Persistence)

Expand All @@ -140,7 +140,7 @@ In the near future there are plans to add some connectors to Cloud Provider stor

To write a custom state persitence strategy, simply provide and implementation for [IClusterPersistenceService](../src/SlimCluster.Persistence/IClusterPersistenceService.cs) in the MSDI container.

### Local File Persistence
## Local File Persistence

Package: [SlimCluster.Persistence.LocalFile](https://www.nuget.org/packages/SlimCluster.Persistence.LocalFile)

Expand Down

0 comments on commit 7e4b2e7

Please sign in to comment.