File Doc Category Size Date Package
SocketOutputStream.java API Doc Apache Commons NET 1.4.1 API 2805 Sat Dec 03 10:05:48 GMT 2005 org.apache.commons.net.io

SocketOutputStream

java.lang.Object
- java.io.OutputStream
  - java.io.FilterOutputStream

public class SocketOutputStream extends FilterOutputStream

This class wraps an output 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: SocketInputStream

Fields Summary
private Socket
__socket
Constructors Summary
public SocketOutputStream(Socket socket, OutputStream stream)
Creates a SocketOutputStream instance wrapping an output stream and storing a reference to a socket that should be closed on closing the stream.
param
socket The socket to close on closing the stream.
param
stream The input stream to wrap.
super(stream); __socket = socket;
Methods Summary
public void close()
Closes the stream and immediately afterward closes the referenced socket.
exception
IOException If there is an error in closing the stream or socket.
super.close(); __socket.close();
public void write(byte[] buffer, int offset, int length)
Writes a number of bytes from a byte array to the stream starting from a given offset. This method bypasses the equivalent method in FilterOutputStream because the FilterOutputStream implementation is very inefficient.
param
buffer The byte array to write.
param
offset The offset into the array at which to start copying data.
param
length The number of bytes to write.
exception
IOException If an error occurs while writing to the underlying stream.
out.write(buffer, offset, length);