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:
25: /**
26: * Handles the disconnecting of connections. <br>
27: * The disconnecting of a connection occurs in three ways:
28: * <ul>
29: * <li> the client initiates the disconnect by closing the connection. In this case the
30: * <code>onDisconnect</code> method will be called immediately
31: * <li> the connection breaks or the client disconnects improperly and the underlying SocketChannel
32: * detects the broken connection. In this case the <code>onDisconnect</code> method will be
33: * called, when
34: * the broken connection will be detected
35: * <li> the connection breaks or the client disconnects improperly and the underlying SocketChannel
36: * does not detect the broken connection. In this case the <code>onDisconnect</code> method
37: * will only be called after a connection or idle timeout (see {@link IIdleTimeoutHandler}, {@link IConnectionTimeoutHandler})
38: * </ul>
39: *
40: *
41: * @author grro@xsocket.org
42: */
43: public interface IDisconnectHandler extends IHandler {
44:
45: /**
46: * handles disconnecting of a connection
47: *
48: *
49: * @param connection the <i>closed</i> connection
50: * @return true for positive result of handling, false for negative result of handling
51: * @throws IOException If some I/O error occurs.
52: */
53: public boolean onDisconnect(INonBlockingConnection connection)
54: throws IOException;
55:
56: }
|