Akka.NET

https://getakka.net/api/
Admin
Akka.NET is a toolkit and runtime for building highly concurrent, distributed, and resilient...
Tokens:1,831,443
Snippets:19,445
Trust Score:9.1
Update:5 months ago
Show doc for...
Tokens:
Raw
### Setup Property

Source: https://getakka.net/api/Akka.Actor.Settings.html

Gets the ActorSystemSetup used for bootstrapping this ActorSystem.

```csharp
public ActorSystemSetup Setup { get; }
```

--------------------------------

### Get a specific setup configuration

Source: https://getakka.net/api/Akka.Actor.Setup.ActorSystemSetup.html

Use the Get method to retrieve an Option containing a specific Setup instance from the ActorSystemSetup. Returns Option.None if the setup is not present.

```csharp
public Option<T> Get<T>() where T : Setup
```

--------------------------------

### Actor PreStart Override

Source: https://getakka.net/api/Akka.Actor.Dsl.Act.html

Override this method to perform setup actions when an actor is started. Actors are started asynchronously when created.

```csharp
protected override void PreStart()
```

--------------------------------

### Setup

Source: https://getakka.net/api/Akka.Actor.Settings.html

The setup used to help bootstrap this ActorSystem.

```APIDOC
## Setup

### Description
The setup used to help bootstrap this ActorSystem.

### Property Value
Type: ActorSystemSetup
```

--------------------------------

### And Method for Combining Setups

Source: https://getakka.net/api/Akka.Actor.Setup.Setup.html

Combines the current setup with another setup instance to create a new ActorSystemSetup. This allows for fluent construction of settings.

```csharp
public ActorSystemSetup And(Setup other)
```

--------------------------------

### ActorSystemSetup.And<T>(T setup)

Source: https://getakka.net/api/Akka.Actor.Setup.ActorSystemSetup.html

Adds a setup to the current ActorSystemSetup, replacing any existing setup of the same type.

```APIDOC
## ActorSystemSetup.And<T>(T setup)

### Description
This is a shortcut method for chaining the fluent interface. It adds a `Setup` object to the `ActorSystemSetup`. If a setup of the same type already exists, it will be replaced.

### Method
`public ActorSystemSetup And<T>(T setup) where T : Setup`

### Parameters
Type | Name | Description
---|---|---
T | setup | The `Setup` object to add. If a setting of the same type is already present, it will be replaced.

### Returns
Type | Description
---|---
ActorSystemSetup | A new, immutable `ActorSystemSetup` instance with the added setup.

### Type Parameters
Name | Description
---|---
T | The type of `Setup` being added.
```

--------------------------------

### Start()

Source: https://getakka.net/api/Akka.Actor.Internal.ActorSystemImpl.html

Starts the actor system.

```APIDOC
## Start()

### Description
Starts this system.

### Method
```csharp
public void Start()
```
```

--------------------------------

### ActorSystemSetup.Create(params Setup[])

Source: https://getakka.net/api/Akka.Actor.Setup.ActorSystemSetup.html

Factory method to create a new ActorSystemSetup instance with the provided setups.

```APIDOC
## ActorSystemSetup.Create(params Setup[])

### Description
Creates a new ActorSystemSetup instance initialized with the given array of `Setup` objects.

### Method
`public static ActorSystemSetup Create(params Setup[] setup)`

### Parameters
Type | Name | Description
---|---|---
Setup[] | setup | An array of `Setup` objects to initialize the `ActorSystemSetup` with.

### Returns
Type | Description
---|---
ActorSystemSetup | A new `ActorSystemSetup` instance.
```

--------------------------------

### Setup.And Method

Source: https://getakka.net/api/Akka.Actor.Setup.Setup.html

Combines the current setup configuration with another setup configuration. This method allows for fluent construction of ActorSystemSetup instances.

```APIDOC
## And(Setup)

### Description
Construct an ActorSystemSetup with this setup combined with another one. Allows for fluent creation of settings.

### Method
public ActorSystemSetup And(Setup other)

### Parameters
#### Path Parameters
- **other** (Setup) - Required - If other is of the same concrete Setup type as this, it will replace this.

### Returns
#### Success Response
- **ActorSystemSetup** - A new ActorSystemSetup instance.
```

--------------------------------

### Setup Class Syntax

Source: https://getakka.net/api/Akka.Actor.Setup.Setup.html

Defines the abstract Setup class, which is the base for all setup configurations in Akka.Actor.Setup.

```csharp
public abstract class Setup
```

--------------------------------

### Create ActorSystemSetup with multiple setups

Source: https://getakka.net/api/Akka.Actor.Setup.ActorSystemSetup.html

Use the Create method to initialize an ActorSystemSetup with an array of Setup objects. This is a static factory method.

```csharp
public static ActorSystemSetup Create(params Setup[] setup)
```

--------------------------------

### Start a New ActorSystem

Source: https://getakka.net/api/Akka.Remote.TestKit.MultiNodeSpec.html

This protected method is used to start a new ActorSystem instance. It's typically called within the test setup to create isolated environments for testing.

```csharp
protected ActorSystem StartNewSystem()
```

--------------------------------

### ActorSystemSetup.WithSetup<T>(T setup)

Source: https://getakka.net/api/Akka.Actor.Setup.ActorSystemSetup.html

Adds or replaces a specific setup configuration within the ActorSystemSetup.

```APIDOC
## ActorSystemSetup.WithSetup<T>(T setup)

### Description
Adds a concrete `Setup` configuration to the `ActorSystemSetup`. If a setup of the same type already exists, it will be replaced. This method is called internally by `And<T>(T)`.

### Method
`public ActorSystemSetup WithSetup<T>(T setup) where T : Setup`

### Parameters
Type | Name | Description
---|---|---
T | setup | The `Setup` object to add or replace. If a setting of the same type is already present, it will be replaced.

### Returns
Type | Description
---|---
ActorSystemSetup | A new, immutable `ActorSystemSetup` instance with the updated setup.

### Type Parameters
Name | Description
---|---
T | The type of `Setup` being added or replaced.
```

--------------------------------

### LmdbDurableStore.PreStart() Method

Source: https://getakka.net/api/Akka.DistributedData.LightningDB.LmdbDurableStore.html

User overridable callback called when an Actor is started. Actors are automatically started asynchronously when created. It has an empty default implementation.

```APIDOC
## LmdbDurableStore.PreStart()

### Description
User overridable callback invoked when the actor is started. This is where initialization logic can be placed.

### Overrides
ActorBase.PreStart()
```

--------------------------------

