Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ifMessagePort

GetMessage() As Object

Returns the event object if available. Otherwise, Invalid is returned. In either case, this method returns immediately without waiting.

WaitMessage(timeout As Integer) As Object
 

Waits until an event object is available or the specified amount of milliseconds have passed. When an event object becomes available, it will be returned. If the timeout is reached, Invalid will be returned. Passing zero as the timeout instructs this method to wait indefinitely for a message.

You can also use the Wait() global function to retrieve event objects over a specified interval. The following two statements have the same effect:

Code Block
msg = port.WaitMessage(timeout)
msg = wait(timeout, port)
PostMessage(msg As Object) As Void
 
PeekMessage() As Object

Returns the event object if available (or Invalid if otherwise), but does not remove the event object from the message queue; a later call to GetMessage(), WaitMessage(), or PeekMessage() will return the same event object. 

SetWatchdogTimeout(seconds As Integer) As Integer

...

Note
titleNote

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

DeferWatchdog(

...

seconds 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.

...

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

Note
titleNote

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

...

Returns True if there is not a next element.