001/* 002 * BridJ - Dynamic and blazing-fast native interop for Java. 003 * http://bridj.googlecode.com/ 004 * 005 * Copyright (c) 2010-2013, Olivier Chafik (http://ochafik.com/) 006 * All rights reserved. 007 * 008 * Redistribution and use in source and binary forms, with or without 009 * modification, are permitted provided that the following conditions are met: 010 * 011 * * Redistributions of source code must retain the above copyright 012 * notice, this list of conditions and the following disclaimer. 013 * * Redistributions in binary form must reproduce the above copyright 014 * notice, this list of conditions and the following disclaimer in the 015 * documentation and/or other materials provided with the distribution. 016 * * Neither the name of Olivier Chafik nor the 017 * names of its contributors may be used to endorse or promote products 018 * derived from this software without specific prior written permission. 019 * 020 * THIS SOFTWARE IS PROVIDED BY OLIVIER CHAFIK AND CONTRIBUTORS ``AS IS'' AND ANY 021 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 022 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 023 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY 024 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 025 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 026 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 027 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 028 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 029 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 030 */ 031/* 032 * To change this template, choose Tools | Templates 033 * and open the template in the editor. 034 */ 035package org.bridj; 036 037import org.bridj.Pointer; 038import org.bridj.ann.Runtime; 039 040/** 041 * Native C callback (beware : don't let your callbacks be GC'd before they're 042 * used).<br> 043 * To protect a callback against the GC, you can keep a reference to your 044 * callback or use {@link BridJ#protectFromGC(org.bridj.NativeObject) } / {@link BridJ#unprotectFromGC(org.bridj.NativeObject) 045 * }.<br> 046 * A callback is a Java object with only one abstract method exposed as a C 047 * function pointer to the native world.<br> 048 * Here's an example of callback definition (use JNAerator to generate them 049 * automatically) : 050 * <pre>{@code 051 * // typedef int (*MyCallback)(int a, int b); 052 * public static abstract class MyCallback extends Callback { 053 * public abstract int doSomething(int a, int b); 054 * } 055 * }</pre> 056 * 057 * @author Olivier Chafik 058 */ 059@Runtime(CRuntime.class) 060public abstract class Callback<C extends Callback<C>> extends NativeObject implements CallbackInterface { 061 062 public Pointer<C> toPointer() { 063 return (Pointer) Pointer.getPointer(this); 064 } 065}