src/jmsg_task.h

   1 /* Functions related to the java task instances.                            */
   2
   3 /* Copyright (c) 2007-2012. 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, msg_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 msg_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 /*
 112  * Class                org_simgrid_msg_Task
 113  * Method               cancel
 114  * Signature    ()V
 115  */
 116 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_cancel
 117     (JNIEnv *, jobject);
 118
 119 /*
 120  * Class                org_simgrid_msg_Task
 121  * Method               execute
 122  * Signature    ()V
 123  */
 124 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_execute
 125     (JNIEnv *, jobject);
 126
 127 /*
 128  * Class                org_simgrid_msg_Task
 129  * Method               getName
 130  * Signature    ()Ljava/lang/String;
 131  */
 132 JNIEXPORT jstring JNICALL Java_org_simgrid_msg_Task_getName
 133     (JNIEnv *, jobject);
 134
 135 /*
 136  * Class                org_simgrid_msg_Task
 137  * Method               getSender
 138  * Signature    ()Lsimgrid/msg/Process;
 139  */
 140 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_getSender
 141     (JNIEnv *, jobject);
 142 /*
 143  * Class                org_simgrid_msg_Task
 144  * Method               getSource
 145  * Signature    ()Lsimgrid/msg/Host;
 146  */
 147 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Task_getSource
 148     (JNIEnv *, jobject);
 149 /*
 150  * Class                org_simgrid_msg_Task
 151  * Method               getComputeDuration
 152  * Signature    ()D
 153  */
 154 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Task_getComputeDuration
 155     (JNIEnv *, jobject);
 156
 157 /*
 158  * Class                org_simgrid_msg_Task
 159  * Method               getRemainingDuration
 160  * Signature    ()D
 161  */
 162 JNIEXPORT jdouble JNICALL
 163 Java_org_simgrid_msg_Task_getRemainingDuration(JNIEnv *, jobject);
 164 /**
 165  * Class                org_simgrid_msg_Task
 166  * Method               setName
 167  * Signature    (Ljava/lang/string;)V
 168  */
 169 JNIEXPORT void JNICALL
 170 Java_org_simgrid_msg_Task_setName(JNIEnv *env, jobject jtask, jobject jname);
 171 /*
 172  * Class                org_simgrid_msg_Task
 173  * Method               setPriority
 174  * Signature    (D)V
 175  */
 176 JNIEXPORT void JNICALL Java_org_simgrid_msg_Task_setPriority
 177     (JNIEnv *, jobject, jdouble);
 178 /**
 179  * Class                org_simgrid_msg_Task
 180  * Method               setComputationAmount
 181  * Signature    (D)V
 182  */
 183 JNIEXPORT void JNICALL
 184 Java_org_simgrid_msg_Task_setComputeDuration
 185                 (JNIEnv *env, jobject jtask, jdouble computationAmount);
 186 /**
 187  * Class                org_simgrid_msg_Task
 188  * Method               send
 189  */
 190 JNIEXPORT void JNICALL
 191     Java_org_simgrid_msg_Task_send
 192     (JNIEnv *, jobject, jstring, jdouble);
 193
 194 /**
 195  * Class                org_simgrid_msg_Task
 196  * Method               sendBounded
 197  */
 198 JNIEXPORT void JNICALL
 199     Java_org_simgrid_msg_Task_sendBounded
 200     (JNIEnv *, jobject, jstring, jdouble, jdouble);
 201
 202
 203 /**
 204  * Class                org_simgrid_msg_Task
 205  * Method               receive
 206  */
 207 JNIEXPORT jobject JNICALL
 208     Java_org_simgrid_msg_Task_receive
 209     (JNIEnv *, jclass, jstring, jdouble, jobject);
 210
 211 /**
 212  * Class                org_simgrid_msg_Task
 213  * Method               irecv
 214  * Signature    (Ljava/lang/String;)Lorg/simgrid/msg/Comm;
 215  */
 216 JNIEXPORT jobject JNICALL
 217 Java_org_simgrid_msg_Task_irecv(JNIEnv * env, jclass cls, jstring jmailbox);
 218 /**
 219  * Class                org_simgrid_msg_Task
 220  * Method               isend
 221  * Signature    (Lorg/simgrid/msg/Task;Ljava/lang/String;)Lorg/simgrid/msg/Comm;
 222  */
 223 JNIEXPORT jobject JNICALL
 224 Java_org_simgrid_msg_Task_isend(JNIEnv *env, jobject jtask, jstring jmailbox);
 225 /**
 226  * Class                org_simgrid_msg_Task
 227  * Method               isend
 228  * Signature    (Lorg/simgrid/msg/Task;Ljava/lang/String;)Lorg/simgrid/msg/Comm;
 229  */
 230 JNIEXPORT jobject JNICALL
 231 Java_org_simgrid_msg_Task_isendBounded(JNIEnv *env, jobject jtask, jstring jmailbox, jdouble maxrate);
 232
 233 /**
 234  * Class                org_simgrid_msg_Task
 235  * Method               dsend
 236  */
 237 JNIEXPORT void JNICALL
 238 Java_org_simgrid_msg_Task_dsend(JNIEnv * env, jobject jtask,
 239                                 jstring jalias);
 240
 241 /**
 242  * Class                org_simgrid_msg_Task
 243  * Method               dsendBounded
 244  */
 245 JNIEXPORT void JNICALL
 246 Java_org_simgrid_msg_Task_dsendBounded(JNIEnv * env, jobject jtask,
 247                                 jstring jalias, jdouble maxrate);
 248
 249 /**
 250  * Class                org_simgrid_msg_Task
 251  * Method               listen
 252  */
 253 JNIEXPORT jboolean JNICALL
 254 Java_org_simgrid_msg_Task_listen(JNIEnv *, jclass, jstring);
 255 /**
 256  * Class                org_simgrid_msg_Task
 257  * Method               listenFromHost
 258  */
 259 JNIEXPORT jint JNICALL
 260 Java_org_simgrid_msg_Task_listenFromHost(JNIEnv *, jclass, jstring,
 261                                               jobject);
 262 /**
 263  * Class                org_simgrid_msg_Task
 264  * Method               listenFrom
 265  */
 266 JNIEXPORT jint JNICALL
 267 Java_org_simgrid_msg_Task_listenFrom(JNIEnv *, jclass, jstring);
 268
 269
 270
 271 #endif                          /* !MSG_JTASK_H */