Class ApiProcessingContext<TSossObject>

Namespace

Scaleout.Modules.Abstractions

Assembly

Scaleout.Modules.Abstractions.dll

Represents the context for processing an invocation in a custom API module.

public abstract class ApiProcessingContext<TSossObject>

Type Parameters

TSossObject

Type of object stored in the ScaleOut StateServer (SOSS) service.

Inheritance

object

ApiProcessingContext<TSossObject>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

This class provides methods and properties for interacting with the ScaleOut service, including raising alerts and accessing the associated cache. It is supplied to your operation handler methods as the first parameter.

Properties

Cache

Gets a cache that can be used to access the module's objects that are stored in the ScaleOut service.

public abstract Cache<string, TSossObject> Cache { get; }

Property Value

Cache<string, TSossObject>

GridConnection

Get the grid connection associated with this processing context.

public abstract GridConnection GridConnection { get; }

Property Value

GridConnection

ModuleName

Gets the name of the API module.

public abstract string ModuleName { get; }

Property Value

string

ObjectId

Gets the unique identifier for the associated object in the ScaleOut StateServer service.

public abstract string ObjectId { get; }

Property Value

string

Methods

SendUIAlertAsync(AlertSeverity, string)

Sends a alert message to the ScaleOut user interface with the specified severity and message text.

public abstract Task SendUIAlertAsync(AlertSeverity severity, string message)

Parameters

severity AlertSeverity

Severity level associated with the message.

message string

Text of the alert.

Returns

Task

The task object representing the asynchronous operation.