Difference between revisions of "Channel:supply"

m (Removed excessive links)
m (0.11.0 -> 11.0)
(6 intermediate revisions by 4 users not shown)
Line 2: Line 2:
 
Send a message to the thread Channel and wait for a thread to accept it.
 
Send a message to the thread Channel and wait for a thread to accept it.
  
The value of the message can be a boolean, string, number or a LÖVE userdata. Foreign userdata (Lua's files, LuaSocket, ...), functions or tables are not supported.
+
See [[Variant]] for the list of supported types.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Channel:supply( value )
+
success = Channel:supply( value )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|value|value|The contents of the message.}}
+
{{param|Variant|value|The contents of the message.}}
 
=== Returns ===
 
=== Returns ===
None.
+
{{New feature|11.0|
 +
{{param|boolean|success|Whether the message was successfully supplied (always <code>true</code>).}}
 +
|110}}
 +
 
 +
== Function ==
 +
{{newin|[[11.0]]|110|type=variant}}
 +
=== Synopsis ===
 +
<source lang="lua">
 +
success = Channel:supply( value, timeout )
 +
</source>
 +
=== Arguments ===
 +
{{param|Variant|value|The contents of the message.}}
 +
{{param|number|timeout|The maximum amount of time to wait.}}
 +
=== Returns ===
 +
{{param|boolean|success|Whether the message was successfully supplied before the timeout expired.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::Channel]]
 
* [[parent::Channel]]
 +
* [[Channel:demand]]
 
* [[Channel:push]]
 
* [[Channel:push]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Send a message to a thread [[Channel]] and wait for a thread to accept it.}}
+
{{#set:Description=Send a message to a thread Channel and wait for a thread to accept it.}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|Channel:supply}}
 
{{i18n|Channel:supply}}

Revision as of 14:19, 22 December 2018

Available since LÖVE 0.9.0
This function is not supported in earlier versions.

Send a message to the thread Channel and wait for a thread to accept it.

See Variant for the list of supported types.

Function

Synopsis

success = Channel:supply( value )

Arguments

Variant value
The contents of the message.

Returns

Available since LÖVE 11.0
boolean success
Whether the message was successfully supplied (always true).


Function

Available since LÖVE 11.0
This variant is not supported in earlier versions.

Synopsis

success = Channel:supply( value, timeout )

Arguments

Variant value
The contents of the message.
number timeout
The maximum amount of time to wait.

Returns

boolean success
Whether the message was successfully supplied before the timeout expired.

See Also

Other Languages