Click or drag to resize

ListAPI.TryWaitForListIdle Method

Waits up to timeout for a ListIdle event to be reported from the card.

Namespace: RAYLASE.SPICE3.ClientLib
Assembly: RAYLASE.SPICE3.ClientLib (in RAYLASE.SPICE3.ClientLib.dll) Version: 3.7.1
Syntax
C#
public bool TryWaitForListIdle(
	out int? listID,
	int? timeout = null
)

Parameters

listID  Nullable<Int32>
Receives the Card-CommandList Identifier of the first list to become idle since the last time this function was called.
timeout  Nullable<Int32>  (Optional)
null
(or omitted)
use the default timeout period specified by ClientAPI.Timeout
  -1wait indefinitely for the event
   0do not wait, simply check if an event has already been reported
 > 0timeout period in ms

Return Value

Boolean
trueif an event is reported within the specified timeout period,
falseotherwise.
Exceptions
Remarks
  • Note that in case of a timeout this function will always return false.

    See WaitForListIdle(Nullable<Int32> , Nullable<Int32> ) if you wish to wait for a TimeoutException instead.

  • Waiting can be interrupted by calling InterruptWaitForListIdle().

    Doing so will cause a ThreadInterruptedException.

  • Like all methods which involve communication with the card, this method is not thread-safe.
  • An idle event occurs when the card firmware has finished processing a list, and signals that the original list contents can now be altered again by the client.
  • The event occurs regardless of how the list was called for execution: either explicitly ( ListAPI.Execute(Int32)), or as a sublist from another list.

    Note, however, that the event does not imply that all of the micro-vectors generated by the list have been output yet ( WaitForListDone(Nullable<Int32>, Nullable<Int32>)).

See Also