1 //******************************************************************************
2 //
3 // File: CommStatus.java
4 // Package: edu.rit.pj
5 // Unit: Class edu.rit.pj.CommStatus
6 //
7 // This Java source file is copyright (C) 2006 by Alan Kaminsky. All rights
8 // reserved. For further information, contact the author, Alan Kaminsky, at
9 // ark@cs.rit.edu.
10 //
11 // This Java source file is part of the Parallel Java Library ("PJ"). PJ is free
12 // software; you can redistribute it and/or modify it under the terms of the GNU
13 // General Public License as published by the Free Software Foundation; either
14 // version 3 of the License, or (at your option) any later version.
15 //
16 // PJ is distributed in the hope that it will be useful, but WITHOUT ANY
17 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
18 // A PARTICULAR PURPOSE. See the GNU General Public License for more details.
19 //
20 // Linking this library statically or dynamically with other modules is making a
21 // combined work based on this library. Thus, the terms and conditions of the GNU
22 // General Public License cover the whole combination.
23 //
24 // As a special exception, the copyright holders of this library give you
25 // permission to link this library with independent modules to produce an
26 // executable, regardless of the license terms of these independent modules, and
27 // to copy and distribute the resulting executable under terms of your choice,
28 // provided that you also meet, for each linked independent module, the terms
29 // and conditions of the license of that module. An independent module is a module
30 // which is not derived from or based on this library. If you modify this library,
31 // you may extend this exception to your version of the library, but you are not
32 // obligated to do so. If you do not wish to do so, delete this exception
33 // statement from your version.
34 //
35 // A copy of the GNU General Public License is provided in the file gpl.txt. You
36 // may also obtain a copy of the GNU General Public License on the World Wide
37 // Web at http://www.gnu.org/licenses/gpl.html.
38 //
39 //******************************************************************************
40 package edu.rit.pj;
41
42 /**
43 * Class CommStatus provides the result of receiving a message from a
44 * communicator (class {@linkplain Comm}).
45 *
46 * @author Alan Kaminsky
47 * @version 09-Mar-2006
48 */
49 public class CommStatus {
50
51 // Exported data members.
52 /**
53 * The rank of the source process that sent the message.
54 */
55 public int fromRank;
56
57 /**
58 * The tag from the message that was received.
59 */
60 public int tag;
61
62 /**
63 * The actual number of items in the message that was received.
64 */
65 public int length;
66
67 // Hidden constructors.
68 /**
69 * Construct a new status object.
70 *
71 * @param fromRank Source process rank.
72 * @param tag Tag.
73 * @param length Length.
74 */
75 CommStatus(int fromRank,
76 int tag,
77 int length) {
78 this.fromRank = fromRank;
79 this.tag = tag;
80 this.length = length;
81 }
82
83 }