org.xsocket.connection.http.server.IHttpServerEndpoint 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.server;

import java.io.IOException;

import org.xsocket.connection.http.BodyDataSink;
import org.xsocket.connection.http.Response;
import org.xsocket.connection.http.ResponseHeader;



/**
 * represents the server side endpoint of a http connection
 *
 *
 * @author [email protected]
 */
public interface IHttpServerEndpoint {
		
	
	/**
	 * send the response in a chunked body non-blocking mode 
	 * 
	 * @param header   the header 
	 * @return the body handle to write 
	 * @throws IOException if an exception occurs
	 */
	public BodyDataSink send(ResponseHeader header) throws IOException;
	
	
	/**
	 * send the response in a plain body non-blocking mode 
	 * 
	 * @param header         the header
	 * @param contentLength  the body content length
	 * @return the body handle to write 
	 * @throws IOException if an exception occurs
	 */
	public BodyDataSink send(ResponseHeader header, int contentLength) throws IOException;

	
	/**
	 * send the response 
	 *  
	 * @param response   the response 
	 * @throws IOException if an exception occurs
	 */
	public void send(Response response) throws IOException;
	
	
	/**
	 * send an error response 
	 * 
	 * @param errorCode   the error code 
	 * @throws IOException if an exception occurs
	 */
	public void sendError(int errorCode) throws IOException;
	
	
	/**
	 * send an error response 
	 * 
	 * @param errorCode   the error code 
	 * @param msg         the error message
	 * @throws IOException if an exception occurs
	 */
	public void sendError(int errorCode, String msg) throws IOException;
}