// Copyright (c) 2003-present, Jodd Team (http://jodd.org)
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

package jodd.http;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

/**
 * Http connection. Created by {@link HttpConnectionProvider}.
 */
public interface HttpConnection {

	/**
	 * Initializes http connection after socket is created.
	 * Applies configurations, like {@link #setTimeout(int)}.
	 */
	public void init() throws IOException;

	/**
	 * Returns connection output stream.
	 */
	public OutputStream getOutputStream() throws IOException;

	/**
	 * Returns connection input stream.
	 */
	public InputStream getInputStream() throws IOException;

	/**
	 * Closes connection. Ignores all exceptions.
	 */
	public void close();

	/**
	 * Sets the timeout for connections, in milliseconds. With this option set to a non-zero timeout,
	 * connection will block for only this amount of time. If the timeout expires, an Exception is raised.
	 * The timeout must be &gt; 0. A timeout of zero is interpreted as an infinite timeout.
	 */
	void setTimeout(int milliseconds);

}