docs/source/java/org/simgrid/msg/Comm.rst

   1 class org.simgrid.msg.Comm
   2 ==========================
   3
   4 .. java:package:: org.simgrid.msg
   5    :noindex:
   6
   7 .. java:type:: public class Comm
   8
   9    Communication action, representing an ongoing communication between processes.
  10
  11 Fields
  12 ------
  13 finished
  14 ^^^^^^^^
  15
  16 .. java:field:: protected boolean finished
  17    :outertype: Comm
  18
  19    Indicates if the communication is finished
  20
  21 receiving
  22 ^^^^^^^^^
  23
  24 .. java:field:: protected boolean receiving
  25    :outertype: Comm
  26
  27    Indicates if the communication is a receiving communication
  28
  29 task
  30 ^^^^
  31
  32 .. java:field:: protected Task task
  33    :outertype: Comm
  34
  35    Task associated with the comm. Beware, it can be null
  36
  37 Constructors
  38 ------------
  39 Comm
  40 ^^^^
  41
  42 .. java:constructor:: protected Comm()
  43    :outertype: Comm
  44
  45    Protected constructor, used by Comm factories in Task.
  46
  47 Methods
  48 -------
  49 finalize
  50 ^^^^^^^^
  51
  52 .. java:method:: @Deprecated @Override protected void finalize() throws Throwable
  53    :outertype: Comm
  54
  55    Destroy the C communication object, when the GC reclaims the java part.
  56
  57 getTask
  58 ^^^^^^^
  59
  60 .. java:method:: public Task getTask()
  61    :outertype: Comm
  62
  63    Returns the task associated with the communication. if the communication isn't finished yet, will return null.
  64
  65 nativeFinalize
  66 ^^^^^^^^^^^^^^
  67
  68 .. java:method:: protected native void nativeFinalize()
  69    :outertype: Comm
  70
  71 nativeInit
  72 ^^^^^^^^^^
  73
  74 .. java:method:: public static native void nativeInit()
  75    :outertype: Comm
  76
  77    Class initializer, to initialize various JNI stuff
  78
  79 test
  80 ^^^^
  81
  82 .. java:method:: public native boolean test() throws TransferFailureException, HostFailureException, TimeoutException
  83    :outertype: Comm
  84
  85    Returns if the communication is finished or not. If the communication has finished and there was an error, raise an exception.
  86
  87 waitAll
  88 ^^^^^^^
  89
  90 .. java:method:: public static native void waitAll(Comm[] comms, double timeout) throws TransferFailureException, HostFailureException, TimeoutException
  91    :outertype: Comm
  92
  93    Wait all of the communications
  94
  95 waitAll
  96 ^^^^^^^
  97
  98 .. java:method:: public static void waitAll(Comm[] comms) throws TransferFailureException, HostFailureException, TimeoutException
  99    :outertype: Comm
 100
 101    Wait all of the communications, with no maximal delay
 102
 103 waitAny
 104 ^^^^^^^
 105
 106 .. java:method:: public static native int waitAny(Comm[] comms) throws TransferFailureException, HostFailureException, TimeoutException
 107    :outertype: Comm
 108
 109    Wait any of the communications, and return the rank of the terminating comm
 110
 111 waitCompletion
 112 ^^^^^^^^^^^^^^
 113
 114 .. java:method:: public void waitCompletion() throws TransferFailureException, HostFailureException, TimeoutException
 115    :outertype: Comm
 116
 117    Wait infinitely for the completion of the communication (infinite timeout)
 118
 119 waitCompletion
 120 ^^^^^^^^^^^^^^
 121
 122 .. java:method:: public native void waitCompletion(double timeout) throws TransferFailureException, HostFailureException, TimeoutException
 123    :outertype: Comm
 124
 125    Wait for the completion of the communication. Throws an exception if there were an error in the communication.
 126
 127    :param timeout: Time before giving up (infinite time if negative)
 128