/* ====================================================================
 * Trove - Copyright (c) 1997-2000 Walt Disney Internet Group
 * ====================================================================
 * The Tea Software License, Version 1.1
 *
 * Copyright (c) 2000 Walt Disney Internet Group. 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.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Walt Disney Internet Group (http://opensource.go.com/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Tea", "TeaServlet", "Kettle", "Trove" and "BeanDoc" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact opensource@dig.com.
 *
 * 5. Products derived from this software may not be called "Tea",
 *    "TeaServlet", "Kettle" or "Trove", nor may "Tea", "TeaServlet",
 *    "Kettle", "Trove" or "BeanDoc" appear in their name, without prior
 *    written permission of the Walt Disney Internet Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 WALT DISNEY INTERNET GROUP OR ITS
 * 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.
 * ====================================================================
 *
 * For more information about Tea, please see http://opensource.go.com/.
 */

package com.go.trove.net;

import java.io.*;
import java.net.Socket;
import com.go.trove.io.*;

/******************************************************************************
 * A convenient class for supporting buffering on socket I/O streams.
 *
 * @author Brian S O'Neill
 * @version
 * <!--$$Revision: 1.1 $-->, <!--$$JustDate:--> 00/12/06 <!-- $-->
 */
public class BufferedSocket extends FilteredSocket {
    private final int mInBufSize;
    private final int mOutBufSize;

    private InputStream mIn;
    private OutputStream mOut;

    public BufferedSocket(Socket s) throws IOException {
        this(s, -1, -1);
    }

    /**
     * @param inputBufferSize specify 0 for no buffering, -1 for default
     * @param outputBufferSize specify 0 for no buffering, -1 for default
     */
    public BufferedSocket(Socket s,
                          int inputBufferSize,
                          int outputBufferSize) throws IOException {
        super(s);
        mInBufSize = inputBufferSize;
        mOutBufSize = outputBufferSize;
    }
    
    public synchronized InputStream getInputStream() throws IOException {
        if (mIn == null) {
            InputStream in = super.getInputStream();

            if (mInBufSize < 0) {
                mIn = new FastBufferedInputStream(in);
            }
            else if (mInBufSize > 0) {
                mIn = new FastBufferedInputStream(in, mInBufSize);
            }
            else {
                mIn = in;
            }
        }
        return mIn;
    }
    
    public synchronized OutputStream getOutputStream() throws IOException {
        if (mOut == null) {
            OutputStream out = super.getOutputStream();

            if (mOutBufSize < 0) {
                mOut = new FastBufferedOutputStream(out);
            }
            else if (mOutBufSize > 0) {
                mOut = new FastBufferedOutputStream(out, mOutBufSize);
            }
            else {
                mOut = out;
            }
        }
        return mOut;
    }
    
    public synchronized void close() throws IOException {
        // Ensure buffered output is flushed.
        if (mOutBufSize != 0 && mOut != null) {
            mOut.close();
        }
        super.close();
    }
}