### Start() Method Declaration

Source: https://getakka.net/api/Akka.Cluster.Sharding.IStartableAllocationStrategy.html

The Start() method is called by the shard coordinator before any calls to allocate or rebalance shards. It is intended for asynchronous initialization and should not block. Any asynchronous operations started here can delay the Futures returned by allocate/rebalance.

```csharp
void Start()
```

--------------------------------

### Chain setup configurations fluently

Source: https://getakka.net/api/Akka.Actor.Setup.ActorSystemSetup.html

The And method provides a shortcut for chaining setup configurations, internally calling WithSetup. It's useful for a fluent interface.

```csharp
public ActorSystemSetup And<T>(T setup) where T : Setup
```

--------------------------------

### Start()

Source: https://getakka.net/api/Akka.Actor.ActorCell.html

Starts the actor instance. This method is responsible for initiating the actor's lifecycle.

```APIDOC
## Start()

### Description
Starts this instance. This method is responsible for initiating the actor's lifecycle.

### Declaration
```csharp
public virtual void Start()
```
```

--------------------------------

### Add or replace a specific setup configuration

Source: https://getakka.net/api/Akka.Actor.Setup.ActorSystemSetup.html

Use the WithSetup method to add a specific Setup instance to the ActorSystemSetup. If a setup of the same type already exists, it will be replaced. This method returns a new immutable instance.

```csharp
public ActorSystemSetup WithSetup<T>(T setup) where T : Setup
```

--------------------------------

### LogConfigOnStart

Source: https://getakka.net/api/Akka.Actor.Settings.html

Gets a value indicating whether the configuration is logged on start.

```APIDOC
## LogConfigOnStart

### Description
Gets a value indicating whether [log configuration on start].

### Declaration
```csharp
public bool LogConfigOnStart { get; }
```

### Property Value
Type | Description
---|---
bool | `true` if [log configuration on start]; otherwise, `false`.
```

--------------------------------

### Start Method

Source: https://getakka.net/api/Akka.Cluster.Sharding.IActorSystemDependentAllocationStrategy.html

Called before any calls to allocate/rebalance. Do not block. If asynchronous actions are required they can be started here and delay the Futures returned by allocate/rebalance.

```APIDOC
## Start(ActorSystem)

### Description
Called before any calls to allocate/rebalance. Do not block. If asynchronous actions are required they can be started here and delay the Futures returned by allocate/rebalance.

### Method
```csharp
void Start(ActorSystem system)
```

### Parameters
- **system** (ActorSystem) - Description not available
```

--------------------------------

### Start Method

Source: https://getakka.net/api/Akka.Cluster.Sharding.External.ExternalShardAllocationStrategy.html

Called before any calls to allocate/rebalance. Do not block. If asynchronous actions are required they can be started here and delay the Futures returned by allocate/rebalance.

```APIDOC
## Start()

### Description
Called before any calls to allocate/rebalance. Do not block. If asynchronous actions are required they can be started here and delay the Futures returned by allocate/rebalance.
```

--------------------------------

### PreStart

Source: https://getakka.net/api/Akka.Actor.ActorBase.html

User overridable callback. Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.

```APIDOC
## PreStart()

### Description
User overridable callback. Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.

### Declaration
```csharp
protected virtual void PreStart()
```
```

--------------------------------

### HOCON Configuration Example

Source: https://getakka.net/api/Akka.Configuration.Hocon.HoconLiteral.html

This is an example of a HOCON configuration structure.

```hocon
akka {
  actor {
    provider = "Akka.Remote.RemoteActorRefProvider, Akka.Remote"
  }
}
```

--------------------------------

### Start Method for IActorSystemDependentAllocationStrategy

Source: https://getakka.net/api/Akka.Cluster.Sharding.IActorSystemDependentAllocationStrategy.html

The Start method is called by the shard coordinator before any allocation or rebalancing occurs. Implementations can perform asynchronous actions here, which may delay the Futures returned by allocate/rebalance. Do not block this method.

```csharp
void Start(ActorSystem system)
```

--------------------------------

### TimeBasedUuid.Value Property

Source: https://getakka.net/api/Akka.Persistence.Query.TimeBasedUuid.html

Gets the Guid value of the TimeBasedUuid.

```APIDOC
## Value Property

### Description
Gets the Guid value of the TimeBasedUuid.

### Property Value
- **Guid** - The Guid value.
```

--------------------------------

### ThrottleTransportAdapter.ManagerProps Property

Source: https://getakka.net/api/Akka.Remote.Transport.ThrottleTransportAdapter.html

Gets the Props for starting the ThrottlerManager actor.

```APIDOC
## ManagerProps

### Description
Gets the Props for starting the Akka.Remote.Transport.ThrottlerManager actor.

### Property Value
- **Props** - The Props for the ThrottlerManager.
```

--------------------------------

### Start Method

Source: https://getakka.net/api/Akka.Cluster.Sharding.IStartableAllocationStrategy.html

The Start method is called by the shard coordinator before any calls to rebalance or allocate shards. It's intended for performing any necessary initialization that might be expensive and should not be done in the constructor, as it will execute on every node hosting the ShardCoordinator.

```APIDOC
## Start()

### Description
Called before any calls to allocate/rebalance. Do not block. If asynchronous actions are required they can be started here and delay the Futures returned by allocate/rebalance.

### Declaration
```csharp
void Start()
```
```

--------------------------------

### Delta.FromSeqNr Property

Source: https://getakka.net/api/Akka.DistributedData.Internal.Delta.html

Gets the starting sequence number for this Delta.

```csharp
public long FromSeqNr { get; }
```

--------------------------------

### PreStart() Method

Source: https://getakka.net/api/Akka.Streams.Stage.GraphStageLogic.html

Invoked before any external events are processed, during the stage's startup. No setup is required.

```csharp
public virtual void PreStart()
```

--------------------------------

### Start Method

Source: https://getakka.net/api/Akka.Cluster.Sharding.Internal.AbstractLeastShardAllocationStrategy.html

The Start method is invoked before any calls to allocate or rebalance shards. It's designed for initiating asynchronous actions that might delay subsequent allocation or rebalancing operations. Blocking is not permitted within this method.

```APIDOC
## Start(ActorSystem)

### Description
Called before any calls to allocate/rebalance. Do not block. If asynchronous actions are required they can be started here and delay the Futures returned by allocate/rebalance.

### Method Signature
public void Start(ActorSystem system)

### Parameters
- **system** (ActorSystem) - The actor system instance.
```

--------------------------------

### ReadLocal

