2 * simgrid.msg.Task.java 1.00 07/05/01
4 * Copyright 2006,2007 Martin Quinson, Malek Cherier
7 * This program is free software; you can redistribute
8 * it and/or modify it under the terms of the license
9 *(GNU LGPL) which comes with this package.
12 package org.simgrid.msg;
15 * A task is either something to compute somewhere, or something to exchange between two hosts (or both).
16 * It is defined by a computing amount and a message size.
21 * This attribute represents a bind between a java task object and
22 * a native task. Even if this attribute is public you must never
23 * access to it. It is set automatically during the build of the object.
28 /** Default constructor (all fields to 0 or null) */
30 MsgNative.taskCreate(this, null, 0, 0);
36 * Construct an new task with the specified processing amount and amount
39 * @param name Task's name
41 * @param computeDuration A value of the processing amount (in flop) needed to process the task.
42 * If 0, then it cannot be executed with the execute() method.
43 * This value has to be >= 0.
45 * @param messageSize A value of amount of data (in bytes) needed to transfert this task.
46 * If 0, then it cannot be transfered with the get() and put() methods.
47 * This value has to be >= 0.
49 public Task(String name, double computeDuration, double messageSize) {
50 MsgNative.taskCreate(this, name, computeDuration, messageSize);
53 * Construct an new parallel task with the specified processing amount and amount for each host
56 * @param name The name of the parallel task.
57 * @param hosts The list of hosts implied by the parallel task.
58 * @param computeDurations The amount of operations to be performed by each host of \a hosts.
59 * @param messageSizes A matrix describing the amount of data to exchange between hosts.
61 public Task(String name, Host[]hosts, double[]computeDurations, double[]messageSizes) {
62 MsgNative.parallelTaskCreate(this, name, hosts, computeDurations, messageSizes);
65 * * Getters / Setters * *
67 /** Gets the name of a task
70 public String getName() {
71 return MsgNative.taskGetName(this);
73 /** Gets the sender of the task */
75 return MsgNative.taskGetSender(this);
77 /** Gets the source of the task
80 public Host getSource() {
81 return MsgNative.taskGetSource(this);
83 /** Gets the computing amount of the task
86 public double getComputeDuration() {
87 return MsgNative.taskGetComputeDuration(this);
89 /** Gets the remaining computation of the task
92 public double getRemainingDuration() {
93 return MsgNative.taskGetRemainingDuration(this);
96 * This method sets the priority of the computation of the task.
97 * The priority doesn't affect the transfer rate. For example a
98 * priority of 2 will make the task receive two times more cpu than
101 * @param priority The new priority of the task.
103 public void setPriority(double priority) {
104 MsgNative.taskSetPriority(this, priority);
107 * * Communication-related * *
112 * * Computation-related * *
115 * Executes a task on the location on which the process is running.
118 * @throws HostFailureException
119 * @throws TaskCancelledException
121 public void execute() throws HostFailureException,TaskCancelledException {
122 MsgNative.taskExecute(this);
128 public void cancel() {
129 MsgNative.taskCancel(this);
133 * @exception NativeException if the destruction failed.
135 protected void finalize() throws NativeException {
137 MsgNative.taskDestroy(this);
141 /** Send the task asynchronously on the mailbox identified by the specified name,
142 * with no way to retrieve whether the communication succeeded or not
145 public void dsend(String mailbox) {
146 MsgNative.taskDSend(mailbox, this);
150 * Sends the task on the mailbox identified by the specified name
153 * @throws TimeoutException
154 * @throws HostFailureException
155 * @throws TransferFailureException
157 public void send(String mailbox) throws TransferFailureException, HostFailureException, TimeoutException {
158 MsgNative.taskSend(mailbox, this, -1);
162 * Sends the task on the mailbox identified by the specified name (wait at most \a timeout seconds)
166 * @exception NativeException if the retrieval fails.
167 * @throws TimeoutException
168 * @throws HostFailureException
169 * @throws TransferFailureException
171 public void send(String mailbox, double timeout) throws NativeException, TransferFailureException, HostFailureException, TimeoutException {
172 MsgNative.taskSend(mailbox, this, timeout);
176 * Sends the task on the mailbox identified by the specified alias (capping the sending rate to \a maxrate)
180 * @throws TransferFailureException
181 * @throws HostFailureException
182 * @throws TimeoutException
184 public void sendBounded(String alias, double maxrate) throws TransferFailureException, HostFailureException, TimeoutException {
185 MsgNative.taskSendBounded(alias, this, maxrate);
188 * Sends the task on the mailbox asynchronously
190 public native Comm isend(String mailbox);
193 * Starts listening for receiving a task from an asynchronous communication
197 public static native Comm irecv(String mailbox);
199 * Retrieves next task from the mailbox identified by the specified name
203 * @throws TransferFailureException
204 * @throws HostFailureException
205 * @throws TimeoutException
208 public static Task receive(String mailbox) throws TransferFailureException, HostFailureException, TimeoutException {
209 return MsgNative.taskReceive(mailbox, -1.0, null);
213 * Retrieves next task on the mailbox identified by the specified name (wait at most \a timeout seconds)
218 * @throws TransferFailureException
219 * @throws HostFailureException
220 * @throws TimeoutException
222 public static Task receive(String mailbox, double timeout) throws TransferFailureException, HostFailureException, TimeoutException {
223 return MsgNative.taskReceive(mailbox, timeout, null);
227 * Retrieves next task sent by a given host on the mailbox identified by the specified alias
232 * @throws TransferFailureException
233 * @throws TimeoutException
234 * @throws HostFailureException
237 public static Task receive(String mailbox, Host host) throws TransferFailureException, HostFailureException, TimeoutException {
238 return MsgNative.taskReceive(mailbox, -1.0, host);
242 * Retrieves next task sent by a given host on the mailbox identified by the specified alias (wait at most \a timeout seconds)
248 * @throws TransferFailureException
249 * @throws HostFailureException
250 * @throws TimeoutException
252 public static Task receive(String mailbox, double timeout, Host host) throws TransferFailureException, HostFailureException, TimeoutException {
253 return MsgNative.taskReceive(mailbox, timeout, host);
257 * Tests whether there is a pending communication on the mailbox identified by the specified alias, and who sent it
263 public static int listenFrom(String mailbox) {
264 return MsgNative.taskListenFrom(mailbox);
267 * Listen whether there is a waiting task on the mailbox identified by the specified alias
273 public static boolean listen(String mailbox) {
274 return MsgNative.taskListen(mailbox);
278 * Counts the number of tasks waiting to be received on the \a mailbox identified by the specified alia and sended by the specified \a host.
285 public static int listenFromHost(String alias, Host host) {
286 return MsgNative.taskListenFromHost(alias, host);
290 * Class initializer, to initialize various JNI stuff
292 public static native void nativeInit();