hipIpcGetEventHandle

Function hipIpcGetEventHandle 

Source
pub unsafe extern "C" fn hipIpcGetEventHandle(
    handle: *mut hipIpcEventHandle_t,
    event: hipEvent_t,
) -> hipError_t
Expand description

@brief Gets an opaque interprocess handle for an event.

The event is previously allocated with #hipEventInterprocess and #hipEventDisableTiming flags. The opaque interprocess handle may be copied into other processes and opened with ::hipIpcOpenEventHandle. Then ::hipEventRecord, ::hipEventSynchronize, ::hipStreamWaitEvent and ::hipEventQuery may be used in either process. After the exported event has been freed with ::hipEventDestroy, operations on the imported event will result in undefined behavior.

@param[out] handle Pointer to #hipIpcEventHandle to return the opaque event handle @param[in] event Event allocated with #hipEventInterprocess and #hipEventDisableTiming flags

@returns #hipSuccess, #hipErrorInvalidConfiguration, #hipErrorInvalidValue

@note This IPC event related feature API is currently applicable on Linux.