Source: https://getakka.net/api/Akka.DistributedData.Dsl.html

Gets a IReadConsistency setup, which will acknowledge success of a Get<T>(IKey<T>, IReadConsistency, object) operation immediately as soon, as result will be confirmed by the local replica only.

```APIDOC
## ReadLocal

### Description
Gets a IReadConsistency setup, which will acknowledge success of a Get<T>(IKey<T>, IReadConsistency, object) operation immediately as soon, as result will be confirmed by the local replica only.

### Property Value
Type | Description
---|---
ReadLocal |
```

--------------------------------

### NewtonSoftJsonSerializerSettings.StringBuilderMinSize Property

Source: https://getakka.net/api/Akka.Serialization.NewtonSoftJsonSerializerSettings.html

Gets the starting size used for pooled StringBuilders.

```APIDOC
## StringBuilderMinSize

### Description
The Starting size used for Pooled StringBuilders, if UsePooledStringBuilder is -true-

### Property Value
- **int** - The minimum size for pooled string builders.
```

--------------------------------

### DefaultPreStart Method

Source: https://getakka.net/api/Akka.Actor.Dsl.Act.html

Default implementation for the PreStart callback.

```csharp
public void DefaultPreStart()
```

--------------------------------

### LoggerAsyncStart

Source: https://getakka.net/api/Akka.Actor.Settings.html

Gets a value indicating whether the logger starts asynchronously.

```APIDOC
## LoggerAsyncStart

### Description
Gets the logger start timeout.

### Declaration
```csharp
public bool LoggerAsyncStart { get; }
```

### Property Value
Type | Description
---|---
bool | The logger start timeout.
```

--------------------------------

### Start a New ActorSystem Asynchronously

Source: https://getakka.net/api/Akka.Remote.TestKit.MultiNodeSpec.html

Provides an asynchronous way to start a new ActorSystem. This is useful in scenarios where system startup might involve I/O operations or other asynchronous tasks.

```csharp
protected Task<ActorSystem> StartNewSystemAsync(CancellationToken cancellationToken = default)
```

--------------------------------

### LogSerializerOverrideOnStart

Source: https://getakka.net/api/Akka.Actor.Settings.html

Gets a value indicating whether serializer override is logged on start.

```APIDOC
## LogSerializerOverrideOnStart

### Description
Gets a value indicating whether [log serializer override on start].

### Declaration
```csharp
public bool LogSerializerOverrideOnStart { get; }
```

### Property Value
Type | Description
---|---
bool | `true` if [log serializer override on start]; otherwise, `false`.
```

--------------------------------

### TimeBasedUuid Value Property

Source: https://getakka.net/api/Akka.Persistence.Query.TimeBasedUuid.html

Gets the Guid value associated with the TimeBasedUuid offset.

```csharp
public Guid Value { get; }
```

--------------------------------

### StartNewSystem()

Source: https://getakka.net/api/Akka.Remote.TestKit.MultiNodeSpec.html

Starts a new ActorSystem instance. This is a protected method.

```APIDOC
## StartNewSystem()

### Description
Starts a new ActorSystem instance.

### Method Signature
```csharp
protected ActorSystem StartNewSystem()
```

### Returns
- **ActorSystem** - The newly created ActorSystem.
```

--------------------------------

### Flow.Setup Method

Source: https://getakka.net/api/Akka.Streams.Dsl.Flow.html

Defers the creation of a Flow until materialization time, providing access to the ActorMaterializer and Attributes.

```csharp
public static Flow<TIn, TOut, Task<TMat>> Setup<TIn, TOut, TMat>(Func<ActorMaterializer, Attributes, Flow<TIn, TOut, TMat>> factory)
```

--------------------------------

### Identifier Value Property

Source: https://getakka.net/api/Akka.MultiNode.TestAdapter.Internal.TrxReporter.Models.Identifier.html

Gets the Guid value contained within the Identifier.

```csharp
public readonly Guid Value { get; }
```

--------------------------------

### Obsolete Start method with manual shard/entity extraction

Source: https://getakka.net/api/Akka.Cluster.Sharding.ClusterSharding.html

This is an obsolete method for starting a ShardRegion. It is recommended to use overloads that accept an IMessageExtractor for more robust message handling.

```APIDOC
## Start(string typeName, Func<string, Props> entityPropsFactory, ClusterShardingSettings settings, ExtractEntityId extractEntityId, ExtractShardId extractShardId, IShardAllocationStrategy allocationStrategy, object handOffStopMessage)

### Description
[Obsolete("Use one of the overloads that accepts an IMessageExtractor instead")]
Registers a named entity type by defining the Props of the entity actor and functions to extract entity and shard identifiers from messages. The ShardRegion actor for this type can later be retrieved with the ShardRegion(string) method.
This method will start a ShardRegion(string) in proxy mode when there is no match between the roles of the current cluster node and the role specified in ClusterShardingSettings passed to this method.
Some settings can be configured as described in the `akka.cluster.sharding` section of the `reference.conf`.

### Parameters
#### Path Parameters
- **typeName** (string) - Required - The name of the entity type
- **entityPropsFactory** (Func<string, Props>) - Required - Function that, given an entity id, returns the Props of the entity actors that will be created by the ShardRegion
- **settings** (ClusterShardingSettings) - Required - Configuration settings, see ClusterShardingSettings
- **extractEntityId** (ExtractEntityId) - Required - Partial function to extract the entity id and the message to send to the entity from the incoming message, if the partial function does not match the message will be `unhandled`, i.e. posted as `Unhandled` messages on the event stream
- **extractShardId** (ExtractShardId) - Required - Function to determine the shard id for an incoming message, only messages that passed the `extractEntityId` will be used
- **allocationStrategy** (IShardAllocationStrategy) - Required - Possibility to use a custom shard allocation and rebalancing logic
- **handOffStopMessage** (object) - Required - The message that will be sent to entities when they are to be stopped for a rebalance or graceful shutdown of a ShardRegion, e.g. PoisonPill.

### Returns
#### Success Response
- **IActorRef** - The actor ref of the ShardRegion that is to be responsible for the shard.

### Exceptions
- **IllegalStateException** - This exception is thrown when the cluster member doesn't have the role specified in `settings`.
```

--------------------------------

### ActorSystemSetup.ToString()

Source: https://getakka.net/api/Akka.Actor.Setup.ActorSystemSetup.html

Returns a string representation of the ActorSystemSetup object.

```APIDOC
## ActorSystemSetup.ToString()

### Description
Returns a string that represents the current `ActorSystemSetup` object. This is an override of the base `object.ToString()` method.

### Method
`public override string ToString()`

### Returns
Type | Description
---|---
string | A string representation of the `ActorSystemSetup` object.
```

