Control.MailboxProcessor<'Msg> Constructor (F#)

Creates an agent.

Namespace/Module Path: Microsoft.FSharp.Control

Assembly: FSharp.Core (in FSharp.Core.dll)

// Signature:
new MailboxProcessor : (MailboxProcessor<'Msg> -> Async<unit>) * ?CancellationToken -> MailboxProcessor<'Msg>

// Usage:
new MailboxProcessor (body)
new MailboxProcessor (body, cancellationToken = cancellationToken)

Parameters

• body
  Type: MailboxProcessor<'Msg> -> Async<unit>

  The function to produce an asynchronous computation that will be executed as the read loop for the MailboxProcessor when Start is called.

• cancellationToken
  Type: CancellationToken

  An optional cancellation token for the body. Defaults to Async.DefaultCancellationToken.

Return Value

The created MailboxProcessor.

Remarks

The body function is used to generate the asynchronous computation executed by the agent. This function is not executed until Start is called.

Platforms

Windows 7, Windows Vista SP2, Windows XP SP3, Windows XP x64 SP2, Windows Server 2008 R2, Windows Server 2008 SP2, Windows Server 2003 SP2

Version Information

F# Runtime

Supported in: 2.0, 4.0

Silverlight

Supported in: 3

See Also

Reference

Control.MailboxProcessor<'Msg> Class (F#)

Microsoft.FSharp.Control Namespace (F#)