MBrace.Runtime


MBraceClient

Namespace: MBrace.Runtime

MBrace runtime client handle abstract class.

Constructors

ConstructorDescription
new(runtime, defaultFaultPolicy)
Signature: (runtime:IRuntimeManager * defaultFaultPolicy:FaultPolicy) -> MBraceClient

CompiledName: .ctor

Instance members

Instance memberDescription
add_SystemLogs(arg1)
Signature: Handler<SystemLogEntry> -> unit

Event for subscribing to runtime-wide system logs

AttachLogger(logger)
Signature: logger:ISystemLogger -> IDisposable

Attaches user-supplied logger to client instance. Returns an unsubscribe token if successful.

ClearAllProcesses()
Signature: unit -> unit

Deletes all cloud processes and related data from MBrace cluster.

ClearProcess(cloudProcess)
Signature: cloudProcess:CloudProcess<'T> -> unit
Type parameters: 'T

Deletes cloud process and all related data from MBrace cluster.

ClearSystemLogs()
Signature: unit -> unit

Clears all system logs from the cluster state.

ClearSystemLogsAsync()
Signature: unit -> Async<unit>

Asynchronously clears all system logs from the cluster state.

CreateCancellationTokenSource(parents)
Signature: (parents:ICloudCancellationToken []) -> ICloudCancellationTokenSource

Creates a fresh cloud cancellation token source for use in the MBrace cluster.

CreateProcess(...)
Signature: (workflow:Cloud<'T> * cancellationToken:ICloudCancellationToken option * faultPolicy:FaultPolicy option * target:IWorkerRef option * additionalResources:ResourceRegistry option * taskName:string option) -> CloudProcess<'T>
Type parameters: 'T

Submits supplied cloud computation for execution in the current MBrace runtime. Returns an instance of CloudProcess, which can be queried for information on the progress of the computation.

CreateProcessAsync(...)
Signature: (workflow:Cloud<'T> * cancellationToken:ICloudCancellationToken option * faultPolicy:FaultPolicy option * target:IWorkerRef option * additionalResources:ResourceRegistry option * taskName:string option) -> Async<CloudProcess<'T>>
Type parameters: 'T

Asynchronously submits supplied cloud computation for execution in the current MBrace runtime. Returns an instance of CloudProcess, which can be queried for information on the progress of the computation.

FaultPolicy()
Signature: unit -> FaultPolicy

Gets or sets the default fault policy used by computations uploaded by this client instance.

CompiledName: set_FaultPolicy

FaultPolicy()
Signature: unit -> unit

Gets or sets the default fault policy used by computations uploaded by this client instance.

CompiledName: get_FaultPolicy

FormatProcesses()
Signature: unit -> string

Gets a printed report of all current cloud processes.

FormatWorkers()
Signature: unit -> string

Gets a printed report on all workers on the runtime

GetAllProcesses()
Signature: unit -> CloudProcess []

Gets a collection of all running or completed cloud processes that exist in the current MBrace runtime.

GetProcessById(processId)
Signature: processId:string -> CloudProcess

Looks up a CloudProcess instance from cluster using supplied identifier.

GetResource()
Signature: unit -> 'TResource
Type parameters: 'TResource

Resolves runtime resource of given type

GetSystemLogs(worker, logLevel, filter)
Signature: (worker:IWorkerRef option * logLevel:LogLevel option * filter:(SystemLogEntry -> bool) option) -> SystemLogEntry []

Fetches all system logs generated by all workers in the MBrace runtime.

GetSystemLogsAsync(...)
Signature: (worker:IWorkerRef option * logLevel:LogLevel option * filter:(SystemLogEntry -> bool) option) -> Async<SystemLogEntry []>

Asynchronously fetches all system logs generated by all workers in the MBrace runtime.

LogLevel()
Signature: unit -> LogLevel

Gets or sets the system log level used by the client process.

CompiledName: set_LogLevel

LogLevel()
Signature: unit -> unit

Gets or sets the system log level used by the client process.

CompiledName: get_LogLevel

NativeDependencies
Signature: string []

Gets native assembly dependencies registered to client state.

CompiledName: get_NativeDependencies

RegisterNativeDependency(assemblyPath)
Signature: assemblyPath:string -> unit

Registers a native assembly dependency to client state.

remove_SystemLogs(arg1)
Signature: Handler<SystemLogEntry> -> unit

Event for subscribing to runtime-wide system logs

Reset()
Signature: unit -> unit

Resets cluster state. This will cancel and delete all cloud process data.

ResetAsync()
Signature: unit -> Async<unit>

Resets cluster state. This will cancel and delete all cloud process data.

Run(...)
Signature: (workflow:Cloud<'T> * cancellationToken:ICloudCancellationToken option * faultPolicy:FaultPolicy option * target:IWorkerRef option * additionalResources:ResourceRegistry option * taskName:string option) -> 'T
Type parameters: 'T

Submits a cloud computation for execution in the current MBrace runtime and waits until the computation completes with a value or fails with an exception.

RunAsync(...)
Signature: (workflow:Cloud<'T> * cancellationToken:ICloudCancellationToken option * faultPolicy:FaultPolicy option * additionalResources:ResourceRegistry option * target:IWorkerRef option * taskName:string option) -> Async<'T>
Type parameters: 'T

Asynchronously submits a cloud computation for execution in the current MBrace runtime and waits until the computation completes with a value or fails with an exception.

RunLocally(...)
Signature: (workflow:Cloud<'T> * cancellationToken:ICloudCancellationToken option * memoryEmulation:MemoryEmulation option) -> 'T
Type parameters: 'T

Asynchronously executes supplied cloud computation within the current, client process. Parallelism is afforded through the .NET thread pool.

RunLocallyAsync(...)
Signature: (workflow:Cloud<'T> * memoryEmulation:MemoryEmulation option) -> Async<'T>
Type parameters: 'T

Asynchronously executes supplied cloud computation within the current, client process. Parallelism is afforded through the .NET thread pool.

ShowProcesses()
Signature: unit -> unit

Prints a report of all current cloud processes to stdout.

ShowSystemLogs(worker, logLevel, filter)
Signature: (worker:IWorkerRef option * logLevel:LogLevel option * filter:(SystemLogEntry -> bool) option) -> unit

Prints all system logs generated by all workers in the cluster to stdout.

ShowWorkers()
Signature: unit -> unit

Prints a report on all workers on the runtime to stdout

Store
Signature: CloudStoreClient

Gets a client object that can be used for interoperating with the MBrace store.

CompiledName: get_Store

SystemLogs
Signature: IEvent<SystemLogEntry>

Event for subscribing to runtime-wide system logs

CompiledName: get_SystemLogs

TryGetProcessById(processId)
Signature: processId:string -> CloudProcess option

Attempts to get a cloud process instance using supplied identifier.

Workers
Signature: WorkerRef []

Gets all available workers for the MBrace runtime.

CompiledName: get_Workers

Fork me on GitHub