IDispatchable.TimedDispatch

Method

Visual Basic

Function TimedDispatch (
    ByVal timeout As Double )
  As Boolean

C#

bool TimedDispatch (
    double timeout );

Purpose

Dispatch an event, but if no event is ready to dispatch, limit the time that this call blocks while waiting for an event.

Remarks

If an event is ready to dispatch, then this call dispatches it, and then returns. If no events are waiting, this call waits for an event to arrive. If an event arrives before the waiting time elapses, then it dispatches the event and returns. If the waiting time elapses first, then the call returns without dispatching an event.

When the call dispatches an event, it returns true. When the call does not dispatch an event, it returns false.

Both Queue and QueueGroup implement this method.

Parameter	Description
timeout	Maximum time (in seconds) that this call can block while waiting for an event to arrive. TimeoutValue.NoWait indicates no blocking (immediate timeout). TimeoutValue.WaitForever indicates no timeout.

See Also

IDispatchable

Queue.TimedDispatch

QueueGroup.TimedDispatch