Rednet.receive - Revision history

Bomb Bloke: Can receive types other than strings.

2015-06-14T13:53:01Z

Can receive types other than strings.

Bomb Bloke at 09:28, 17 June 2014

2014-06-17T09:28:48Z

Bomb Bloke: A long planned rewrite

2014-06-06T06:33:52Z

A long planned rewrite

Cranium: Changing float to number

2013-07-18T11:53:02Z

Changing float to number

Watcher7 at 06:54, 3 December 2012

2012-12-03T06:54:36Z

90.20.31.177 at 06:50, 3 December 2012

2012-12-03T06:50:23Z

AfterLifeLochie: Corrected links. Please do not link to pages that contain a parameter struct; they will be shortly deleted!

2012-11-30T10:44:31Z

Corrected links. Please do not link to pages that contain a parameter struct; they will be shortly deleted!

Jonjon1234 at 10:41, 30 November 2012

2012-11-30T10:41:56Z

AfterLifeLochie: Hurr. Fixed one, broke another.

2012-11-28T22:01:41Z

Hurr. Fixed one, broke another.

AfterLifeLochie: Fixed references to pages.

2012-11-28T22:01:14Z

Fixed references to pages.

@@ Line 3: / Line 3: @@
 |name=rednet.receive
 |args=[<nowiki/> [<nowiki/>{{type|string}} protocolFilter, ] {{type|number}} timeout]
-|returns={{type|number}} senderID, {{type|string}} message, {{type|string}} protocol
+|returns={{type|number}} senderID, {{type|any}} message, {{type|string}} protocol
 |api=rednet
 |addon=ComputerCraft
