src/jmsg_task.h

   1 /* Functions related to the java task instances.                            */
   2
   3 /* Copyright (c) 2007, 2009, 2010. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7   * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #ifndef MSG_JTASK_H
  10 #define MSG_JTASK_H
  11
  12 #include <jni.h>
  13 #include "msg/msg.h"
  14
  15 /**
  16  * This function returns a global reference to the  java task instance
  17  * specified by the parameter jtask.
  18  *
  19  * @param jtask                 The original java task instance.
  20  * @param env                   The environment of the current thread.
  21  *
  22  * @return                              The global reference to the original java task
  23  *                                              instance.
  24  */
  25 jobject jtask_new_global_ref(jobject jtask, JNIEnv * env);
  26
  27 /**
  28  * This function delete a global reference to a java task instance.
  29  *
  30  * @param                               The global refernce to delete.
  31  * @param env                   The environment of the current thread.
  32  */
  33 void jtask_delete_global_ref(jobject jtask, JNIEnv * env);
  34
  35 /**
  36  * This function associated a native task to a java task instance.
  37  *
  38  * @param jtask                 The java task instance.
  39  * @param task                  The native task to bind.
  40  * @param env                   The environment of the current thread.
  41  *
  42  * @exception                   If the class Task is not found the function throws
  43  *                                              the ClassNotFoundException. If the field bind of
  44  *                                              this class is not found the function throws the exception
  45  *                                              NotSuchFieldException.
  46  */
  47 void jtask_bind(jobject jtask, m_task_t task, JNIEnv * env);
  48
  49 /**
  50  * This function returns a native task from a java task instance.
  51  *
  52  * @param jtask                 The java task object from which get the native task.
  53  * @param env                   The environment of the current thread.
  54  *
  55  * @return                              The function returns the native task associated to the
  56  *                                              java task object.
  57  *
  58  * @exception                   If the class Task is not found the function throws
  59  *                                              the ClassNotFoundException. If the field bind of
  60  *                                              this class is not found the function throws the exception
  61  *                                              NotSuchFieldException.
  62  */
  63 m_task_t jtask_to_native_task(jobject jtask, JNIEnv * env);
  64
  65 /**
  66  * This function tests if a java task instance is valid.
  67  * A java task object is valid if it is bind to a native
  68  * task.
  69  *
  70  * @param jtask                 The java task to test the validity.
  71  * @param env                   The environment of the current thread.
  72  *
  73  * @return                              If the java task is valid the function returns true.
  74  *                                              Otherwise the function returns false.
  75  */
  76 jboolean jtask_is_valid(jobject jtask, JNIEnv * env);
  77
  78 /*
  79  * Class                org_simgrid_msg_Task
  80  * Method               nativeInit
  81  * Signature    ();
  82  */
  83 JNIEXPORT void JNICALL
  84 Java_org_simgrid_msg_Task_nativeInit(JNIEnv *env, jclass cls);
  85
  86 /*
  87  * Class                org_simgrid_msg_Task
  88  * Method               create
  89  */
  90 JNIEXPORT void JNICALL
  91 Java_org_simgrid_msg_Task_create
  92                 (JNIEnv * env, jobject jtask, jstring jname, jdouble jcomputeDuration, jdouble jmessageSize);
  93 /*
  94  * Class                org_simgrid_msg_Task
  95  * Method               parallelCreate
  96  */
  97 JNIEXPORT void JNICALL
  98 Java_org_simgrid_msg_Task_parallelCreate
  99                 (JNIEnv *, jobject,
 100      jstring, jobjectArray,
 101      jdoubleArray,
 102      jdoubleArray);
 103 /*
 104  * Class                org_simgrid_msg_Task
 105  * Method               destroy
 106  * Signature    (Lsimgrid/msg/Task;)V
 107  */
 108 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_destroy
 109     (JNIEnv *, jobject);
 110 /*
 111  * Class                org_simgrid_msg_Task
 112  * Method               getName
 113  * Signature    ()Ljava/lang/String;
 114  */
 115 JNIEXPORT jstring JNICALL Java_org_simgrid_msg_Task_getName
 116     (JNIEnv *, jobject);
 117
 118 /*
 119  * Class                org_simgrid_msg_Task
 120  * Method               getSender
 121  * Signature    ()Lsimgrid/msg/Process;
 122  */
 123 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_getSender
 124     (JNIEnv *, jobject);
 125
 126 /**
 127  * Class                org_simgrid_msg_Task
 128  * Method               irecv
 129  * Signature    (Ljava/lang/String;)Lorg/simgrid/msg/Comm;
 130  */
 131 JNIEXPORT jobject JNICALL
 132 Java_org_simgrid_msg_Task_irecv(JNIEnv * env, jclass cls, jstring jmailbox);
 133 /**
 134  * Class                org_simgrid_msg_Task
 135  * Method               isend
 136  * Signature    (Lorg/simgrid/msg/Task;Ljava/lang/String;)Lorg/simgrid/msg/Comm;
 137  */
 138 JNIEXPORT jobject JNICALL
 139 Java_org_simgrid_msg_Task_isend(JNIEnv *env, jobject jtask, jstring jmailbox);
 140 /**
 141  * Class                org_simgrid_msg_Task
 142  * Method               dsend
 143  */
 144 JNIEXPORT void JNICALL
 145 Java_org_simgrid_msg_Task_dsend(JNIEnv * env, jobject jtask,
 146                                 jstring jalias);
 147 /**
 148  * Class                org_simgrid_msg_Task
 149  * Method               listen
 150  */
 151 JNIEXPORT jboolean JNICALL
 152 Java_org_simgrid_msg_Task_listen(JNIEnv *, jclass, jstring);
 153 /**
 154  * Class                org_simgrid_msg_Task
 155  * Method               listenFromHost
 156  */
 157 JNIEXPORT jint JNICALL
 158 Java_org_simgrid_msg_Task_listenFromHost(JNIEnv *, jclass, jstring,
 159                                               jobject);
 160 /**
 161  * Class                org_simgrid_msg_Task
 162  * Method               listenFrom
 163  */
 164 JNIEXPORT jint JNICALL
 165 Java_org_simgrid_msg_Task_listenFrom(JNIEnv *, jclass, jstring);
 166
 167
 168
 169 #endif                          /* !MSG_JTASK_H */