[Home] Type Microsoft.FSharp.Control.AsyncGroup


A handle to a capability to cancel a set of asynchronous computations.

Full Type Signature

[<SealedAttribute ()>]
type AsyncGroup =
  class
    new : unit -> AsyncGroup
    member Run : computation:Async<'a> * ?timeout:int * ?exitContext:bool -> 'a
    member
      RunPrimitive : continuation:('a -> unit) * exceptionContinuation:(exn -> unit) *
                     cancellationContinuation:(OperationCanceledException -> unit) -> (Async<'a> -> unit)
    member Spawn : computation:Async<unit> -> unit
    member SpawnFuture : computation:Async<'a> -> AsyncFuture<'a>
    member TriggerCancel : ?message:string -> unit
  end

Instance Members

MemberDescription
member
  Run : computation:Async<'a> * ?timeout:int * ?exitContext:bool -> 'a
 Run the asynchronous computation and await its result. If an exception occurs in the asynchronous computation then an exception is re-raised by this function. 
member
  RunPrimitive : continuation:('a -> unit) * exceptionContinuation:(exn -> unit) *
                 cancellationContinuation:(OperationCanceledException -> unit)
                 -> (Async<'a> -> unit)
 Start the asynchronous computation in the .NET thread pool, initially as a CPU-intensive worker item. Return a handle to the computation as an AsyncFuture. 
member Spawn : computation:Async<unit> -> unit
 Start the asynchronous computation in the thread pool. Do not await its result. 
member SpawnFuture : computation:Async<'a> -> AsyncFuture<'a>
 Start the asynchronous computation in the .NET thread pool, initially as a CPU-intensive worker item. Return a handle to the computation as an AsyncFuture. 
member TriggerCancel : ?message:string -> unit
 Raise the cancellation condition for this group of computations

Static Members

MemberDescription
new : unit -> AsyncGroup

See Also

Microsoft.FSharp.Control


Documentation for assembly FSharp.Core, version 1.9.6.0, generated using F# Programming Language version 1.9.6.0