--------------------------------

### From<T>(IEnumerable<T>)

Source: https://getakka.net/api/Akka.Streams.Dsl.Source.html

Creates a Source from an IEnumerable. Each subscriber gets a fresh stream starting from the beginning.

```APIDOC
## From<T>(IEnumerable<T>)

### Description
Creates a Source from an IEnumerable. Each subscriber gets a fresh stream starting from the beginning.

### Method
`public static Source<T, NotUsed> From<T>(IEnumerable<T> enumerable)`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
```csharp
// Example usage:
var numbers = Enumerable.Range(1, 5);
var source = Source.From(numbers);
```

### Response
#### Success Response (200)
- `Source<T, NotUsed>`: A Source emitting elements from the IEnumerable.

#### Response Example
```csharp
// No direct response example, as it's a stream.
```
```

--------------------------------

### DotNettySslSetup Full Constructor with All Options

Source: https://getakka.net/api/Akka.Remote.Transport.DotNetty.DotNettySslSetup.html

Initializes DotNettySslSetup with all SSL/TLS configuration options, including certificate, suppress validation, mutual authentication, and hostname validation. Use suppressValidation only for development/testing.

```csharp
public DotNettySslSetup(X509Certificate2 certificate, bool suppressValidation, bool requireMutualAuthentication, bool validateCertificateHostname)
```

--------------------------------

### ShardingProducerController.Start<T>.Producer Property

Source: https://getakka.net/api/Akka.Cluster.Sharding.Delivery.ShardingProducerController.Start-1.html

Gets the producer actor reference associated with this Start command.

```APIDOC
## Producer

### Description
Gets the `IActorRef` representing the producer.

### Property Value
- **IActorRef** - The producer actor reference.
```

--------------------------------

### Setup<TIn, TOut, TMat>

Source: https://getakka.net/api/Akka.Streams.Dsl.Flow.html

Defers the creation of a Flow until materialization, providing access to ActorMaterializer and Attributes.

```APIDOC
## Setup<TIn, TOut, TMat>

### Description
Defers the creation of a Flow until materialization. The `factory` function provides access to the `ActorMaterializer` and `Attributes` used during materialization.

### Method Signature
```csharp
public static Flow<TIn, TOut, Task<TMat>> Setup<TIn, TOut, TMat>(Func<ActorMaterializer, Attributes, Flow<TIn, TOut, TMat>> factory)
```

### Parameters
#### factory
Type: `Func<ActorMaterializer, Attributes, Flow<TIn, TOut, TMat>>`
Description: TBD

### Returns
Type: `Flow<TIn, TOut, Task<TMat>>`
Description: TBD

### Type Parameters
- TIn: TBD
- TOut: TBD
- TMat: TBD
```

--------------------------------

### ShardingProducerController.Start<T>.Producer Property

Source: https://getakka.net/api/Akka.Cluster.Sharding.Delivery.ShardingProducerController.Start-1.html

Gets the IActorRef of the producer associated with this Start command. This property is read-only.

```csharp
public IActorRef Producer { get; }
```

--------------------------------

### Get ClusterSharding Extension

Source: https://getakka.net/api/Akka.Cluster.Sharding.ClusterSharding.html

Retrieves the singleton instance of the ClusterSharding extension for a given ActorSystem. Ensure the extension is started before calling this.

```csharp
public static ClusterSharding Get(ActorSystem system)
```

--------------------------------

### DistributedPubSub Get Method

Source: https://getakka.net/api/Akka.Cluster.Tools.PublishSubscribe.DistributedPubSub.html

This static method retrieves an instance of the DistributedPubSub extension for a given ActorSystem. If the extension has not been initialized, it will be started.

```csharp
public static DistributedPubSub Get(ActorSystem system)
```

--------------------------------

### ShardingProducerController.Start<T> Constructor

Source: https://getakka.net/api/Akka.Cluster.Sharding.Delivery.ShardingProducerController.Start-1.html

Constructs a new instance of the Start command, requiring an IActorRef representing the producer. This is used to associate a producer with the controller.

```csharp
public Start(IActorRef producer)
```

--------------------------------

### WriteLocal

Source: https://getakka.net/api/Akka.DistributedData.Dsl.html

Gets a IWriteConsistency setup, which will acknowledge success of an Update or Delete<T>(IKey<T>, IWriteConsistency, object) operation immediately as soon, as result will be confirmed by the local replica only.

```APIDOC
## WriteLocal

### Description
Gets a IWriteConsistency setup, which will acknowledge success of an Update or Delete<T>(IKey<T>, IWriteConsistency, object) operation immediately as soon, as result will be confirmed by the local replica only.

### Property Value
Type | Description
---|---
WriteLocal |
```

--------------------------------

### Get Equals Method (Get)

Source: https://getakka.net/api/Akka.DistributedData.Get.html

Compares the current Get object with another Get object for equality.

```csharp
public bool Equals(Get other)
```

--------------------------------

### Creating and Configuring Props

Source: https://getakka.net/api/Akka.Actor.Props.html

Demonstrates the creation of Props objects, including an empty Props and Props for a specific actor with constructor arguments. It also shows how to modify existing Props to specify a dispatcher or deployment information.

```csharp
private Props props = Props.Empty();
private Props props = Props.Create(() => new MyActor(arg1, arg2));

private Props otherProps = props.WithDispatcher("dispatcher-id");
private Props otherProps = props.WithDeploy(deployment info);
```

--------------------------------

### Start

Source: https://getakka.net/api/Akka.Remote.RemoteActorRef.html

Starts the actor. This method overrides the Start method from Akka.Actor.InternalActorRefBase.

```APIDOC
## Start()

### Description
Starts this instance.

### Method
`public override void Start()`
```

--------------------------------

### PreStart()

Source: https://getakka.net/api/Akka.Persistence.Snapshot.LocalSnapshotStore.html

Called when the actor is starting. This method is intended for initialization logic.

```APIDOC
## PreStart()

### Description
Called when the actor is starting. This method is intended for initialization logic.

### Method
```csharp
protected override void PreStart()
```
```

--------------------------------

### ActorSystemSetup.Get<T>()

Source: https://getakka.net/api/Akka.Actor.Setup.ActorSystemSetup.html

Retrieves a specific setup configuration of a given type from the ActorSystemSetup.

