6.1-roMessagePort

ON THIS PAGE


A message port is the destination where messages (events) are sent. See the explanation of Event Loops for more details. You do not call these functions directly when using BrightScript. Instead, use the Wait() global function.

ifMessagePort

GetMessage() As Object

WaitMessage(timeout As Integer) As Object
 
PostMessage(msg As Object) As Void
 
PeekMessage() As Object
 
SetWatchdogTimeout(seconds As Integer) As Integer

Enables a watchdog timeout on the roMessagePort instance. The watchdog on roMessagePort is disabled by default. Passing a positive integer to this method instructs the watchdog to crash and reboot the player if GetMessage() or WaitMessage() does not return after the specified number of seconds. Passing zero to this method disables the watchdog again.

Note

The watchdog timeout will not trigger while waiting on the BrightScript debugger prompt.

DeferWatchdog(a As Integer)

Defers the watchdog timeout set by the SetWatchdogTimeout() method. Passing an integer to this method defers the timeout for the specified number of seconds.

DeferWatchdog()

Defers the watchdog timeout by the amount of seconds set in the SetWatchdogTimeout() method.

Note

Calls to either DeferWatchdog() method cannot cause the watchdog to trigger earlier than it already will. For example, calling DeferWatchdog(100) followed by DeferWatchdog(10) will still cause the watchdog to trigger after 100 seconds.

ifEnum

Reset()

Resets the position to the first element of enumeration.

Next() As Dynamic

Returns the typed value at the current position and increment position.

IsNext() As Boolean

Returns True if there is a next element.

IsEmpty() As Boolean

Returns True if there is not a next element.