libutils/include/utils/NativeHandle.h

/*
 * Copyright 2014 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef ANDROID_NATIVE_HANDLE_H
#define ANDROID_NATIVE_HANDLE_H

#include <utils/RefBase.h>
#include <utils/StrongPointer.h>

typedef struct native_handle native_handle_t;

namespace android {

class NativeHandle : public LightRefBase<NativeHandle> {
public:
    // Create a refcounted wrapper around a native_handle_t, and declare
    // whether the wrapper owns the handle (so that it should clean up the
    // handle upon destruction) or not.
    // If handle is NULL, no NativeHandle will be created.
    static sp<NativeHandle> create(native_handle_t* handle, bool ownsHandle);

    const native_handle_t* handle() const {
        return mHandle;
    }

private:
    // for access to the destructor
    friend class LightRefBase<NativeHandle>;
    // for access to the constructor
    friend class sp<NativeHandle>;

    NativeHandle(native_handle_t* handle, bool ownsHandle);
    ~NativeHandle();

    native_handle_t* mHandle;
    bool mOwnsHandle;

    // non-copyable
    NativeHandle(const NativeHandle&);
    NativeHandle& operator=(const NativeHandle&);
};

} // namespace android

#endif // ANDROID_NATIVE_HANDLE_H