Package com.martiansoftware.nailgun

Class NGOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

java.io.DataOutputStream

com.martiansoftware.nailgun.NGOutputStream

All Implemented Interfaces:

Closeable, DataOutput, Flushable, AutoCloseable

class NGOutputStream
extends DataOutputStream

Wraps an OutputStream to send writes in NailGun chunks. Because multiple NGOutputStreams wrap the same OutputStream (that is, the OutputStream obtained from the Socket connection with the client), writes are synchronized on the underlying OutputStream. If this were not the case, write interleaving could completely break the NailGun protocol.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	closed
private final Object	lock
private byte	streamCode

Fields inherited from class java.io.DataOutputStream

written

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
NGOutputStream(OutputStream out, byte streamCode)	Creates a new NGOutputStream wrapping the specified OutputStream and using the specified Nailgun chunk code.

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
private void	throwIfClosed()	Check if stream is closed and throw an IOException if yes.
void	write(byte[] b)
void	write(byte[] b, int offset, int len)
void	write(int b)

Methods inherited from class java.io.DataOutputStream

size, writeBoolean, writeByte, writeBytes, writeChar, writeChars, writeDouble, writeFloat, writeInt, writeLong, writeShort, writeUTF

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

lock

private final Object lock

streamCode

private byte streamCode

closed

private boolean closed

Constructor Details

NGOutputStream

public NGOutputStream(OutputStream out,
 byte streamCode)

Creates a new NGOutputStream wrapping the specified OutputStream and using the specified Nailgun chunk code.

Parameters:

out - the OutputStream to wrap

streamCode - the NailGun chunk code associated with this stream (i.e., '1' for stdout, '2' for stderr).

Method Details

write

public void write(byte[] b)
           throws IOException

Specified by:

write in interface DataOutput

Overrides:

write in class FilterOutputStream

Throws:

IOException

See Also:

• OutputStream.write(byte[])

write

public void write(int b)
           throws IOException

Specified by:

write in interface DataOutput

Overrides:

write in class DataOutputStream

Throws:

IOException

See Also:

• OutputStream.write(int)

write

public void write(byte[] b,
 int offset,
 int len)
           throws IOException

Specified by:

write in interface DataOutput

Overrides:

write in class DataOutputStream

Throws:

IOException

See Also:

• OutputStream.write(byte[],int,int)

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterOutputStream

Throws:

IOException

See Also:

• Implement an empty close function, to allow the client to close the stdout and/or stderr, without this closing the connection socket to the client.

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class DataOutputStream

Throws:

IOException

See Also:

• OutputStream.flush()

throwIfClosed

private void throwIfClosed()
                    throws IOException

Check if stream is closed and throw an IOException if yes. In the case of a public operation is being performed while the stream is already closed throws an IOException.

Throws:

IOException