org.xsocket.connection.http.IBodyHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xSocket-http
xSocket http extension
There is a newer version: 2.0-beta-1
/*
 *  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.http;

import java.io.IOException;
import java.nio.BufferUnderflowException;

import org.xsocket.Execution;
import org.xsocket.MaxReadSizeExceededException;



/**
 * The body handler definition. 


 * 
 * Example:
 *  *  class BodyHandler implements IBodyHandler {
 *     private FileChannel fc = null;
 *     
 *     BodyHandler(File file) throws IOException {
 *        fc = new RandomAccessFile(file, "rw").getChannel();
 *     }
 *     
 *     public boolean onData(NonBlockingBodyDataSource bodyDataSource) throws IOException {
 *        fc.transferFrom(bodyDataSource, fc.size(), bodyDataSource.available());
 *        if (bodyDataSource.isComplete()) {
 *           fc.close();
 *        }
 *        return true;
 *     }
 *  } 
 * 
 *
 * @author [email protected]
 */
public interface IBodyHandler {
	
	public static final Execution.Mode DEFAULT_EXECUTION_MODE = Execution.Mode.MULTITHREADED;
	
	
	/**
	 * call back. This method will be called each time body data has been received 
	 * for the given body 
	 * 
	 * @param bodyDataSource    the body  
	 * @return true, if the event has been handled
	 * @throws IOException If some other I/O error occurs. Throwing this exception causes that the underlying connection will be closed.
 	 * @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
 	 * @throws MaxReadSizeExceededException if the max read size has been reached (e.g. by calling method {@link NonBlockingBodyDataSource#readByteBufferByDelimiter(String, String, int)}).
 	 *                                      Throwing this exception causes that the underlying connection will be closed.

	 */
	public boolean onData(NonBlockingBodyDataSource bodyDataSource) throws IOException, BufferUnderflowException, MaxReadSizeExceededException;
}