native_handle.h revision 8f13782e7b4a705484d7f97f07513781b82be0dc 
1/*
2 * Copyright (C) 2009 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef NATIVE_HANDLE_H_
18#define NATIVE_HANDLE_H_
19
20#include <sys/cdefs.h>
21
22__BEGIN_DECLS
23
24typedef struct
25{
26    int version;        /* sizeof(native_handle_t) */
27    int numFds;         /* number of file-descriptors at &data[0] */
28    int numInts;        /* number of ints at &data[numFds] */
29    int data[0];        /* numFds + numInts ints */
30} native_handle_t;
31
32
33/* keep the old definition for backward source-compatibility */
34typedef native_handle_t native_handle;
35
36/*
37 * native_handle_close
38 *
39 * closes the file descriptors contained in this native_handle_t
40 *
41 * return 0 on success, or a negative error code on failure
42 *
43 */
44int native_handle_close(const native_handle_t* h);
45
46
47/*
48 * native_handle_create
49 *
50 * creates a native_handle_t and initializes it. must be destroyed with
51 * native_handle_delete().
52 *
53 */
54native_handle_t* native_handle_create(int numFds, int numInts);
55
56/*
57 * native_handle_delete
58 *
59 * frees a native_handle_t allocated with native_handle_create().
60 * This ONLY frees the memory allocated for the native_handle_t, but doesn't
61 * close the file descriptors; which can be achieved with native_handle_close().
62 *
63 * return 0 on success, or a negative error code on failure
64 *
65 */
66int native_handle_delete(native_handle_t* h);
67
68
69__END_DECLS
70
71#endif /* NATIVE_HANDLE_H_ */
72