1 // Copyright (c) 2022 Marshall A. Greenblatt. All rights reserved. 2 // 3 // Redistribution and use in source and binary forms, with or without 4 // modification, are permitted provided that the following conditions are 5 // met: 6 // 7 // * Redistributions of source code must retain the above copyright 8 // notice, this list of conditions and the following disclaimer. 9 // * Redistributions in binary form must reproduce the above 10 // copyright notice, this list of conditions and the following disclaimer 11 // in the documentation and/or other materials provided with the 12 // distribution. 13 // * Neither the name of Google Inc. nor the name Chromium Embedded 14 // Framework nor the names of its contributors may be used to endorse 15 // or promote products derived from this software without specific prior 16 // written permission. 17 // 18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 // 30 // --------------------------------------------------------------------------- 31 // 32 // This file was generated by the CEF translator tool and should not edited 33 // by hand. See the translator.README.txt file in the tools directory for 34 // more information. 35 // 36 // $hash=e943dd2af818e5a5f19f6cbd1648896684c666c6$ 37 // 38 39 #ifndef CEF_INCLUDE_CAPI_CEF_TASK_CAPI_H_ 40 #define CEF_INCLUDE_CAPI_CEF_TASK_CAPI_H_ 41 #pragma once 42 43 #include "include/capi/cef_base_capi.h" 44 45 #ifdef __cplusplus 46 extern "C" { 47 #endif 48 49 /// 50 // Implement this structure for asynchronous task execution. If the task is 51 // posted successfully and if the associated message loop is still running then 52 // the execute() function will be called on the target thread. If the task fails 53 // to post then the task object may be destroyed on the source thread instead of 54 // the target thread. For this reason be cautious when performing work in the 55 // task object destructor. 56 /// 57 typedef struct _cef_task_t { 58 /// 59 // Base structure. 60 /// 61 cef_base_ref_counted_t base; 62 63 /// 64 // Method that will be executed on the target thread. 65 /// 66 void(CEF_CALLBACK* execute)(struct _cef_task_t* self); 67 } cef_task_t; 68 69 /// 70 // Structure that asynchronously executes tasks on the associated thread. It is 71 // safe to call the functions of this structure on any thread. 72 // 73 // CEF maintains multiple internal threads that are used for handling different 74 // types of tasks in different processes. The cef_thread_id_t definitions in 75 // cef_types.h list the common CEF threads. Task runners are also available for 76 // other CEF threads as appropriate (for example, V8 WebWorker threads). 77 /// 78 typedef struct _cef_task_runner_t { 79 /// 80 // Base structure. 81 /// 82 cef_base_ref_counted_t base; 83 84 /// 85 // Returns true (1) if this object is pointing to the same task runner as 86 // |that| object. 87 /// 88 int(CEF_CALLBACK* is_same)(struct _cef_task_runner_t* self, 89 struct _cef_task_runner_t* that); 90 91 /// 92 // Returns true (1) if this task runner belongs to the current thread. 93 /// 94 int(CEF_CALLBACK* belongs_to_current_thread)(struct _cef_task_runner_t* self); 95 96 /// 97 // Returns true (1) if this task runner is for the specified CEF thread. 98 /// 99 int(CEF_CALLBACK* belongs_to_thread)(struct _cef_task_runner_t* self, 100 cef_thread_id_t threadId); 101 102 /// 103 // Post a task for execution on the thread associated with this task runner. 104 // Execution will occur asynchronously. 105 /// 106 int(CEF_CALLBACK* post_task)(struct _cef_task_runner_t* self, 107 struct _cef_task_t* task); 108 109 /// 110 // Post a task for delayed execution on the thread associated with this task 111 // runner. Execution will occur asynchronously. Delayed tasks are not 112 // supported on V8 WebWorker threads and will be executed without the 113 // specified delay. 114 /// 115 int(CEF_CALLBACK* post_delayed_task)(struct _cef_task_runner_t* self, 116 struct _cef_task_t* task, 117 int64 delay_ms); 118 } cef_task_runner_t; 119 120 /// 121 // Returns the task runner for the current thread. Only CEF threads will have 122 // task runners. An NULL reference will be returned if this function is called 123 // on an invalid thread. 124 /// 125 CEF_EXPORT cef_task_runner_t* cef_task_runner_get_for_current_thread(); 126 127 /// 128 // Returns the task runner for the specified CEF thread. 129 /// 130 CEF_EXPORT cef_task_runner_t* cef_task_runner_get_for_thread( 131 cef_thread_id_t threadId); 132 133 /// 134 // Returns true (1) if called on the specified thread. Equivalent to using 135 // cef_task_runner_t::GetForThread(threadId)->belongs_to_current_thread(). 136 /// 137 CEF_EXPORT int cef_currently_on(cef_thread_id_t threadId); 138 139 /// 140 // Post a task for execution on the specified thread. Equivalent to using 141 // cef_task_runner_t::GetForThread(threadId)->PostTask(task). 142 /// 143 CEF_EXPORT int cef_post_task(cef_thread_id_t threadId, cef_task_t* task); 144 145 /// 146 // Post a task for delayed execution on the specified thread. Equivalent to 147 // using cef_task_runner_t::GetForThread(threadId)->PostDelayedTask(task, 148 // delay_ms). 149 /// 150 CEF_EXPORT int cef_post_delayed_task(cef_thread_id_t threadId, 151 cef_task_t* task, 152 int64 delay_ms); 153 154 #ifdef __cplusplus 155 } 156 #endif 157 158 #endif // CEF_INCLUDE_CAPI_CEF_TASK_CAPI_H_ 159