src/bindings/java/org/simgrid/msg/Comm.java

   1 /* Copyright (c) 2012-2019. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 package org.simgrid.msg;
   8
   9 /** Communication action, representing an ongoing communication between processes. */
  10 public class Comm {
  11         /** Indicates if the communication is a receiving communication */
  12         protected boolean receiving;
  13         /** Indicates if the communication is finished */
  14         protected boolean finished = false;
  15         /**
  16          * Represents the bind between the java comm and the
  17          * native C comm. You must never access it, since it is
  18          * automatically set.
  19          */
  20         private long bind = 0;
  21         /** Represents the bind for the task object pointer. Don't touch it. */
  22         private long taskBind = 0;
  23         /** Task associated with the comm. Beware, it can be null */
  24         protected Task task = null;
  25         /**
  26          * Protected constructor, used by Comm factories
  27          * in Task.
  28          */
  29         protected Comm() {
  30
  31         }
  32         /** Destroy the C communication object, when the GC reclaims the java part. */
  33         @Override
  34         protected void finalize() throws Throwable{
  35                 nativeFinalize();
  36         }
  37         protected native void nativeFinalize();
  38         /**
  39          * Returns if the communication is finished or not.
  40          * If the communication has finished and there was an error,
  41          * raise an exception.
  42          */
  43         public native boolean test() throws TransferFailureException, HostFailureException, TimeoutException ;
  44         /** Wait infinitely for the completion of the communication (infinite timeout) */
  45         public void waitCompletion() throws TransferFailureException, HostFailureException, TimeoutException {
  46                 waitCompletion(-1);
  47         }
  48         /**
  49          * Wait for the completion of the communication.
  50          * Throws an exception if there were an error in the communication.
  51          * @param timeout Time before giving up (infinite time if negative)
  52          */
  53         public native void waitCompletion(double timeout) throws TransferFailureException, HostFailureException, TimeoutException;
  54
  55         /** Wait all of the communications */
  56         public static native void waitAll(Comm[] comms, double timeout) throws TransferFailureException, HostFailureException, TimeoutException;
  57         /** Wait all of the communications, with no maximal delay */
  58         public static void waitAll(Comm[] comms) throws TransferFailureException, HostFailureException, TimeoutException {
  59                 waitAll(comms, -1.);
  60         }
  61         /** Wait any of the communications, and return the rank of the terminating comm */
  62         public static native int waitAny(Comm[] comms) throws TransferFailureException, HostFailureException, TimeoutException;
  63         /**
  64          * Returns the task associated with the communication.
  65          * if the communication isn't finished yet, will return null.
  66          */
  67         public Task getTask() {
  68                 return task;
  69         }
  70
  71         /** Class initializer, to initialize various JNI stuff */
  72         public static native void nativeInit();
  73         static {
  74                 org.simgrid.NativeLib.nativeInit();
  75                 nativeInit();
  76         }
  77 }