KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > tribe > channel > AbstractReliableFifoChannel


1 /**
2  * Tribe: Group communication library.
3  * Copyright (C) 2004 French National Institute For Research In Computer
4  * Science And Control (INRIA).
5  * Contact: tribe@objectweb.org
6  *
7  * This library is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU Lesser General Public License as published by the
9  * Free Software Foundation; either version 2.1 of the License, or any later
10  * version.
11  *
12  * This library is distributed in the hope that it will be useful, but WITHOUT
13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
15  * for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public License
18  * along with this library; if not, write to the Free Software Foundation,
19  * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
20  *
21  * Initial developer(s): Emmanuel Cecchet.
22  * Contributor(s): ______________________.
23  */
24
25 package org.objectweb.tribe.channel;
26
27 import org.objectweb.tribe.common.Address;
28 import org.objectweb.tribe.exceptions.ChannelException;
29 import org.objectweb.tribe.exceptions.NotConnectedException;
30 import org.objectweb.tribe.messages.ChannelMessage;
31
32 /**
33  * This interface defines a AbstractReliableFifoChannel
34  *
35  * @author <a HREF="mailto:Emmanuel.Cecchet@inria.fr">Emmanuel Cecchet </a>
36  * @version 1.0
37  */
38 public abstract class AbstractReliableFifoChannel
39 {
40
41   /**
42    * Connects to the given endpoint.
43    *
44    * @param destination endpoint to connect to.
45    * @throws ChannelException if an error occurs.
46    */
47   public abstract void connect(Address destination) throws ChannelException;
48
49   /**
50    * Sends a message on the channel.
51    *
52    * @param msg the message to send
53    * @throws ChannelException if an error occurs.
54    * @throws NotConnectedException if the channel is not connected
55    */
56   public abstract void send(ChannelMessage msg) throws ChannelException,
57       NotConnectedException;
58
59   /**
60    * Closes the channel.
61    *
62    * @throws ChannelException if an error occurs.
63    */
64   public abstract void close() throws ChannelException;
65
66   /**
67    * Get the source endpoint of this channel.
68    *
69    * @return the source address
70    */
71   public abstract Address getSourceAddress() throws ChannelException;
72
73   /**
74    * Get the destination endpoint of this channel.
75    *
76    * @return the destination address
77    */
78   public abstract Address getDestinationAddress() throws ChannelException;
79
80 }
Popular Tags