org.xsocket.connection.spi.IIoHandlerCallback Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xSocket
xSocket
There is a newer version: 2.8.15
/*
 *  Copyright (c) xsocket.org, 2006 - 2008. All rights reserved.
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Please refer to the LGPL license at: http://www.gnu.org/copyleft/lesser.txt
 * The latest copy of this software may be found on http://www.xsocket.org/
 */
package org.xsocket.connection.spi;

import java.io.IOException;
import java.nio.ByteBuffer;




/**
 * Call back interface to notify io events of the {@link IIoHandler}. The IIoHandler
 * is responsible to notify the events in the occured order. 


 * 
 * 
 * 
 * @author [email protected]
 */
public interface IIoHandlerCallback {
		
	
	/**
	 * notifies that data has been read from the socket. 


	 * 
	 * @param data  the received data
	 *
	 */
	public void onData(ByteBuffer[] data);
		
	
	/**
	 * notifies that the underlying connection has been established. 

	 *
	 */
	public void onConnect();
		
	
	/**
	 * notifies that the underlying connection has been disconnected (closed).

	 *
	 */
	public void onDisconnect();
		
	
	/**
	 * notifies the idle time out has been occurred.

	 *
	 */
	public void onIdleTimeout();

	
	/**
	 * notifies the connection time out has been occurred.

	 *
	 */
	public void onConnectionTimeout();
		
	
	/**
	 * notifies that the connection has to be closed (connection is corrupt, 
	 * selector has be closed, ...). This call back method will NOT be called in the case of 
	 * idle or connection time out.


	 * 
	 */
	public void onConnectionAbnormalTerminated();
	

	
	/**
	 * notifies that data has been written on the socket.


	 *
	 * @param data  the written data
	 */
	public void onWritten(ByteBuffer data);
	
	
	/**
	 * notifies that an error has been occurred by writing data on the socket.


	 * 
	 * @param ioe   ioException an io exception
	 * @param data  the data, which has been tried to write
	 */	
	public void onWriteException(IOException ioException, ByteBuffer data);
}