```APIDOC
## ActorSystemSetup.Get<T>()

### Description
Retrieves a specific `Setup` configuration of the specified type `T` from the `ActorSystemSetup`.

### Method
`public Option<T> Get<T>() where T : Setup`

### Returns
Type | Description
---|---
Option<T> | An `Option<T>` containing the `Setup` object if found, otherwise an empty `Option<T>`.

### Type Parameters
Name | Description
---|---
T | The type of `Setup` to retrieve.
```

--------------------------------

### Start Cluster Node

Source: https://getakka.net/api/Akka.Cluster.TestKit.MultiNodeClusterSpec.html

Use this method for the initial startup of a cluster node.

```csharp
public void StartClusterNode()
```

--------------------------------

### Get Properties

Source: https://getakka.net/api/Akka.DistributedData.Get.html

Properties of the Get message.

```APIDOC
## Get Properties

### Consistency
- **Type**: IReadConsistency
- **Description**: The read consistency level used for this Get operation.

### Key
- **Type**: IKey
- **Description**: The key of the data being requested.

### Request
- **Type**: object
- **Description**: Optional contextual information associated with this Get request.
```

--------------------------------

### TcpSettings Example

Source: https://getakka.net/api/Akka.IO.Tcp.Bind.html

Shows how to create TcpSettings, optionally overriding default buffer sizes for sending and receiving.

```csharp
var tcpSettings = TcpSettings.Create(ActorSystem);
var tcpSettingsWithDifferentBufferSizes = tcpSettings with { SendBufferSize = 8192, ReceiveBufferSize = 8192 };
```

--------------------------------

### Configure Shard Start Timeout

Source: https://getakka.net/api/Akka.Cluster.Sharding.TuningParameters.html

Defines the maximum time to wait for a shard to start. If a shard does not start within this timeout, it may be considered failed.

```csharp
public TuningParameters WithShardStartTimeout(TimeSpan shardStartTimeout)
```

--------------------------------

### ProducerController.Start<T> Constructor

Source: https://getakka.net/api/Akka.Delivery.ProducerController.Start-1.html

Initializes a new instance of the ProducerController.Start<T> class.

```APIDOC
## ProducerController.Start<T>(IActorRef)

### Description
Initializes a new instance of the ProducerController.Start<T> class.

### Parameters
- **producer** (IActorRef) - The actor reference for the producer.
```

--------------------------------

### Get Method

Source: https://getakka.net/api/Akka.Cluster.Tools.PublishSubscribe.DistributedPubSub.html

Gets the DistributedPubSub extension for the given ActorSystem.

```APIDOC
## Get(ActorSystem)

### Description
Gets the DistributedPubSub extension instance for the given ActorSystem.

### Parameters
- **system** (ActorSystem) - The actor system.

### Returns
- **DistributedPubSub**: The DistributedPubSub extension instance.
```

--------------------------------

### Intersperse Stream with Start, Inject, and End Elements

Source: https://getakka.net/api/Akka.Streams.Dsl.SourceOperations.html

Interspereses a stream with provided start, inject, and end elements. This is useful for adding separators, start markers, and end markers to a stream.

```csharp
public static Source<TOut, TMat> Intersperse<TOut, TMat>(this Source<TOut, TMat> flow, TOut start, TOut inject, TOut end)
```

--------------------------------

### Start Method

Source: https://getakka.net/api/Akka.Cluster.Sharding.External.ExternalShardAllocationStrategy.html

Called before any calls to allocate or rebalance. Asynchronous actions can be initiated here, which may delay the Futures returned by allocate/rebalance. Do not block this method.

```csharp
public void Start()
```

--------------------------------

### Get Properties

Source: https://getakka.net/api/Akka.DistributedData.Get.html

Provides access to the Consistency, Key, and Request properties of a Get message.

```csharp
public IReadConsistency Consistency { get; }
```

```csharp
public IKey Key { get; }
```

```csharp
public object Request { get; }
```

--------------------------------

### Main Method

Source: https://getakka.net/api/Akka.MultiNode.RemoteHost.RemoteHost.Program.html

The entry point of the RemoteHost program. It accepts an array of strings as arguments.

```APIDOC
## Main(string[])

### Description
Provides an entry point in a new process that will load a specified method and invoke it.

### Declaration
```csharp
public static int Main(string[] args)
```

### Parameters
- **args** (string[]) - 

### Returns
- **int** - 
```

--------------------------------

### TimeBasedUuid(Guid)

Source: https://getakka.net/api/Akka.Persistence.Query.Offset.html

Factory method to create a TimeBasedUuid offset with a specific Guid value.

```APIDOC
## TimeBasedUuid(Guid)
Factory to create an offset of type TimeBasedUuid(Guid).

### Method Signature
```csharp
public static Offset TimeBasedUuid(Guid value)
```

### Parameters
*   **value** (Guid) - The Guid value for the offset.
```

--------------------------------

### AtStartup Method

Source: https://getakka.net/api/Akka.Remote.TestKit.MultiNodeSpec.html

Override this method to execute custom logic when the test setup begins. This is called once before any test cases are run.

```csharp
protected virtual void AtStartup()
```

--------------------------------

### Get Methods

Source: https://getakka.net/api/Akka.DistributedData.Get.html

Methods available for the Get message, including equality checks and string representation.

```APIDOC
## Get Methods

### Equals(Get other)
- **Description**: Indicates whether the current object is equal to another object of the same type.
- **Parameters**: `other` (Get) - An object to compare with this object.
- **Returns**: `bool` - true if the current object is equal to the `other` parameter; otherwise, false.

### Equals(object obj)
- **Description**: Determines whether the specified object is equal to the current object.
- **Parameters**: `obj` (object) - The object to compare with the current object.
- **Returns**: `bool` - true if the specified object is equal to the current object; otherwise, false.
- **Overrides**: `object.Equals(object)`

### GetHashCode()
- **Description**: Serves as the default hash function.
- **Returns**: `int` - A hash code for the current object.
- **Overrides**: `object.GetHashCode()`

### ToString()
- **Description**: Returns a string that represents the current object.
- **Returns**: `string` - A string that represents the current object.
- **Overrides**: `object.ToString()`
```

--------------------------------

### Defer Source creation until materialization

Source: https://getakka.net/api/Akka.Streams.Dsl.Source.html

Setup defers the creation of a Source until materialization. The factory function provides access to the ActorMaterializer and Attributes used during materialization.

```csharp
public static Source<T, Task<TMat>> Setup<T, TMat>(Func<ActorMaterializer, Attributes, Source<T, TMat>> factory)
```

--------------------------------

### RepointableActorRef Start Method

Source: https://getakka.net/api/Akka.Actor.RepointableActorRef.html

