Struct ocl_core::types::abs::Event

#[repr(C)]
pub struct Event(_);

cl_event

Methods

impl Event

fn null() -> Event

For passage directly to an 'event creation' function (such as enqueue...).

fn user<C: ClContextPtr>(context: C) -> OclResult<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).

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.

unsafe fn from_raw_copied_ptr(ptr: cl_event) -> OclResult<Event>

Only use when cloning or copying from a pre-existing and valid cl_event.

fn set_complete(&self) -> OclResult<()>

Sets this user created event to CommandExecutionStatus::Complete.

Will return an error if this event is not a 'user' event (created with ::user()).

fn is_complete(&self) -> OclResult<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.

fn wait_for(&self) -> OclResult<()>

Causes the command queue to wait until this event is complete before returning.

fn is_null(&self) -> bool

Returns whether or not this event is associated with a command or is a user event.

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.

unsafe fn set_callback(
    &self,
    callback_receiver: EventCallbackFn,
    user_data_ptr: *mut c_void
) -> OclResult<()>

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.

fn context(&self) -> OclResult<Context>

Returns the Context associated with this event.

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.

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.

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.

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.

Trait Implementations

impl Debug for Event

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'a> ClNullEventPtr for &'a mut Event

fn alloc_new(&mut self) -> *mut cl_event

unsafe fn clone_from<E: AsRef<Event>>(&mut self, ev: E)

impl ClWaitListPtr for Event

unsafe fn as_ptr_ptr(&self) -> *const cl_event

Returns a pointer to the first pointer in this list.

fn count(&self) -> u32

Returns the number of items in this wait list.

impl<'a> ClWaitListPtr for &'a Event

unsafe fn as_ptr_ptr(&self) -> *const cl_event

Returns a pointer to the first pointer in this list.

fn count(&self) -> u32

Returns the number of items in this wait list.

impl<'e> ClEventPtrRef<'e> for Event

unsafe fn as_ptr_ref(&'e self) -> &'e cl_event

impl AsRef<Event> for Event

fn as_ref(&self) -> &Event

Performs the conversion.

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Drop for Event

fn drop(&mut self)

A method called when the value goes out of scope.

impl Sync for Event

impl Send for Event