Difference between revisions of "Channel:demand"
m (correct return type to ''value'') |
m (→Arguments: - SDL_CondWaitTimeout accepts milliseconds, not microseconds.) |
||
| (6 intermediate revisions by 5 users not shown) | |||
| Line 2: | Line 2: | ||
Retrieves the value of a Channel message and removes it from the message queue. | Retrieves the value of a Channel message and removes it from the message queue. | ||
| − | + | It waits until a message is in the queue then returns the message value. | |
== Function == | == Function == | ||
=== Synopsis === | === Synopsis === | ||
| Line 11: | Line 11: | ||
None. | None. | ||
=== Returns === | === Returns === | ||
| − | {{param|value|value|The contents of the message.}} | + | {{param|Variant|value|The contents of the message.}} |
| + | |||
| + | == Function == | ||
| + | {{newin|[[11.0]]|110|type=variant}} | ||
| + | === Synopsis === | ||
| + | <source lang="lua"> | ||
| + | value = Channel:demand( timeout ) | ||
| + | </source> | ||
| + | === Arguments === | ||
| + | {{param|number|timeout|The maximum amount of time to wait, in seconds. Given as a decimal, accurate to the millisecond.}} | ||
| + | |||
| + | === Returns === | ||
| + | {{param|Variant|value|The contents of the message or nil if the timeout expired.}} | ||
== See Also == | == See Also == | ||
* [[parent::Channel]] | * [[parent::Channel]] | ||
| + | * [[Channel:supply]] | ||
* [[Channel:pop]] | * [[Channel:pop]] | ||
| − | |||
[[Category:Functions]] | [[Category:Functions]] | ||
{{#set:Description=Wait for and retrieve the value of a Channel message.}} | {{#set:Description=Wait for and retrieve the value of a Channel message.}} | ||
== Other Languages == | == Other Languages == | ||
{{i18n|Channel:demand}} | {{i18n|Channel:demand}} | ||
Latest revision as of 11:22, 7 July 2021
| Available since LÖVE 0.9.0 |
| This function is not supported in earlier versions. |
Retrieves the value of a Channel message and removes it from the message queue.
It waits until a message is in the queue then returns the message value.
Contents
Function
Synopsis
value = Channel:demand( )
Arguments
None.
Returns
Variant value- The contents of the message.
Function
| Available since LÖVE 11.0 |
| This variant is not supported in earlier versions. |
Synopsis
value = Channel:demand( timeout )
Arguments
number timeout- The maximum amount of time to wait, in seconds. Given as a decimal, accurate to the millisecond.
Returns
Variant value- The contents of the message or nil if the timeout expired.
See Also
Other Languages
Dansk –
Deutsch –
English –
Español –
Français –
Indonesia –
Italiano –
Lietuviškai –
Magyar –
Nederlands –
Polski –
Português –
Română –
Slovenský –
Suomi –
Svenska –
Türkçe –
Česky –
Ελληνικά –
Български –
Русский –
Српски –
Українська –
עברית –
ไทย –
日本語 –
正體中文 –
简体中文 –
Tiếng Việt –
한국어
More info
