MailboxProcessor.Receive<'Msg> メソッド (F#)

[アーティクル]
08/09/2011

更新 : 2011 年 1 月

メッセージを待機します。最初に到着したメッセージが処理されます。

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

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

// Signature:
member this.Receive : ?int -> Async<'Msg>

// Usage:
mailboxProcessor.Receive ()
mailboxProcessor.Receive (timeout = timeout)

パラメーター

timeout
型: int

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

例外

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

戻り値

受信したメッセージを返す非同期計算 (Async オブジェクト)。

解説

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

使用例

Receive メソッドを使用する方法の例を次に示します。ここでは、タイムアウト値として 10 秒を指定します。通常、メッセージ処理関数は Post 関数とは別のスレッドで実行されるので、メッセージプロセッサ関数でタイムアウト例外をキャッチする必要があります。この例では、タイムアウト例外が発生すると、ループが継続し、メッセージ番号が 1 増えます。

open System

type Message = string * AsyncReplyChannel<string>

let formatString = "Message number {0} was received. Message contents: {1}"

let agent = MailboxProcessor<Message>.Start(fun inbox ->
    let rec loop n =
        async {            
            try
                let! (message, replyChannel) = inbox.Receive(10000);

                if (message = "Stop") then
                    replyChannel.Reply("Stop")
                else
                    replyChannel.Reply(String.Format(formatString, n, message))
                do! loop (n + 1)

            with
            | :? TimeoutException -> 
                printfn "The mailbox processor timed out."
                do! loop (n + 1)
        }
    loop (0))

printfn "Mailbox Processor Test"
printfn "Type some text and press Enter to submit a message."
printfn "Type 'Stop' to close the program."


let rec loop() =
    printf "> "
    let input = Console.ReadLine()
    let reply = agent.PostAndReply(fun replyChannel -> input, replyChannel)
    if (reply <> "Stop") then
        printfn "Reply: %s" reply
        loop()
    else
        ()
loop()

printfn "Press Enter to continue."
Console.ReadLine() |> ignore

以下に一般的なセッションを示します。タイムアウトにより、メッセージ 2 がスキップされていることに注目してください。

プラットフォーム

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

バージョン情報

F# ランタイム

サポート対象: 2.0、4.0

Silverlight

サポート: 3

参照

その他の技術情報

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

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

履歴の変更

日付	履歴	理由
2011 年 1 月	コード例を追加。	情報の拡充

2011 年 1 月

コード例を追加。

情報の拡充

次の方法で共有