-|desc=Waits for ''timeout'' seconds, or until a [[rednet_message_(event)|rednet_message]] event is found in the event queue (with a matching [[Rednet (API)#Protocols|protocol]], if specified). The system must have a [[modem]] that's been [[rednet.open|readied for rednet usage]] in order for this to function; messages may then be sent to it from remote systems via [[rednet.send|rednet.send()]] / [[rednet.broadcast|rednet.broadcast()]].<br><br>
+|desc=Waits for ''timeout'' seconds, or until a [[rednet_message_(event)|rednet_message]] event is found in the event queue (with a matching [[Rednet (API)#Protocols|protocol]], if specified). The system must have a [[modem]] that's been [[rednet.open|readied for rednet usage]] in order for this to function; messages may then be sent to it from remote systems via [[rednet.send|rednet.send()]] / [[rednet.broadcast|rednet.broadcast()]].
-Due to the nature of how [[os.pullEvent|events are pulled]], using this function will generally cause the system to discard and ignore any other events that occur until the message is received or the time out ends (though Ctrl+T can generally be used to terminate it, if need be). Likewise, if the system is not specifically listening when a given message is sent, chances are high that another "event-eating" function (eg a [[turtle (API)|turtle movement call]] or most anything else that pauses code execution, such as "sleep") will discard it, making it impossible to "receive". This issue can be bypassed using [[Coroutine (API)|co-routines]] - notably, the [[parallel (API)|parallel API]] offers easy work-arounds.<br><br>
+Due to the nature of how [[os.pullEvent|events are pulled]], using this function will generally cause the system to discard and ignore any other events that occur until the message is received or the time out ends (though Ctrl+T can generally be used to terminate it, if need be). Likewise, if the system is not specifically listening when a given message is sent, chances are high that another "event-eating" function (eg a [[turtle (API)|turtle movement call]] or most anything else that pauses code execution, such as "sleep") will discard it, making it impossible to "receive". This issue can be bypassed using [[Coroutine (API)|co-routines]] - notably, the [[parallel (API)|parallel API]] offers easy work-arounds.
-If a time out value is specified and reached, then {{type|nil}} is returned. Note that protocols are only supported by ComputerCraft 1.6 or later - versions prior returned the distance between the sender and receiver instead (information that can still be gained by inspecting [[modem_message_(event)|modem_message]] events directly, but which may not be "accurate" depending on whether any [[Repeat|Rednet repeaters]] are active on your network).<br><br>
+If a time out value is specified and reached, then {{type|nil}} is returned. Note that protocols are only supported by ComputerCraft 1.6 or later - versions prior returned the distance between the sender and receiver instead (information that can still be gained by inspecting [[modem_message_(event)|modem_message]] events directly, but which may not be "accurate" depending on whether any [[Repeat|Rednet repeaters]] are active on your network).
 This command listens on modem channel numbers equal to the system's own [[os.getComputerID|ID]] and 65535 (the latter of which is used for broadcasts). More channels may be opened and listened on by dealing with your modems directly via [[Modem (API)|their own API]].

@@ Line 10: / Line 10: @@
 Due to the nature of how [[os.pullEvent|events are pulled]], using this function will generally cause the system to discard and ignore any other events that occur until the message is received or the time out ends (though Ctrl+T can generally be used to terminate it, if need be). Likewise, if the system is not specifically listening when a given message is sent, chances are high that another "event-eating" function (eg a [[turtle (API)|turtle movement call]] or most anything else that pauses code execution, such as "sleep") will discard it, making it impossible to "receive". This issue can be bypassed using [[Coroutine (API)|co-routines]] - notably, the [[parallel (API)|parallel API]] offers easy work-arounds.<br><br>
-If a time out value is specified and reached, then {{type|nil}} is returned. Note that protocols are only supported by ComputerCraft 1.6 or later - versions prior returned the distance between the sender and receiver instead (information that can still be gained by inspecting [[modem_message_(event)|modem_message]] events directly, but which may not be "accurate" depending on whether any [[Repeat (program)|Rednet repeaters]] are active on your network).<br><br>
+If a time out value is specified and reached, then {{type|nil}} is returned. Note that protocols are only supported by ComputerCraft 1.6 or later - versions prior returned the distance between the sender and receiver instead (information that can still be gained by inspecting [[modem_message_(event)|modem_message]] events directly, but which may not be "accurate" depending on whether any [[Repeat|Rednet repeaters]] are active on your network).<br><br>
 This command listens on modem channel numbers equal to the system's own [[os.getComputerID|ID]] and 65535 (the latter of which is used for broadcasts). More channels may be opened and listened on by dealing with your modems directly via [[Modem (API)|their own API]].

@@ Line 2: / Line 2: @@
 {{Function
 |name=rednet.receive
-|args={{type|number}} timeoutSeconds
+|args=[<nowiki/> [<nowiki/>{{type|string}} protocolFilter, ] {{type|number}} timeout]
-|returns=senderID, message, distance-to-sender (or <code>nil</code> if using redpower bundled cable instead of a modem)
+|returns={{type|number}} senderID, {{type|string}} message, {{type|string}} protocol
 |api=rednet
 |addon=ComputerCraft
-|desc=Waits for <var>timeoutSeconds</var> or until another computer sends a message to this computer. (see [[rednet.broadcast|rednet.broadcast( message )]] and [[rednet.send|rednet.send( receiverID, message )]].  If a Timeout occurs the return id and message are set to nil.  If timeout is nil, waits forever.<br />To get the id from a computer see  [[Os.getComputerID|os.getComputerID()]], or the [[id]] program.<br/>You must be calling this function at the moment a message is sent, or you will miss it.  If you need to watch for messages while doing something else at the same time, see [[Parallel.waitForAny|parallel.waitForAny()]]
+|desc=Waits for ''timeout'' seconds, or until a [[rednet_message_(event)|rednet_message]] event is found in the event queue (with a matching [[Rednet (API)#Protocols|protocol]], if specified). The system must have a [[modem]] that's been [[rednet.open|readied for rednet usage]] in order for this to function; messages may then be sent to it from remote systems via [[rednet.send|rednet.send()]] / [[rednet.broadcast|rednet.broadcast()]].<br><br>
 |examples=
 {{Example
-|desc=Waits forever until someone sends a message to this computer and displays it.
+|desc=Prints 2 - 4 messages, depending on what's received.
-|code=local senderId, message, distance = rednet.receive()<br>term.write(message)
+|code=-- Waits until someone sends a message to this computer, then displays it.
-|output=The received message.
+ local senderId, message, protocol = rednet.receive()
 }}
 }}
 [[Category:API_Functions]]

@@ Line 2: / Line 2: @@
 {{Function
 |name=rednet.receive
-|args=[[float (type)|float]] timeoutSeconds
+|args={{type|number}} timeoutSeconds
 |returns=senderID, message, distance-to-sender (or <code>nil</code> if using redpower bundled cable instead of a modem)
 |api=rednet

@@ Line 10: / Line 10: @@
 {{Example
 |desc=Waits forever until someone sends a message to this computer and displays it.
-|code=senderId, message, distance = rednet.receive()<br>term.write(message)
+|code=local senderId, message, distance = rednet.receive()<br>term.write(message)
 |output=The received message.
 }}