Class ApiModuleRegistration<TSossObject>

Namespace

Scaleout.Modules.Hosting

Assembly

Scaleout.Modules.Hosting.dll

API module registration class for registering parallel API processors for a specific module. Instances of this class are returned from AddApiModule<TSossObject, TApiProcessor>(string, ApiModuleOptions<TSossObject>?).

public class ApiModuleRegistration<TSossObject>

Type Parameters

TSossObject

Type of the SOSS object.

Inheritance

object

ApiModuleRegistration<TSossObject>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ModuleName

Gets the name of the module associated with this API module registration.

public string ModuleName { get; }

Property Value

string

Methods

AddForeachApiProcessor(string, ForEachApiProcessor<TSossObject>)

Registers a foreach API processor for the specified operation ID. Foreach API processors are used to perform parallel operations on SOSS objects in the cache, where each object is evaluated and then optionally updated or removed.

public void AddForeachApiProcessor(string operationId, ForEachApiProcessor<TSossObject> processor)

Parameters

operationId string

The operation ID.

processor ForEachApiProcessor<TSossObject>

The foreach API processor (inherited from ForEachApiProcessor<TSossObject>).

AddReduceApiProcessor<TAccumulator>(string, ReduceApiProcessor<TSossObject, TAccumulator>)

Registers a reduce API processor for the specified operation ID. Reduce API processors are used to perform parallel opreration on SOSS objects in the cache, where the results are accumulated into a single result.

public void AddReduceApiProcessor<TAccumulator>(string operationId, ReduceApiProcessor<TSossObject, TAccumulator> processor)

Parameters

operationId string

The operation ID.

processor ReduceApiProcessor<TSossObject, TAccumulator>

The reduce API processor (inherited from ReduceApiProcessor<TSossObject, TAccumulator>).

Type Parameters

TAccumulator

Type of result accumulator.