HIP: Heterogenous-computing Interface for Portability
Public Member Functions | Public Attributes | Friends | List of all members
ihipEvent_t Class Reference

Public Member Functions

 ihipEvent_t (unsigned flags)
 
void attachToCompletionFuture (const hc::completion_future *cf, hipStream_t stream, ihipEventType_t eventType)
 
void refereshEventStatus ()
 
uint64_t timestamp () const
 
ihipEventType_t type () const
 

Public Attributes

hipEventStatus_t _state
 
hipStream_t _stream
 
unsigned _flags
 
hc::completion_future _marker
 

Friends

hipError_t hipEventRecord (hipEvent_t event, hipStream_t stream)
 Record an event in the specified stream. More...
 

Friends And Related Function Documentation

hipError_t hipEventRecord ( hipEvent_t  event,
hipStream_t  stream 
)
friend

Record an event in the specified stream.

Parameters
[in]eventevent to record.
[in]streamstream in which to record event.
Returns
hipSuccess, hipErrorInvalidValue, hipErrorInitializationError, hipErrorInvalidResourceHandle, hipErrorLaunchFailure

hipEventQuery() or hipEventSynchronize() must be used to determine when the event transitions from "recording" (after hipEventRecord() is called) to "recorded" (when timestamps are set, if requested).

Events which are recorded in a non-NULL stream will transition to from recording to "recorded" state when they reach the head of the specified stream, after all previous commands in that stream have completed executing.

If hipEventRecord() has been previously called on this event, then this call will overwrite any existing state in event.

If this function is called on a an event that is currently being recorded, results are undefined - either outstanding recording may save state into the event, and the order is not guaranteed.

See also
hipEventCreate, hipEventCreateWithFlags, hipEventQuery, hipEventSynchronize, hipEventDestroy, hipEventElapsedTime

The documentation for this class was generated from the following files: