comparison graal/com.oracle.nfi/src/com/oracle/nfi/api/NativeFunctionHandle.java @ 16691:dd8449afc086

GNFI: move GNFI interfaces to oracle.nfi - interface does not depend on graal
author Matthias Grimmer <grimmer@ssw.jku.at>
date Tue, 05 Aug 2014 15:58:11 +0200
parents
children
comparison
equal deleted inserted replaced
16690:7e8ecfe7d2e5 16691:dd8449afc086
1 /*
2 * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23 package com.oracle.nfi.api;
24
25 /**
26 * A handle that can be used to {@linkplain #call(Object[]) call} a native function.
27 */
28 public interface NativeFunctionHandle {
29
30 /**
31 * Calls the native function.
32 * <p>
33 * The caller is responsible for ensuring {@code args} comply with the platform ABI (e.g. <a
34 * href="http://www.uclibc.org/docs/psABI-x86_64.pdf"> Unix AMD64 ABI</a>). If the library
35 * function has struct parameters, the fields of the struct must be passed as individual
36 * arguments.
37 *
38 * @param args the arguments that will be passed to the native function
39 * @return boxed return value of the function call
40 */
41 Object call(Object... args);
42
43 }