01: /*
02: * Copyright (c) xsocket.org, 2006 - 2008. All rights reserved.
03: *
04: * This library is free software; you can redistribute it and/or
05: * modify it under the terms of the GNU Lesser General Public
06: * License as published by the Free Software Foundation; either
07: * version 2.1 of the License, or (at your option) any later version.
08: *
09: * This library is distributed in the hope that it will be useful,
10: * but WITHOUT ANY WARRANTY; without even the implied warranty of
11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12: * Lesser General Public License for more details.
13: *
14: * You should have received a copy of the GNU Lesser General Public
15: * License along with this library; if not, write to the Free Software
16: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17: *
18: * Please refer to the LGPL license at: http://www.gnu.org/copyleft/lesser.txt
19: * The latest copy of this software may be found on http://www.xsocket.org/
20: */
21: package org.xsocket.connection;
22:
23: import java.io.IOException;
24: import java.nio.BufferUnderflowException;
25:
26: import org.xsocket.MaxReadSizeExceededException;
27:
28: /**
29: * Handles new incoming connections. <br><br>
30: *
31: * E.g.
32: * <pre>
33: * public final class BlackIpHandler implements IConnectHandler {
34: * ...
35: * public boolean onConnect(INonBlockingConnection connection) throws IOException {
36: * connection.setAutoflush(false);
37: * connection.setFlushmode(FlushMode.ASYNC);
38: *
39: * ...
40: * return true;
41: * }
42: * }
43: *
44: * @author grro@xsocket.org
45: */
46: public interface IConnectHandler extends IHandler {
47:
48: /**
49: * handles a new incoming connection
50: *
51: * @return true for positive result of handling, false for negative result of handling
52: * @throws IOException if some other I/O error occurs. Throwing this exception causes that the underlying connection will be closed.
53: * @throws BufferUnderflowException if more incoming data is required to process (e.g. delimiter hasn't yet received -> readByDelimiter methods or size of the available, received data is smaller than the required size -> readByLength). The BufferUnderflowException will be swallowed by the framework
54: * @throws MaxReadSizeExceededException if the max read size has been reached (e.g. by calling method {@link INonBlockingConnection#readStringByDelimiter(String, int)}).
55: * Throwing this exception causes that the underlying connection will be closed.
56: */
57: public boolean onConnect(INonBlockingConnection connection)
58: throws IOException, BufferUnderflowException,
59: MaxReadSizeExceededException;
60: }
|