1 // Copyright (c) 2021 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=ed698ff6cb09ee2ed87614e2733c742db827ed4f$ 37 // 38 39 #ifndef CEF_INCLUDE_CAPI_CEF_WAITABLE_EVENT_CAPI_H_ 40 #define CEF_INCLUDE_CAPI_CEF_WAITABLE_EVENT_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 // WaitableEvent is a thread synchronization tool that allows one thread to wait 51 // for another thread to finish some work. This is equivalent to using a 52 // Lock+ConditionVariable to protect a simple boolean value. However, using 53 // WaitableEvent in conjunction with a Lock to wait for a more complex state 54 // change (e.g., for an item to be added to a queue) is not recommended. In that 55 // case consider using a ConditionVariable instead of a WaitableEvent. It is 56 // safe to create and/or signal a WaitableEvent from any thread. Blocking on a 57 // WaitableEvent by calling the *wait() functions is not allowed on the browser 58 // process UI or IO threads. 59 /// 60 typedef struct _cef_waitable_event_t { 61 /// 62 // Base structure. 63 /// 64 cef_base_ref_counted_t base; 65 66 /// 67 // Put the event in the un-signaled state. 68 /// 69 void(CEF_CALLBACK* reset)(struct _cef_waitable_event_t* self); 70 71 /// 72 // Put the event in the signaled state. This causes any thread blocked on Wait 73 // to be woken up. 74 /// 75 void(CEF_CALLBACK* signal)(struct _cef_waitable_event_t* self); 76 77 /// 78 // Returns true (1) if the event is in the signaled state, else false (0). If 79 // the event was created with |automatic_reset| set to true (1) then calling 80 // this function will also cause a reset. 81 /// 82 int(CEF_CALLBACK* is_signaled)(struct _cef_waitable_event_t* self); 83 84 /// 85 // Wait indefinitely for the event to be signaled. This function will not 86 // return until after the call to signal() has completed. This function cannot 87 // be called on the browser process UI or IO threads. 88 /// 89 void(CEF_CALLBACK* wait)(struct _cef_waitable_event_t* self); 90 91 /// 92 // Wait up to |max_ms| milliseconds for the event to be signaled. Returns true 93 // (1) if the event was signaled. A return value of false (0) does not 94 // necessarily mean that |max_ms| was exceeded. This function will not return 95 // until after the call to signal() has completed. This function cannot be 96 // called on the browser process UI or IO threads. 97 /// 98 int(CEF_CALLBACK* timed_wait)(struct _cef_waitable_event_t* self, 99 int64 max_ms); 100 } cef_waitable_event_t; 101 102 /// 103 // Create a new waitable event. If |automatic_reset| is true (1) then the event 104 // state is automatically reset to un-signaled after a single waiting thread has 105 // been released; otherwise, the state remains signaled until reset() is called 106 // manually. If |initially_signaled| is true (1) then the event will start in 107 // the signaled state. 108 /// 109 CEF_EXPORT cef_waitable_event_t* cef_waitable_event_create( 110 int automatic_reset, 111 int initially_signaled); 112 113 #ifdef __cplusplus 114 } 115 #endif 116 117 #endif // CEF_INCLUDE_CAPI_CEF_WAITABLE_EVENT_CAPI_H_ 118