com.martiansoftware.nailgun

Class NGInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.martiansoftware.nailgun.NGInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class NGInputStream
extends java.io.FilterInputStream
implements java.io.Closeable

A FilterInputStream that is able to read the chunked stdin stream from a NailGun client.

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
NGInputStream(java.io.InputStream in, java.io.DataOutputStream out, java.io.PrintStream serverLog, int heartbeatTimeoutMillis) Creates a new NGInputStream wrapping the specified InputStream.

Method Summary

Modifier and Type	Method and Description
void	addClientListener(NGClientListener listener) Registers a new NGClientListener to be called on client disconnection or calls the listeners clientDisconnected method if the client has already disconnected to avoid races.
void	addHeartbeatListener(NGHeartbeatListener listener)
int	available()
void	close() Cancels the thread reading from the NailGun client.
boolean	isClientConnected()
boolean	markSupported()
int	read()
int	read(byte[] b)
int	read(byte[] b, int offset, int length)
void	removeClientListener(NGClientListener listener)
void	removeHeartbeatListener(NGHeartbeatListener listener)

Methods inherited from class java.io.FilterInputStream

mark, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

NGInputStream

public NGInputStream(java.io.InputStream in,
                     java.io.DataOutputStream out,
                     java.io.PrintStream serverLog,
                     int heartbeatTimeoutMillis)

Creates a new NGInputStream wrapping the specified InputStream. Also sets up a timer to periodically consume heartbeats sent from the client and call registered NGClientListeners if a client disconnection is detected.

Parameters:

in - the InputStream to wrap

out - the OutputStream to which SENDINPUT chunks should be sent

serverLog - the PrintStream to which server logging messages should be written

heartbeatTimeoutMillis - the interval between heartbeats before considering the client disconnected

Method Detail

close

public void close()

Cancels the thread reading from the NailGun client.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.FilterInputStream

available

public int available()
              throws java.io.IOException

Overrides:

available in class java.io.FilterInputStream

Throws:

java.io.IOException

See Also:

InputStream.available()

markSupported

public boolean markSupported()

Overrides:

markSupported in class java.io.FilterInputStream

See Also:

InputStream.markSupported()

read

public int read()
         throws java.io.IOException

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

See Also:

InputStream.read()

read

public int read(byte[] b)
         throws java.io.IOException

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

See Also:

InputStream.read(byte[])

read

public int read(byte[] b,
                int offset,
                int length)
         throws java.io.IOException

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

See Also:

InputStream.read(byte[], int, int)

isClientConnected

public boolean isClientConnected()

Returns:

true if interval since last read is less than heartbeat timeout interval.

addClientListener

public void addClientListener(NGClientListener listener)

Registers a new NGClientListener to be called on client disconnection or calls the listeners clientDisconnected method if the client has already disconnected to avoid races.

Parameters:

listener - the NGClientListener to be notified of client events.

Throws:

java.lang.InterruptedException - if thrown by the clientDisconnected method or it calls System.exit().

removeClientListener

public void removeClientListener(NGClientListener listener)

Parameters:

listener - the NGClientListener to no longer be notified of client events.

addHeartbeatListener

public void addHeartbeatListener(NGHeartbeatListener listener)

Parameters:

listener - the NGHeartbeatListener to be notified of client events.

removeHeartbeatListener

public void removeHeartbeatListener(NGHeartbeatListener listener)

Parameters:

listener - the NGClientListener to no longer be notified of client events.