NT_EventRead

Reference Documentation

product_line_custom
Napatech SmartNIC
category
Reference Information
int NT_EventRead ( NtEventStream_t hStream,
    NtEvent_t * event,
    uint32_t timeout
  )    

Reads an event from an event queue.

This function is called by the user to read an event. The event is copied from the event queue to the stream handle for the user to read using the HAL functions. The event is marked as read for deletion and cannot be read by the user again.

Parameters

[in] hStream

Stream to store the current event

[out] event

Event structure - the event information is returned in this structure

[in] timeout

Time in milliseconds to wait for an event

Return values

==

NT_SUCCESS: Success

!=

NT_SUCCESS: Error

Definition at line 319 of file stream_event.h.

Referenced by main().