org.apache.commons.net.io

Class SocketInputStream


public class SocketInputStream
extends FilterInputStream

This class wraps an input stream, storing a reference to its originating socket. When the stream is closed, it will also close the socket immediately afterward. This class is useful for situations where you are dealing with a stream originating from a socket, but do not have a reference to the socket, and want to make sure it closes when the stream closes.

Author:
Daniel F. Savarese

See Also:
SocketOutputStream

Field Summary

private Socket
__socket

Constructor Summary

SocketInputStream(Socket socket, InputStream stream)
Creates a SocketInputStream instance wrapping an input stream and storing a reference to a socket that should be closed on closing the stream.

Method Summary

void
close()
Closes the stream and immediately afterward closes the referenced socket.

Field Details

__socket

private Socket __socket

Constructor Details

SocketInputStream

public SocketInputStream(Socket socket,
                         InputStream stream)
Creates a SocketInputStream instance wrapping an input stream and storing a reference to a socket that should be closed on closing the stream.

Parameters:
socket - The socket to close on closing the stream.
stream - The input stream to wrap.

Method Details

close

public void close()
            throws IOException
Closes the stream and immediately afterward closes the referenced socket.