Starts the actor. This is an internal API used by built-in IActorRef implementations.

```csharp
public override void Start()
```

--------------------------------

### Create BootstrapSetup Instance

Source: https://getakka.net/api/Akka.Actor.BootstrapSetup.html

Creates a new BootstrapSetup instance with default settings. This is the starting point for configuring the ActorSystem.

```csharp
public static BootstrapSetup Create()
```

--------------------------------

### Get Class Syntax

Source: https://getakka.net/api/Akka.DistributedData.Get.html

Defines the syntax for the Get class, indicating it is serializable and implements specific interfaces.

```csharp
[Serializable]
public sealed class Get : IEquatable<Get>, IReplicatorMessage
```

--------------------------------

### DotNettySslSetup Constructors

Source: https://getakka.net/api/Akka.Remote.Transport.DotNetty.DotNettySslSetup.html

Provides constructors for initializing DotNettySslSetup with various SSL/TLS configurations.

```APIDOC
## DotNettySslSetup(X509Certificate2, bool)

### Description
Constructor for backward compatibility - defaults to RequireMutualAuthentication = true, ValidateCertificateHostname = false.

### Parameters
- **certificate** (X509Certificate2) - Required - X509 certificate used to establish SSL/TLS.
- **suppressValidation** (bool) - Required - When true, suppresses certificate chain validation (use only for development/testing).

## DotNettySslSetup(X509Certificate2, bool, bool)

### Description
Constructor for backward compatibility - defaults to ValidateCertificateHostname = false.

### Parameters
- **certificate** (X509Certificate2) - Required - X509 certificate used to establish SSL/TLS.
- **suppressValidation** (bool) - Required - When true, suppresses certificate chain validation (use only for development/testing).
- **requireMutualAuthentication** (bool) - Required - When true, requires mutual TLS authentication (both client and server present certificates).

## DotNettySslSetup(X509Certificate2, bool, bool, CertificateValidationCallback?)

### Description
Constructor with custom certificate validation callback.

### Parameters
- **certificate** (X509Certificate2) - Required - X509 certificate used to establish SSL/TLS.
- **suppressValidation** (bool) - Required - When true, suppresses certificate chain validation (use only for development/testing).
- **requireMutualAuthentication** (bool) - Required - When true, requires mutual TLS authentication (both client and server present certificates).
- **customValidator** (CertificateValidationCallback?) - Optional - Custom certificate validation callback (overrides config-based validation when provided).

## DotNettySslSetup(X509Certificate2, bool, bool, bool)

### Description
Full constructor with all SSL/TLS configuration options.

### Parameters
- **certificate** (X509Certificate2) - Required - X509 certificate used to establish SSL/TLS.
- **suppressValidation** (bool) - Required - When true, suppresses certificate chain validation (use only for development/testing).
- **requireMutualAuthentication** (bool) - Required - When true, requires mutual TLS authentication (both client and server present certificates).
- **validateCertificateHostname** (bool) - Required - When true, enables hostname validation (certificate CN/SAN must match target hostname).

## DotNettySslSetup(X509Certificate2, bool, bool, bool, CertificateValidationCallback?)

### Description
Full constructor with all SSL/TLS configuration options including custom validation.

### Parameters
- **certificate** (X509Certificate2) - Required - X509 certificate used to establish SSL/TLS.
- **suppressValidation** (bool) - Required - When true, suppresses certificate chain validation (use only for development/testing).
- **requireMutualAuthentication** (bool) - Required - When true, requires mutual TLS authentication (both client and server present certificates).
- **validateCertificateHostname** (bool) - Required - When true, enables hostname validation (certificate CN/SAN must match target hostname).
- **customValidator** (CertificateValidationCallback?) - Optional - Custom certificate validation callback (overrides config-based validation when provided).
```

--------------------------------

### TestRunTree Constructor with Start Time

Source: https://getakka.net/api/Akka.MultiNode.TestAdapter.Internal.Reporting.TestRunTree.html

Initializes a new instance of the TestRunTree class with the specified start time.

```csharp
public TestRunTree(long startTime)
```

--------------------------------

### Initialize Method

Source: https://getakka.net/api/Akka.Actor.FSM-2.html

Verifies the initial state and sets up timers. This method should be called last in the constructor or PostRestart. Calling it before StartWith throws an IllegalStateException.

```csharp
public void Initialize()
```

--------------------------------

### Create a Key Token

Source: https://getakka.net/api/Akka.Configuration.Hocon.Token.html

Use the static `Key` method to create a token representing a configuration key.

```csharp
public static Token Key(string key)
```

--------------------------------

### Identifier Create Method (Guid)

Source: https://getakka.net/api/Akka.MultiNode.TestAdapter.Internal.TrxReporter.Models.Identifier.html

Creates a new instance of the Identifier struct with a specified Guid value.

```csharp
public static Identifier Create(Guid value)
```

--------------------------------

### Intersperse (start, inject, end)

Source: https://getakka.net/api/Akka.Streams.Dsl.SourceOperations.html

Intersperse inserts a specified element between each element of the stream, and optionally injects start and end marker elements. This version allows specifying distinct elements for the start, the separator (inject), and the end of the stream. Emits when upstream emits (or before with the `start` element if provided), backpressures when downstream backpressures, completes when upstream completes, and cancels when downstream cancels.

```APIDOC
## Intersperse<TOut, TMat>(TOut start, TOut inject, TOut end)

### Description
Intersperses stream with provided element, similar to how Join(string, params string[]) injects a separator between a collection's elements. Additionally can inject start and end marker elements to stream. In case you want to only prepend or only append an element (yet still use the intercept feature to inject a separator between elements, you may want to use the following pattern instead of the 3-argument version of intersperse (See Concat<TOut, TMat>(Source<TOut, TMat>, IGraph<SourceShape<TOut>, TMat>) for semantics details). Emits when upstream emits (or before with the `start` element if provided). Backpressures when downstream backpressures. Completes when upstream completes. Cancels when downstream cancels.

### Method Signature
```csharp
public static Source<TOut, TMat> Intersperse<TOut, TMat>(this Source<TOut, TMat> flow, TOut start, TOut inject, TOut end)
```

### Parameters
- **flow** (Source<TOut, TMat>) - TBD
- **start** (TOut) - TBD
- **inject** (TOut) - TBD
- **end** (TOut) - TBD

### Returns
- **Source<TOut, TMat>** - TBD

### Type Parameters
- **TOut**: TBD
- **TMat**: TBD

### Exceptions
- **ArgumentNullException**: Thrown when any of the `start`, `inject` or `end` is undefined.
```

