Difference between revisions of "Channel:supply"

Latest revision as of 11:06, 7 July 2021

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.

success = Channel:supply( value )

Available since LÖVE 11.0

boolean success: Whether the message was successfully supplied (always true).

Available since LÖVE 11.0

This variant is not supported in earlier versions.

success = Channel:supply( value, timeout )

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

@@ Line 2: / Line 2: @@
 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, LÖVE userdata, or a simple flat table. Foreign userdata (Lua's files, LuaSocket, ENet, ...), functions, and tables inside tables are not supported.
+See [[Variant]] for the list of supported types.
 == Function ==
 === Synopsis ===
 <source lang="lua">
-Channel:supply( value )
+success = Channel:supply( value )
 </source>
 === Arguments ===
-{{param|value|value|The contents of the message.}}
+{{param|Variant|value|The contents of the message.}}
 === 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, in seconds.}}
+=== Returns ===
+{{param|boolean|success|Whether the message was successfully supplied before the timeout expired.}}
 == See Also ==
 * [[parent::Channel]]