xref: /aosp_15_r20/hardware/interfaces/automotive/can/1.0/default/CloseHandle.h (revision 4d7e907c777eeecc4c5bd7cf640a754fac206ff7)
1*4d7e907cSAndroid Build Coastguard Worker /*
2*4d7e907cSAndroid Build Coastguard Worker  * Copyright (C) 2019 The Android Open Source Project
3*4d7e907cSAndroid Build Coastguard Worker  *
4*4d7e907cSAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*4d7e907cSAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*4d7e907cSAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*4d7e907cSAndroid Build Coastguard Worker  *
8*4d7e907cSAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*4d7e907cSAndroid Build Coastguard Worker  *
10*4d7e907cSAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*4d7e907cSAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*4d7e907cSAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*4d7e907cSAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*4d7e907cSAndroid Build Coastguard Worker  * limitations under the License.
15*4d7e907cSAndroid Build Coastguard Worker  */
16*4d7e907cSAndroid Build Coastguard Worker 
17*4d7e907cSAndroid Build Coastguard Worker #pragma once
18*4d7e907cSAndroid Build Coastguard Worker 
19*4d7e907cSAndroid Build Coastguard Worker #include <android-base/macros.h>
20*4d7e907cSAndroid Build Coastguard Worker #include <android/hardware/automotive/can/1.0/ICloseHandle.h>
21*4d7e907cSAndroid Build Coastguard Worker 
22*4d7e907cSAndroid Build Coastguard Worker namespace android::hardware::automotive::can::V1_0::implementation {
23*4d7e907cSAndroid Build Coastguard Worker 
24*4d7e907cSAndroid Build Coastguard Worker /** Generic ICloseHandle implementation ignoring double-close events. */
25*4d7e907cSAndroid Build Coastguard Worker struct CloseHandle : public ICloseHandle {
26*4d7e907cSAndroid Build Coastguard Worker     using Callback = std::function<void()>;
27*4d7e907cSAndroid Build Coastguard Worker 
28*4d7e907cSAndroid Build Coastguard Worker     /**
29*4d7e907cSAndroid Build Coastguard Worker      * Create a handle with a callback.
30*4d7e907cSAndroid Build Coastguard Worker      *
31*4d7e907cSAndroid Build Coastguard Worker      * The callback is guaranteed to be called exactly once.
32*4d7e907cSAndroid Build Coastguard Worker      *
33*4d7e907cSAndroid Build Coastguard Worker      * \param callback Called on the first close() call, or on destruction of the handle
34*4d7e907cSAndroid Build Coastguard Worker      */
35*4d7e907cSAndroid Build Coastguard Worker     CloseHandle(Callback callback = nullptr);
36*4d7e907cSAndroid Build Coastguard Worker     virtual ~CloseHandle();
37*4d7e907cSAndroid Build Coastguard Worker 
38*4d7e907cSAndroid Build Coastguard Worker     Return<void> close() override;
39*4d7e907cSAndroid Build Coastguard Worker 
40*4d7e907cSAndroid Build Coastguard Worker   private:
41*4d7e907cSAndroid Build Coastguard Worker     const Callback mCallback;
42*4d7e907cSAndroid Build Coastguard Worker     std::atomic<bool> mIsClosed = false;
43*4d7e907cSAndroid Build Coastguard Worker 
44*4d7e907cSAndroid Build Coastguard Worker     DISALLOW_COPY_AND_ASSIGN(CloseHandle);
45*4d7e907cSAndroid Build Coastguard Worker };
46*4d7e907cSAndroid Build Coastguard Worker 
47*4d7e907cSAndroid Build Coastguard Worker }  // namespace android::hardware::automotive::can::V1_0::implementation
48