Difference between revisions of "Channel:supply"

m (value → Variant)
(Add new timeout variant and return value)
Line 6: Line 6:
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Channel:supply( value )
+
success = Channel:supply( value )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 
{{param|Variant|value|The contents of the message.}}
 
{{param|Variant|value|The contents of the message.}}
 
=== Returns ===
 
=== Returns ===
None.
+
{{New feature|0.11.0|
 +
{{param|boolean|success|Whether the message was successfully supplied (always <code>true</code>).}}
 +
|110}}
 +
 
 +
== Function ==
 +
{{newin|[[0.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]]

Revision as of 16:55, 7 January 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 0.11.0
boolean success
Whether the message was successfully supplied (always true).


Function

Available since LÖVE 0.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