Name

Vix_PumpEvents

Description

void
Vix_PumpEvents(VixHandle hostHandle,
               VixPumpEventsOptions options);

Vix_PumpEvents is used in single threaded applications that require the Vix library to be single threaded. Tasks that would normally be executed in a separate thread by the Vix library will be executed when Vix_PumpEvents() is called.

Parameters

hostHandle: The handle to the local host object.
options: Must be 0.

Return Value

None.

Remarks

This option is designed for client applications that want to receive events on only one thread, such as a thread that manages the user interface. In this case, open the local host handle with the VIX_HOSTOPTION_USE_EVENT_PUMP option, and call Vix_PumpEvents() in the main event loop. If you fail to call Vix_PumpEvents(), Vix asynchronous actions will not execute.
If you do not open your local host with the VIX_HOSTOPTION_USE_EVENT_PUMP option, calling Vix_PumpEvents(), has no effect. If you do not open your local host with the VIX_HOSTOPTION_USE_EVENT_PUMP option, the VIX API creates a small pool of threads for executing asynchronous operations. Events can be posted from those worker threads, so your code must be thread-safe.

Side Effects

None.

Requirements

vix.h, since VMware Server 1.0.