MBrace.AWS


AWSCluster

Namespace: MBrace.AWS

Windows AWS Cluster management client. Provides methods for management, execution and debugging of MBrace processes in AWS.

Instance members

Instance memberDescription
AttachLocalWorker(...)
Signature: (workerId:string option * workingDirectory:string option * maxWorkItems:int option * logFile:string option * logLevel:LogLevel option * quiet:bool option * heartbeatInterval:TimeSpan option * heartbeatThreshold:TimeSpan option * background:bool option) -> unit

Spawns a worker instance in the local machine, subscribed to the current cluster configuration.

AttachLocalWorkers(...)
Signature: (workerCount:int * maxWorkItems:int option * logLevel:LogLevel option * quiet:bool option * heartbeatInterval:TimeSpan option * heartbeatThreshold:TimeSpan option * background:bool option) -> unit

Spawns worker instances in the local machine, subscribed to the current cluster configuration.

Configuration
Signature: Configuration

Gets a copy of the configuration object used for the runtime

CompiledName: get_Configuration

CullNonResponsiveWorkers(...)
Signature: heartbeatThreshold:TimeSpan -> unit

Culls cluster workers that have stopped sending heartbeats for a duration larger than the supplied threshold parameter.

CullNonResponsiveWorkersAsync(...)
Signature: heartbeatThreshold:TimeSpan -> Async<unit>

Culls cluster workers that have stopped sending heartbeats for a duration larger than the supplied threshold parameter.

DynamoDBClient
Signature: IAmazonDynamoDB

Gets the AWSSDK DynamoDB client instance used by the cluster

CompiledName: get_DynamoDBClient

Hash
Signature: string

Cluster configuration hash identifier

CompiledName: get_Hash

KillAllLocalWorkers()
Signature: unit -> unit

Kills all worker processes of the cluster that are running on the local machine.

KillLocalWorker(worker)
Signature: worker:IWorkerRef -> bool

Kill worker process if running on local machine. Returns true if successful, false if local worker not found.

Reset(...)
Signature: (deleteQueues:bool option * deleteRuntimeState:bool option * deleteLogs:bool option * deleteUserData:bool option * force:bool option * reactivate:bool option) -> unit

Delete and re-activate runtime state. Using 'Reset' may cause unexpected behavior in clients and workers. Workers should be restarted manually.

ResetAsync(...)
Signature: (deleteQueues:bool option * deleteRuntimeState:bool option * deleteLogs:bool option * deleteUserData:bool option * force:bool option * reactivate:bool option) -> Async<unit>

Delete and re-activate runtime state. Using 'Reset' may cause unexpected behavior in clients and workers. Workers should be restarted manually.

S3Client
Signature: IAmazonS3

Gets the AWSSDK S3 client instance used by the cluster

CompiledName: get_S3Client

SQSClient
Signature: IAmazonSQS

Gets the AWSSDK SQS client instance used by the cluster

CompiledName: get_SQSClient

Static members

Static memberDescription
Connect(...)
Signature: (config:Configuration * clientId:string option * faultPolicy:FaultPolicy option * logger:ISystemLogger option * logLevel:LogLevel option) -> AWSCluster

Connects to an MBrace-on-AWS cluster as identified by provided configuration object. If successful returns a management handle object to the cluster.

ConnectAsync(...)
Signature: (config:Configuration * clientId:string option * faultPolicy:FaultPolicy option * logger:ISystemLogger option * logLevel:LogLevel option) -> Async<AWSCluster>

Connects to an MBrace-on-AWS cluster as identified by provided configuration object. If successful returns a management handle object to the cluster.

InitOnCurrentMachine(...)
Signature: (config:Configuration * workerCount:int * clientId:string option * faultPolicy:FaultPolicy option * maxWorkItems:int option * logger:ISystemLogger option * quiet:bool option * logLevel:LogLevel option * heartbeatInterval:TimeSpan option * heartbeatThreshold:TimeSpan option * background:bool option) -> AWSCluster

Initialize a new local runtime instance with supplied worker count and return a handle.

Fork me on GitHub