#[repr(C)]pub struct Event(/* private fields */);
Expand description
cl_event
Implementations§
source§impl Event
impl Event
sourcepub fn null() -> Event
pub fn null() -> Event
For passage directly to an ‘event creation’ function (such as enqueue…).
sourcepub fn user<C: ClContextPtr>(context: C) -> OclCoreResult<Event>
pub fn user<C: ClContextPtr>(context: C) -> OclCoreResult<Event>
Creates and returns a new ‘user’ event.
User events are events which are meant to have their completion status set from the host side (that means you).
sourcepub unsafe fn from_raw_create_ptr(ptr: cl_event) -> Event
pub unsafe fn from_raw_create_ptr(ptr: cl_event) -> Event
Only call this when passing the original newly created pointer
directly from clCreate...
. Do not use this to clone or copy.
sourcepub unsafe fn from_raw_copied_ptr(ptr: cl_event) -> OclCoreResult<Event>
pub unsafe fn from_raw_copied_ptr(ptr: cl_event) -> OclCoreResult<Event>
Only use when cloning or copying from a pre-existing and valid
cl_event
.
sourcepub fn set_complete(&self) -> OclCoreResult<()>
pub fn set_complete(&self) -> OclCoreResult<()>
Sets this user created event to CommandExecutionStatus::Complete
.
Will return an error if this event is not a ‘user’ event (created
with ::user()
).
sourcepub fn is_complete(&self) -> OclCoreResult<bool>
pub fn is_complete(&self) -> OclCoreResult<bool>
Queries the command status associated with this event and returns true if it is complete, false if incomplete or upon error.
This is the fastest possible way to determine event status.
sourcepub fn wait_for(&self) -> OclCoreResult<()>
pub fn wait_for(&self) -> OclCoreResult<()>
Causes the command queue to wait until this event is complete before returning.
sourcepub fn is_null(&self) -> bool
pub fn is_null(&self) -> bool
Returns whether or not this event is associated with a command or is a user event.
sourcepub fn is_valid(&self) -> bool
pub fn is_valid(&self) -> bool
[FIXME]: ADD VALIDITY CHECK BY CALLING ‘_INFO’ OR SOMETHING: NULL CHECK IS NOT ENOUGH
This still leads to crazy segfaults when non-event pointers (random whatever addresses) are passed. Need better check.
sourcepub unsafe fn set_callback(
&self,
callback_receiver: EventCallbackFn,
user_data_ptr: *mut c_void
) -> OclCoreResult<()>
pub unsafe fn set_callback( &self, callback_receiver: EventCallbackFn, user_data_ptr: *mut c_void ) -> OclCoreResult<()>
Sets a callback function, callback_receiver
, to trigger upon
completion of this event with an optional pointer to user data.
The callback function must have a signature matching:
extern "C" fn (ffi::cl_event, i32, *mut libc::c_void)
Safety
user_data
must be guaranteed to still exist if and when callback_receiver
is ever called.
TODO: Create a safer type wrapper for callback_receiver
(using an
Arc
?, etc.) within ocl
.
sourcepub fn context(&self) -> OclCoreResult<Context>
pub fn context(&self) -> OclCoreResult<Context>
Returns the Context
associated with this event.
sourcepub unsafe fn as_ptr_ref(&self) -> &cl_event
pub unsafe fn as_ptr_ref(&self) -> &cl_event
Returns an immutable reference to a pointer, do not deref and store it unless you will manage its associated reference count carefully.
Warning
DO NOT store this pointer.
DO NOT send this pointer across threads unless you are incrementing the reference count before sending and decrementing after sending.
Use ::into_raw
for these purposes. Thank you.
sourcepub unsafe fn as_ptr_mut(&mut self) -> &mut cl_event
pub unsafe fn as_ptr_mut(&mut self) -> &mut cl_event
Returns a mutable reference to a pointer, do not deref then modify or store it unless you will manage its associated reference count carefully.
Warning
DO NOT store this pointer.
DO NOT send this pointer across threads unless you are incrementing the reference count before sending and decrementing after sending.
Use ::into_raw
for these purposes. Thank you.
sourcepub fn into_raw(self) -> cl_event
pub fn into_raw(self) -> cl_event
Consumes the Event
, returning the wrapped cl_event
pointer.
To avoid a memory leak the pointer must be converted back to an Event
using
Event::from_raw
.
sourcepub unsafe fn from_raw(ptr: cl_event) -> Event
pub unsafe fn from_raw(ptr: cl_event) -> Event
Constructs an Event
from a raw cl_event
pointer.
The raw pointer must have been previously returned by a call to a
Event::into_raw
.