com.martiansoftware.nailgun

Class NGCommunicator

java.lang.Object

com.martiansoftware.nailgun.NGCommunicator

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class NGCommunicator
extends java.lang.Object
implements java.io.Closeable

Once initial handshaking is complete, handles all reads and writes to the socket with the client using underlying socket streams. Also handles client disconnect events based on client heartbeats.

Constructor Summary

Constructors

Constructor and Description
NGCommunicator(java.io.DataInputStream in, java.io.DataOutputStream out, int heartbeatTimeoutMillis) Creates a new NGCommunicator 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
void	addHeartbeatListener(NGHeartbeatListener listener)
int	available()
void	close() Stop the thread reading from the NailGun client
boolean	isClientConnected()
int	receive(byte[] b, int offset, int length) Read data from client's stdin.
void	removeAllClientListeners() Do not notify anymore about client disconnects
void	removeClientListener(NGClientListener listener)
void	removeHeartbeatListener(NGHeartbeatListener listener)
void	send(byte streamCode, byte[] b, int offset, int len) Send data to the client

Methods inherited from class java.lang.Object

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

Constructor Detail

NGCommunicator

public NGCommunicator(java.io.DataInputStream in,
                      java.io.DataOutputStream out,
                      int heartbeatTimeoutMillis)

Creates a new NGCommunicator 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 - Socket read stream, will be closed with NGCommunicator's close()

out - Socket write stream, will be closed with NGCommunicator's close()

heartbeatTimeoutMillis - the interval between heartbeats before considering the client disconnected

Method Detail

close

public void close()
           throws java.io.IOException

Stop the thread reading from the NailGun client

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

receive

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

Read data from client's stdin. This function blocks till input is received from the client.

Returns:

number of bytes read or -1 if no more data is available

Throws:

java.io.IOException - in case of socket error

java.lang.InterruptedException

send

public void send(byte streamCode,
                 byte[] b,
                 int offset,
                 int len)
          throws java.io.IOException

Send data to the client

Throws:

java.io.IOException

isClientConnected

public boolean isClientConnected()

Returns:

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

available

public int available()

Returns:

number of bytes in internal stdin buffer

addClientListener

public void addClientListener(NGClientListener listener)

Registers a new NGClientListener to be called on client disconnection

Parameters:

listener - the NGClientListener to be notified of client events.

removeClientListener

public void removeClientListener(NGClientListener listener)

Parameters:

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

removeAllClientListeners

public void removeAllClientListeners()

Do not notify anymore about client disconnects

addHeartbeatListener

public void addHeartbeatListener(NGHeartbeatListener listener)

Parameters:

listener - the NGHeartbeatListener to be notified of heartbeats

removeHeartbeatListener

public void removeHeartbeatListener(NGHeartbeatListener listener)

Parameters:

listener - the NGHeartbeatListener to no longer be notified of heartbeats