org.xsocket.connection.http.IHttpConnectHandler 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 org.xsocket.connection.IConnectHandler;



/**
 * The connect handler will be called if a new http connection has been established.
 * 
 * 


 * Example:
 *  *  class MyHandler implements IRequestHandler, IHttpConnectHandler {
 *  
 *     private String host = null;
 *     private int port = 0;
 *     
 *     public ProxyHandlerHandler(String host, int port) {
 *        this.host = host;
 *        this.port = port;
 *     }
 *     
 *     public boolean onConnect(IHttpConnection httpConnection) throws IOException {
 *     
 *        // create the forward connection and set some properties
 *        HttpClientConnection forwardConnection = new HttpClientConnection(host, port, new DisconnectHandler());
 *        forwardConnection.setIdleTimeoutSec(IDLE_TIMEOUT_SEC);
 *        
 *        // cross attaching (required for disconnecting)
 *        httpConnection.setAttachment(forwardConnection);
 *        forwardConnection.setAttachment(httpConnection);
 *     }
 *
 *
 *     public void onRequest(HttpServerConnection httpServerConnection) throws IOException {
 *        
 *        ...
 *        
 *     }			
 *  }        
 * 			
 * 
 * 
 * @author [email protected]
 */
public interface IHttpConnectHandler extends IHttpHandler {

	
	/**
	 * see {@link IConnectHandler}
	 */
	public boolean onConnect(IHttpConnection httpConnection) throws IOException;	

}