INtime SDK Help
hpeWaitForTransmitQueueComplete
INtime SDK v6 > About INtime > Networking and I/O > High-Performance Ethernet > hpeWaitForTransmitQueueComplete

The caller sleeps until the next transmit interrupt occurs for the designated queue. The sleep occurs on a counting semaphore so that the count accumulates for every transmit interrupt. When configured, transmit interrupts occur for every packet transmitted. A microsecond-resolution timeout value may be specified which is rounded to the nearest system clock tick, or INFINITE to indicate that the caller should block until the operation is complete.

Note: This call must be made if hpeOpen was called with the OUTPUT_INTERRUPT flag set.
HPESTATUS hpeWaitForTransmitQueueComplete(
    HPEHANDLE devhandle, 
    DWORD queue_index,
    DWORD timeout_us
);

Parameters

devhandle
A handle value for the device.
queue_index
The index of the designated queue.
timeout_us
A timeout value in microseconds, or INFINITE to indicate that the operation should not time out before completion.

Return Values

A status value indicating the success or failure of the operation:

E_OK The operation completed successfully.
E_EXIST The handle given is not a handle for an open HPE interface.
E_TIME The call timed out before the operation was complete.
E_STATE The driver is not operating in transmit-interrupt mode.
E_LIMIT The queue_index parameter is out of bounds for the current hardware.
E_TRANSMISSION The physical link is down; no buffers can be added to the queue.
If this condition is received, terminate any outstanding receive operation, then close the interface (hpeClose) and reinitialize the software before reopening the interface.

Requirements

Versions Defined in Include Link to
INtime 4.0 intime/rt/include/hpeif2.h hpeif2.h hpeif2.lib
See Also