--------------------------------

### ActorSystemSetup.Empty

Source: https://getakka.net/api/Akka.Actor.Setup.ActorSystemSetup.html

Represents an empty ActorSystemSetup, useful as a starting point for configurations.

```APIDOC
## ActorSystemSetup.Empty

### Description
Represents an empty ActorSystemSetup. This is a static readonly field that can be used as a base for building up configurations.

### Field Value
Type | Description
---|---
ActorSystemSetup | An instance of an empty ActorSystemSetup.
```

--------------------------------

### Props Constructors

Source: https://getakka.net/api/Akka.Actor.Props.html

Demonstrates various ways to instantiate and configure Props for actor creation.

```APIDOC
## Props Constructors

This section details the various constructors available for the `Props` class, allowing for flexible actor configuration.

### `Props()`

Initializes a new instance of the `Props` class. This is a protected constructor.

```csharp
protected Props()
```

### `Props(Deploy deploy, Type type, IEnumerable<object> args)`

Initializes a new instance of the `Props` class with specified deployment information, actor type, and arguments.

**Parameters:**
- `deploy` (Deploy): The configuration used to deploy the actor.
- `type` (Type): The type of the actor to create.
- `args` (IEnumerable<object>): The arguments needed to create the actor.

**Exceptions:**
- `ArgumentNullException`: Thrown if `Props` is not instantiated with an actor type.

```csharp
public Props(Deploy deploy, Type type, IEnumerable<object> args)
```

### `Props(Deploy deploy, Type type, params object[] args)`

Initializes a new instance of the `Props` class with specified deployment information, actor type, and arguments using a params array.

**Parameters:**
- `deploy` (Deploy): The configuration used to deploy the actor.
- `type` (Type): The type of the actor to create.
- `args` (object[]): The arguments needed to create the actor.

**Exceptions:**
- `ArgumentException`: Thrown if `type` is an unknown actor producer.

```csharp
public Props(Deploy deploy, Type type, params object[] args)
```

### `Props(Props copy)`

Initializes a new instance of the `Props` class by copying an existing `Props` object. This is a protected constructor.

**Parameters:**
- `copy` (Props): The object that is being cloned.

```csharp
protected Props(Props copy)
```

### `Props(Type type)`

Initializes a new instance of the `Props` class with the specified actor type. This configuration uses the default `Deploy` deployer.

**Parameters:**
- `type` (Type): The type of the actor to create.

**Exceptions:**
- `ArgumentNullException`: Thrown if `Props` is not instantiated with an actor type.

```csharp
public Props(Type type)
```

### `Props(Type type, SupervisorStrategy supervisorStrategy, IEnumerable<object> args)`

Initializes a new instance of the `Props` class with the specified actor type, supervisor strategy, and arguments.

**Parameters:**
- `type` (Type): The type of the actor to create.
- `supervisorStrategy` (SupervisorStrategy): The supervisor strategy used to manage the actor.
- `args` (IEnumerable<object>): The arguments needed to create the actor.

**Exceptions:**
- `ArgumentNullException`: Thrown if `Props` is not instantiated with an actor type.

```csharp
public Props(Type type, SupervisorStrategy supervisorStrategy, IEnumerable<object> args)
```

### `Props(Type type, SupervisorStrategy supervisorStrategy, params object[] args)`

Initializes a new instance of the `Props` class with the specified actor type, supervisor strategy, and arguments using a params array.

**Parameters:**
- `type` (Type): The type of the actor to create.
- `supervisorStrategy` (SupervisorStrategy): The supervisor strategy used to manage the actor.
- `args` (object[]): The arguments needed to create the actor.

**Exceptions:**
- `ArgumentNullException`: Thrown if `Props` is not instantiated with an actor type.

```csharp
public Props(Type type, SupervisorStrategy supervisorStrategy, params object[] args)
```

### `Props(Type type, object[] args)`

Initializes a new instance of the `Props` class with the specified actor type and arguments. This configuration uses the default `Deploy` deployer.

**Parameters:**
- `type` (Type): The type of the actor to create.
- `args` (object[]): The arguments needed to create the actor.

**Exceptions:**
- `ArgumentNullException`: Thrown if `Props` is not instantiated with an actor type.

```csharp
public Props(Type type, object[] args)
```
```

--------------------------------

### Get Constructor

Source: https://getakka.net/api/Akka.DistributedData.Get.html

Constructs a new Get message to retrieve data. It can optionally include a request object for contextual information.

```APIDOC
## Get(IKey key, IReadConsistency consistency, object request = null)

### Description
Initializes a new instance of the Get class.

### Parameters
- **key** (IKey) - The key of the data to retrieve.
- **consistency** (IReadConsistency) - The read consistency level to use for the retrieval.
- **request** (object, optional) - Optional contextual information to be included in the reply messages.
```

--------------------------------

### AtStartup() Method

Source: https://getakka.net/api/Akka.Remote.TestKit.MultiNodeSpec.html

Override this method to execute custom logic when the whole test is starting up.

```APIDOC
## AtStartup() Method

### Description
Override this method to execute custom logic when the whole test is starting up.

### Declaration
```csharp
protected virtual void AtStartup()
```
```

--------------------------------

### Get Constructor

Source: https://getakka.net/api/Akka.DistributedData.Get.html

Constructs a new Get message with a specified key, read consistency, and an optional request object for context.

```csharp
public Get(IKey key, IReadConsistency consistency, object request = null)
```

--------------------------------

### ConsumerController.Start<T> Constructor

Source: https://getakka.net/api/Akka.Delivery.ConsumerController.Start-1.html

Initializes a new instance of the ConsumerController.Start<T> class, signaling readiness to start message production.

```APIDOC
## Start(IActorRef)

### Description
Initializes a new instance of the `ConsumerController.Start<T>` class.

### Parameters
#### Path Parameters
- **deliverTo** (IActorRef) - Required - The actor reference to deliver messages to.
```

--------------------------------

### ShardingConsumerController.Settings.Create Method

Source: https://getakka.net/api/Akka.Cluster.Sharding.Delivery.ShardingConsumerController.Settings.html

Creates a new instance of ShardingConsumerController.Settings.

```APIDOC
## ShardingConsumerController.Settings.Create(ActorSystem)

### Description
Creates a new instance of `ShardingConsumerController.Settings` using the provided `ActorSystem`.

### Method
```csharp
public static ShardingConsumerController.Settings Create(ActorSystem system)
```

### Parameters
- **system** (`ActorSystem`) - The actor system to use for creating the settings.
```

