Share via

MailboxProcessor.Scan<'Msg,'T> メソッド (F#)

  • [アーティクル]

指定された関数が Some 値を返すまで、到着順にメッセージを検索して、メッセージをスキャンします。他のメッセージはキューに残ります。

名前空間/モジュール パス: Microsoft.FSharp.Control

アセンブリ: FSharp.Core (FSharp.Core.dll 内)

// Signature:
member this.Scan : ('Msg -> Async<'T> option) * ?int -> Async<'T>

// Usage:
mailboxProcessor.Scan (scanner)
mailboxProcessor.Scan (scanner, timeout = timeout)

パラメーター

  • scanner
    型: 'Msg -> Async<'T> option

    メッセージをスキップする場合は None、メッセージを処理してキューから削除する場合は Some を返す関数。

  • timeout
    型: int

    オプションのタイムアウト (ミリ秒単位)。既定値は Infinite に対応する -1 です。

例外

例外

状態

TimeoutException

タイムアウト値を超えたときにスローされます。

戻り値

既読メッセージ以外から scanner が構築した非同期計算 (Async オブジェクト)。

解説

このメソッドは、エージェントの本体の内部で使用されます。同時にアクティブにできるリーダーはエージェントごとに最大 1 つであるため、Receive、TryReceive、Scan、または TryScan の呼び出しは一度に 1 つしかアクティブにできません。scanner 関数の本体は実行中にロックされますが、ロックは非同期ワークフローの実行前に解放されます。

使用例

Scan メソッドを使用する方法の例を次に示します。このコードでは、メールボックス プロセッサ エージェントが、実行して結果を計算する一連のシミュレートされたジョブを管理しています。

以下にサンプル セッションを示します。

プラットフォーム

Windows 8、Windows 7、Windows Server 2012 で Windows Server 2008 R2

バージョン情報

F# コア ライブラリのバージョン

サポート: ポータブル 2.0、4.0

参照

関連項目

Control.MailboxProcessor<'Msg> クラス (F#)

Microsoft.FSharp.Control 名前空間 (F#)