'\" t
.\"     Title: clSetEventCallback
.\"    Author: The Khronos Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/14/2021
.\"    Manual: OpenCL Manual
.\"    Source: The Khronos Group
.\"  Language: English
.\"
.TH "CLSETEVENTCALLBACK" "3clc" "01/14/2021" "The Khronos Group" "OpenCL Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
clSetEventCallback \- Registers a user callback function for a specific command execution status\&.
.SH ""
.HP \w'cl_int\ clSetEventCallback('u
.BI "cl_int clSetEventCallback(cl_event\ " "event" ", cl_int\ " "command_exec_callback_type" ", void\ (CL_CALLBACK\ *" "pfn_event_notify)\ (cl_event\ event,\ cl_int\ event_command_exec_status,\ void\ *user_data" "), void\ *" "user_data" ");"
.SH "PARAMETERS"
.PP
\fIevent\fR
.RS 4
A valid event object\&.
.RE
.PP
\fIcommand_exec_callback_type\fR
.RS 4
The command execution status for which the callback is registered\&. The command execution callback value for which a callback can be registered is
\fBCL_SUBMITTED\fR,
\fBCL_RUNNING\fR, or
\fBCL_COMPLETE\fR\&. There is no guarantee that the callback functions registered for various execution status values for an event will be called in the exact order that the execution status of a command changes\&. Furthermore, it should be noted that receiving a call back for an event with a status other than
\fBCL_COMPLETE\fR, in no way implies that the memory model or execution model as defined by the OpenCL specification has changed\&. For example, it is not valid to assume that a corresponding memory transfer has completed unless the event is in a state
\fBCL_COMPLETE\fR\&.
.sp
The callback function registered for a
\fIcommand_exec_callback_type\fR
value of
\fBCL_COMPLETE\fR
will be called when the command has completed successfully or is abnormally terminated\&.
.RE
.PP
\fIpfn_event_notify\fR
.RS 4
The event callback function that can be registered by the application\&. This callback function may be called asynchronously by the OpenCL implementation\&. It is the application\*(Aqs responsibility to ensure that the callback function is thread\-safe\&. The parameters to this callback function are:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIevent\fR is the event object for which the callback function is invoked\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIevent_command_exec_status\fR represents the
execution status of command for which this callback function is
invoked\&. See the table of values for \fIparam_value\fR for
\fBclGetEventInfo\fR(3clc)
for the command execution status values\&. If the callback is called as the
result of the command associated with event being abnormally terminated,
an appropriate error code for the error that caused the termination
will be passed to \fIevent_command_exec_status\fR instead\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIuser_data\fR is a pointer to user supplied data\&.
.RE
.RE
.PP
\fIuser_data\fR
.RS 4
Will be passed as the
\fIuser_data\fR
argument when
\fIpfn_notify\fR
is called\&.
\fIuser_data\fR
can be NULL\&.
.RE
.SH "NOTES"
.PP
The registered callback function will be called when the execution status of command associated with
\fIevent\fR
changes to an execution status equal to or past the status specified by
\fIcommand_exec_status\fR\&.
.PP
Each call to
\fBclSetEventCallback\fR
registers the specified user callback function on a callback stack associated with
\fIevent\fR\&. The order in which the registered user callback functions are called is undefined\&.
.PP
All callbacks registered for an event object must be called\&. All enqueued callbacks shall be called before the event object is destroyed\&. Callbacks must return promptly\&. The behavior of calling expensive system routines, OpenCL API calls to create contexts or command\-queues, or blocking OpenCL operations from the following list below, in a callback is undefined\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBclFinish\fR(3clc).RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBclWaitForEvents\fR(3clc).RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

blocking calls to
\fBclEnqueueReadBuffer\fR(3clc),
\fBclEnqueueReadBufferRect\fR(3clc),
\fBclEnqueueWriteBuffer\fR(3clc), and
\fBclEnqueueWriteBufferRect\fR(3clc).RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

blocking calls to
\fBclEnqueueReadImage\fR(3clc)
and \fBclEnqueueWriteImage\fR(3clc).RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

blocking calls to
\fBclEnqueueMapBuffer\fR(3clc)
and \fBclEnqueueMapImage\fR(3clc).RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

blocking calls to
\fBclBuildProgram\fR(3clc),
\fBclCompileProgram\fR(3clc),
or \fBclLinkProgram\fR(3clc)\&.
.RE
.PP
If an application needs to wait for completion of a routine from the above list in a callback, please use the non\-blocking form of the function, and assign a completion callback to it to do the remainder of your work\&. Note that when a callback (or other code) enqueues commands to a command\-queue, the commands are not required to begin execution until the queue is flushed\&. In standard usage, blocking enqueue calls serve this role by implicitly flushing the queue\&. Since blocking calls are not permitted in callbacks, those callbacks that enqueue commands on a command queue should either call
\fBclFlush\fR(3clc)
on the queue before returning or arrange for
\fBclFlush\fR(3clc)
to be called later on another thread\&.
.SH "ERRORS"
.PP
Returns
CL_SUCCESS
if the function is executed successfully\&. Otherwise, it returns one of the following errors:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_EVENT if \fIevent\fR is not a valid event object\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_VALUE if \fIpfn_event_notify\fR is NULL or if
\fIcommand_exec_callback_type\fR is not \fBCL_COMPLETE\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_OUT_OF_RESOURCES if there is a failure to allocate resources required
by the OpenCL implementation on the device\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_OUT_OF_HOST_MEMORY if there is a failure to allocate resources
required by the OpenCL implementation on the host\&.
.RE
.SH "SPECIFICATION"
.PP
\m[blue]\fBOpenCL Specification\fR\m[]\&\s-2\u[1]\d\s+2
.SH "AUTHORS"
.PP
\fBThe Khronos Group\fR
.SH "COPYRIGHT"
.br
Copyright \(co 2007-2011 The Khronos Group Inc.
.br
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and/or associated documentation files (the "Materials"), to deal in the Materials without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Materials, and to permit persons to whom the Materials are furnished to do so, subject to the condition that this copyright notice and permission notice shall be included in all copies or substantial portions of the Materials.
.sp
.SH "NOTES"
.IP " 1." 4
OpenCL Specification
.RS 4
\%page 183, section 5.9 - Event Objects
.RE