001: /*
002: License $Id: I_Listener.java,v 1.4 2003/09/13 04:59:56 hendriks73 Exp $
003:
004: Copyright (c) 2001-2005 tagtraum industries.
005:
006: LGPL
007: ====
008:
009: jo! is free software; you can redistribute it and/or
010: modify it under the terms of the GNU Lesser General Public
011: License as published by the Free Software Foundation; either
012: version 2.1 of the License, or (at your option) any later version.
013:
014: jo! is distributed in the hope that it will be useful,
015: but WITHOUT ANY WARRANTY; without even the implied warranty of
016: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017: Lesser General Public License for more details.
018:
019: You should have received a copy of the GNU Lesser General Public
020: License along with this library; if not, write to the Free Software
021: Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
022:
023: For LGPL see <http://www.fsf.org/copyleft/lesser.txt>
024:
025:
026: Sun license
027: ===========
028:
029: This release contains software by Sun Microsystems. Therefore
030: the following conditions have to be met, too. They apply to the
031: files
032:
033: - lib/mail.jar
034: - lib/activation.jar
035: - lib/jsse.jar
036: - lib/jcert.jar
037: - lib/jaxp.jar
038: - lib/crimson.jar
039: - lib/servlet.jar
040: - lib/jnet.jar
041: - lib/jaas.jar
042: - lib/jaasmod.jar
043:
044: contained in this release.
045:
046: a. Licensee may not modify the Java Platform
047: Interface (JPI, identified as classes contained within the javax
048: package or any subpackages of the javax package), by creating additional
049: classes within the JPI or otherwise causing the addition to or modification
050: of the classes in the JPI. In the event that Licensee creates any
051: Java-related API and distribute such API to others for applet or
052: application development, you must promptly publish broadly, an accurate
053: specification for such API for free use by all developers of Java-based
054: software.
055:
056: b. Software is confidential copyrighted information of Sun and
057: title to all copies is retained by Sun and/or its licensors. Licensee
058: shall not modify, decompile, disassemble, decrypt, extract, or otherwise
059: reverse engineer Software. Software may not be leased, assigned, or
060: sublicensed, in whole or in part. Software is not designed or intended
061: for use in on-line control of aircraft, air traffic, aircraft navigation
062: or aircraft communications; or in the design, construction, operation or
063: maintenance of any nuclear facility. Licensee warrants that it will not
064: use or redistribute the Software for such purposes.
065:
066: c. Software is provided "AS IS," without a warranty
067: of any kind. ALL EXPRESS OR IMPLIED REPRESENTATIONS AND WARRANTIES,
068: INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
069: PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED.
070:
071: d. This License is effective until terminated. Licensee may
072: terminate this License at any time by destroying all copies of Software.
073: This License will terminate immediately without notice from Sun if Licensee
074: fails to comply with any provision of this License. Upon such termination,
075: Licensee must destroy all copies of Software.
076:
077: e. Software, including technical data, is subject to U.S.
078: export control laws, including the U.S. Export Administration Act and its
079: associated regulations, and may be subject to export or import regulations
080: in other countries. Licensee agrees to comply strictly with all such
081: regulations and acknowledges that it has the responsibility to obtain
082: licenses to export, re-export, or import Software. Software may not be
083: downloaded, or otherwise exported or re-exported (i) into, or to a national
084: or resident of, Cuba, Iraq, Iran, North Korea, Libya, Sudan, Syria or any
085: country to which the U.S. has embargoed goods; or (ii) to anyone on the
086: U.S. Treasury Department's list of Specially Designated Nations or the U.S.
087: Commerce Department's Table of Denial Orders.
088:
089:
090: Feedback
091: ========
092:
093: We encourage your feedback and suggestions and want to use your feedback to
094: improve the Software. Send all such feedback to:
095: <feedback@tagtraum.com>
096:
097: For more information on tagtraum industries and jo!
098: please see <http://www.tagtraum.com/>.
099:
100:
101: */
102: package com.tagtraum.framework.server;
103:
104: import java.io.IOException;
105: import java.net.InetAddress;
106:
107: /**
108: * The <code>Listener</code> encapsulates a communication endpoint
109: * of a {@link I_Service}. This means one {@link I_Service} can have
110: * many <code>Listener</code>s. This is necessary to listen to
111: * multiple ports.
112: *
113: * @author <a href="mailto:hs@tagtraum.com">Hendrik Schreiber</a>
114: * @version 1.1beta1 $Id: I_Listener.java,v 1.4 2003/09/13 04:59:56 hendriks73 Exp $
115: * @see I_Service
116: * @see Listener
117: */
118: public interface I_Listener {
119:
120: /**
121: * Source-Version
122: */
123: public static String vcid = "$Id: I_Listener.java,v 1.4 2003/09/13 04:59:56 hendriks73 Exp $";
124:
125: /**
126: * Indicates whether this <code>Listener</code> is already bound
127: * to a port/address.
128: *
129: * @return <code>true</code> or <code>false</code>
130: */
131: public boolean isBound();
132:
133: /**
134: * Starts the listening loop.
135: *
136: * @exception ServerException if it is not possible to
137: * start this <code>Listener</code>
138: */
139: public void start() throws ServerException;
140:
141: /**
142: * Stops the listening loop.
143: *
144: * @exception ServerException if it is not possible to
145: * stop this <code>Listener</code>
146: */
147: public void stop() throws ServerException;
148:
149: /**
150: * Is called, when a <code>SO_TIMEOUT</code> happened.
151: * It might be a good idea to call {@link I_Service#handleSoTimeout}
152: * here.
153: */
154: public void handleSoTimeout();
155:
156: /**
157: * Returns <code>SO_TIMEOUT</code> for the accepting socket.
158: *
159: * @param aSoTimeout time in ms
160: */
161: public int getSoTimeout();
162:
163: /**
164: * Closes the socket of this <code>Listener</code>.
165: */
166: public void close() throws IOException;;
167:
168: /**
169: * Contains the listenting loop.
170: */
171: public abstract void run();
172:
173: /**
174: * Returns the used port.
175: *
176: * @return the used port
177: */
178: public int getPort();
179:
180: /**
181: * Sets the port to use.
182: *
183: * @param port port the socket should use
184: */
185: public void setPort(int port);
186:
187: /**
188: * Returns the currently used <code>InetAddress</code>.
189: *
190: * @return the current <code>InetAddress</code>
191: */
192: public InetAddress getBindAddress();
193:
194: /**
195: * Sets the <code>InetAddresse</code>, the <code>Listener</code> should
196: * be bound to.
197: *
198: * @param aBindAddress <code>InetAddresse</code>, the <code>Listener</code> should
199: * be bound to
200: */
201: public void setBindAddress(InetAddress aBindAddress);
202:
203: /**
204: * Returns the {@link I_Service}.
205: *
206: * @return service.
207: */
208: public I_Service getService();
209:
210: /**
211: * Sets the {@link I_Service}.
212: *
213: * @param aService service.
214: */
215: public void setService(I_Service aService);
216:
217: /**
218: * Returns the name of this <code>Listener</code>.
219: *
220: * @return Name of this <code>Listener</code>
221: */
222: public String getName();
223:
224: /**
225: * Sets the name of this <code>Listener</code>.
226: *
227: * @param name name of this <code>Listener</code>
228: */
229: public void setName(String name);
230:
231: }
|