MailboxProcessor.TryReceive<'Msg> メソッド (F#)
メッセージを待機します。最初に到着したメッセージが処理されます。
名前空間/モジュール パス: Microsoft.FSharp.Control
アセンブリ: FSharp.Core (FSharp.Core.dll 内)
// Signature:
member this.TryReceive : ?int -> Async<'Msg option>
// Usage:
mailboxProcessor.TryReceive ()
mailboxProcessor.TryReceive (timeout = timeout)
パラメーター
timeout
型: intオプションのタイムアウト (ミリ秒単位)。既定値は Infinite に対応する -1 です。
戻り値
タイムアウト時間が経過した場合に、受信したメッセージまたは None を返す非同期計算 (Async オブジェクト)。
解説
このメソッドは、エージェントの本体の内部で使用されます。タイムアウトを指定した場合、そのタイムアウトを超えると None が返されます。このメソッドは、エージェントの本体の内部で使用されます。同時にアクティブにできるリーダーはエージェントごとに最大 1 つであるため、Receive、TryReceive、Scan、または TryScan の呼び出しは一度に 1 つしかアクティブにできません。
使用例
次の例は、TryReceive を使用する方法を示しています。メッセージが 10 秒以内に受信されない場合、タイムアウトが発生し、メッセージ ID が 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 {
let! opt = inbox.TryReceive(10000);
match opt with
| None -> do! loop(n + 1)
| Some (message, replyChannel) ->
// The delay gets longer with each message, and eventually triggers a timeout.
if (message = "Stop") then
replyChannel.Reply("Stop")
else
replyChannel.Reply(String.Format(formatString, n, message))
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 mutable isCompleted = false
while (not isCompleted) do
printf "> "
let input = Console.ReadLine()
let reply = agent.PostAndReply(fun replyChannel -> input, replyChannel)
if (reply <> "Stop") then
printfn "Reply: %s" reply
else
isCompleted <- true
printfn "Press Enter to continue."
Console.ReadLine() |> ignore
以下にサンプル セッションを示します。タイムアウトにより、メッセージ番号 2 がスキップされていることに注目してください。
プラットフォーム
Windows 8、Windows 7、Windows Server 2012 で Windows Server 2008 R2
バージョン情報
F# コア ライブラリのバージョン
サポート: ポータブル 2.0、4.0