--------------------------------

### ConsumerController.Start<T> Properties

Source: https://getakka.net/api/Akka.Delivery.ConsumerController.Start-1.html

Properties available for the ConsumerController.Start<T> class.

```APIDOC
## DeliverTo

### Description
Gets the actor reference to deliver messages to.

### Property Value
- **DeliverTo** (IActorRef) - The actor reference for message delivery.
```

--------------------------------

### HOCON Array Example

Source: https://getakka.net/api/Akka.Configuration.Hocon.HoconArray.html

This is an example of a HOCON configuration snippet that uses an array for seed nodes in Akka cluster configuration.

```hocon
akka {
  cluster {
    seed-nodes = [
      "akka.tcp://ClusterSystem@127.0.0.1:2551",
      "akka.tcp://ClusterSystem@127.0.0.1:2552"]
  }
}
```

--------------------------------

### Get Static Method

Source: https://getakka.net/api/Akka.Cluster.Sharding.External.ExternalShardAllocation.html

The static Get method is used to retrieve an instance of ExternalShardAllocation from an ActorSystem. This is the standard way to access the extension.

```csharp
public static ExternalShardAllocation Get(ActorSystem system)
```

--------------------------------

### Setup<T, TMat>(Func<ActorMaterializer, Attributes, Source<T, TMat>>)

Source: https://getakka.net/api/Akka.Streams.Dsl.Source.html

Defers the creation of a Source until materialization. The factory function provides access to the ActorMaterializer and Attributes.

```APIDOC
## Setup<T, TMat>(Func<ActorMaterializer, Attributes, Source<T, TMat>> factory)

### Description
Defers the creation of a Source until materialization. The `factory` function exposes ActorMaterializer which is going to be used during materialization and Attributes of the Source returned by this method.

### Method
`public static Source<T, Task<TMat>> Setup<T, TMat>(Func<ActorMaterializer, Attributes, Source<T, TMat>> factory)

### Parameters
#### Parameters
- **factory** (Func<ActorMaterializer, Attributes, Source<T, TMat>>) - The function that creates the Source during materialization.
```

--------------------------------

### ConsumerController.Start<T> Constructor

Source: https://getakka.net/api/Akka.Delivery.ConsumerController.Start-1.html

Constructor for the Start class, accepting an IActorRef to specify where messages should be delivered. This is used to initialize the command.

```csharp
public Start(IActorRef deliverTo)
```

--------------------------------

### Exclude sources starting with a specific string

Source: https://getakka.net/api/Akka.Event.LogFilterBuilder.html

Configures the builder to exclude log entries originating from sources that start with a specified string.

```APIDOC
## ExcludeSourceStartingWith(string)

### Description
Excludes log entries where the source starts with the specified string.

### Method
```csharp
public LogFilterBuilder ExcludeSourceStartingWith(string sourceStart)
```

### Parameters
- **sourceStart** (string) - The string that the log source must start with to be excluded.
```

--------------------------------

### GoTo Method (State)

Source: https://getakka.net/api/Akka.Actor.FSM-2.html

Initiates a state transition to a new state. Return this from a state function to effect the transition.

```csharp
public FSMBase.State<TState, TData> GoTo(TState nextStateName)
```

--------------------------------

### StartClient

Source: https://getakka.net/api/Akka.Remote.TestKit.TestConductor.html

Connects to the test conductor on a specified host and port. Awaiting the returned future ensures all expected participants have connected, acting as an initial barrier.

```APIDOC
## StartClient(RoleName, IPEndPoint)

### Description
Connect to the conductor on the given port (the host is taken from setting `akka.testconductor.host`). The connection is made asynchronously, but you should await completion of the returned Future because that implies that all expected participants of this test have successfully connected (i.e. this is a first barrier in itself). The number of expected participants is set in TestConductor.startController().

### Method Signature
```csharp
public Task<Done> StartClient(RoleName name, IPEndPoint controllerAddr)
```

### Parameters
- **name** (RoleName) - Required.
- **controllerAddr** (IPEndPoint) - Required.
```

--------------------------------

### SkipWhen Usage Example

Source: https://getakka.net/api/Akka.TestKit.Xunit.Attributes.WindowsFactAttribute.html

Example of using the SkipWhen property with the nameof operator to conditionally skip a test based on a static property.

```csharp
SkipWhen = nameof(IsConditionMet);
```

--------------------------------

### HyperionSerializerSetup Create Methods

Source: https://getakka.net/api/Akka.Serialization.Hyperion.HyperionSerializerSetup.html

Static factory methods for creating instances of HyperionSerializerSetup with various configurations.

```APIDOC
## Method: Create

### Declaration
```csharp
public static HyperionSerializerSetup Create(bool preserveObjectReferences, bool versionTolerance, Type knownTypesProvider)
```

### Parameters
Type | Name | Description
---|---|---
bool | preserveObjectReferences | 
bool | versionTolerance | 
Type | knownTypesProvider | 

### Returns
Type | Description
---|---
HyperionSerializerSetup | 

```

```APIDOC
## Method: Create

### Declaration
```csharp
public static HyperionSerializerSetup Create(bool preserveObjectReferences, bool versionTolerance, Type knownTypesProvider, IEnumerable<Func<string, string>> packageNameOverrides)
```

### Parameters
Type | Name | Description
---|---|---
bool | preserveObjectReferences | 
bool | versionTolerance | 
Type | knownTypesProvider | 
IEnumerable<Func<string, string>> | packageNameOverrides | 

### Returns
Type | Description
---|---
HyperionSerializerSetup | 

```

```APIDOC
## Method: Create

### Declaration
```csharp
public static HyperionSerializerSetup Create(bool preserveObjectReferences, bool versionTolerance, Type knownTypesProvider, IEnumerable<Func<string, string>> packageNameOverrides, IEnumerable<Surrogate> surrogates)
```

### Parameters
Type | Name | Description
---|---|---
bool | preserveObjectReferences | 
bool | versionTolerance | 
Type | knownTypesProvider | 
IEnumerable<Func<string, string>> | packageNameOverrides | 
IEnumerable<Surrogate> | surrogates | 

### Returns
Type | Description
---|---
HyperionSerializerSetup | 

```

--------------------------------

### PersistenceIdsSpec Setup Method

Source: https://getakka.net/api/Akka.Persistence.TCK.Query.PersistenceIdsSpec.html

Helper method to set up persistence for a given persistence ID and number of events.

```csharp
protected IActorRef Setup(string persistenceId, int n)
```
Tokens:
Raw