KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > dream > protocol > ArrowChunk


1 /**
2  * Dream
3  * Copyright (C) 2003-2004 INRIA Rhone-Alpes
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Contact: dream@objectweb.org
20  *
21  * Initial developer(s): Matthieu Leclercq
22  * Contributor(s): Vivien Quema
23  */
24
25 package org.objectweb.dream.protocol;
26
27 import org.objectweb.dream.message.ChunkType;
28 import org.objectweb.dream.message.ChunkTypeImpl;
29
30 /**
31  * A general purpose chunk that can be use to identify the sender and receiver
32  * processes of a message. Note that a process is identified using a short
33  * integer.
34  *
35  * @see Process
36  */
37 public interface ArrowChunk
38 {
39
40   /** The default name for chunks of this type */
41   String JavaDoc DEFAULT_NAME = "arrowChunk";
42
43   /** The chunk type of chunks implementing this interface. */
44   ChunkType TYPE = new ChunkTypeImpl(ArrowChunk.class,
45                              ArrowChunkImpl.class);
46
47   /**
48    * Returns the identifier of the sender process.
49    *
50    * @return the identifier of the sender process.
51    */
52   short getProcessIdFrom();
53
54   /**
55    * Sets the identifier of the sender process.
56    *
57    * @param from the identifier of the sender process.
58    */
59   void setProcessIdFrom(short from);
60
61   /**
62    * Returns the identifier of the receiver process.
63    *
64    * @return the identifier of the receiver process.
65    */
66   short getProcessIdTo();
67
68   /**
69    * Sets the identifier of the receiver process.
70    *
71    * @param to the identifier of the receiver process.
72    */
73   void setProcessIdTo(short to);
74 }
Popular Tags