KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > mr > core > net > TransportImpl


1 /*
2  * Copyright 2002 by
3  * <a HREF="http://www.coridan.com">Coridan</a>
4  * <a HREF="mailto: support@coridan.com ">support@coridan.com</a>
5  *
6  * The contents of this file are subject to the Mozilla Public License Version
7  * 1.1 (the "License"); you may not use this file except in compliance with the
8  * License. You may obtain a copy of the License at
9  * http://www.mozilla.org/MPL/
10  *
11  * Software distributed under the License is distributed on an "AS IS" basis,
12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13  * for the specific language governing rights and limitations under the
14  * License.
15  *
16  * The Original Code is "MantaRay" (TM).
17  *
18  * The Initial Developer of the Original Code is Uri Schneider.
19  * Portions created by the Initial Developer are Copyright (C) 2006
20  * Coridan Inc. All Rights Reserved.
21  *
22  * Contributor(s): all the names of the contributors are added in the source
23  * code where applicable.
24  *
25  * Alternatively, the contents of this file may be used under the terms of the
26  * LGPL license (the "GNU LESSER GENERAL PUBLIC LICENSE"), in which case the
27  * provisions of LGPL are applicable instead of those above. If you wish to
28  * allow use of your version of this file only under the terms of the LGPL
29  * License and not to allow others to use your version of this file under
30  * the MPL, indicate your decision by deleting the provisions above and
31  * replace them with the notice and other provisions required by the LGPL.
32  * If you do not delete the provisions above, a recipient may use your version
33  * of this file under either the MPL or the GNU LESSER GENERAL PUBLIC LICENSE.
34  
35  *
36  * This library is free software; you can redistribute it and/or modify it
37  * under the terms of the MPL as stated above or under the terms of the GNU
38  * Lesser General Public License as published by the Free Software Foundation;
39  * either version 2.1 of the License, or any later version.
40  *
41  * This library is distributed in the hope that it will be useful, but WITHOUT
42  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
43  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
44  * License for more details.
45  */
46 package org.mr.core.net;
47
48 import java.io.IOException JavaDoc;
49 import java.net.InetSocketAddress JavaDoc;
50 import java.nio.channels.SelectableChannel JavaDoc;
51
52 /**
53  * TransportImpl.java
54  *
55  * An abstraction of I/O operations. Used by {@link Transport}s.
56  *
57  * Created: Tue Feb 03 18:19:21 2004
58  *
59  * @author Uri Schneider
60  * @version 1.0
61  */
62
63 public interface TransportImpl extends SelectorReadCallback {
64     /**
65      * shutdown this TransportImpl, release its resources. This is the place
66      * to close the impl's channel for example.
67      */
68     public void shutdown();
69
70     /**
71      * This method is called whenever there is data available for read on
72      * this impl's channel.
73      */
74     public void read();
75     
76     /**
77      * Send the message's contents using this impl. If this is done
78      * asynchronously, that is, if the payload is still not fully sent
79      * when this method returns, it is the impl's responsibility to
80      * call the message's use() and unuse() upon receiving the
81      * payload, and when the sending is done, respectively. OTHERWISE
82      * VERY BAD THINGS WILL HAPPEN!!! VERY BAD!!! DON'T SAY I DIDN'T
83      * WARN YOU, 'CAUSE I DID. THERE.
84      *
85      * @param msg to be sent, and used() and unused() if the write
86      * operation is asynchronous
87      * @param selector for async write registration
88      * @throws IOException
89      */
90     public void write(CNLMessage msg, int id,
91                                       NetworkSelector selector)
92         throws IOException JavaDoc;
93
94     /**
95      * Whether this impl is initialized. Only initialized impls can send
96      * Manta (applicative) messages.
97      * @return - initialized or not
98      */
99     public boolean isInitialized();
100     /**
101      * mark this impl as initialized
102      */
103     public void setInitialized();
104     /**
105      * @return this impl's channel
106      */
107     public SelectableChannel JavaDoc getChannel();
108     /**
109      * @return the transport type (currently supported: TCP)
110      */
111     public TransportType getType();
112     /**
113      * @return whether this impl has a connected channel
114      */
115     public boolean isConnected();
116     /**
117      * @return true if this impl's channel does not exist, or is not connected
118      */
119     public boolean isDown();
120     /**
121      * @param listener - used to report incoming messages.
122      */
123     public void setListener(NetworkListener listener);
124     /**
125      * called when the impl is connected. insert here any
126      * initialization code needed.
127      */
128     public void onConnect();
129
130     /**
131      * @return the local address of the underlying channel, null if
132      * not connected.
133      */
134     public InetSocketAddress JavaDoc getLocalSocketAddress();
135
136     /**
137      * @return the remote address of the underlying channel, null if
138      * not connected.
139      */
140     public InetSocketAddress JavaDoc getRemoteSocketAddress();
141 } // TransportImpl
142
Popular Tags