ClusterNode (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- edu.utexas.clm.archipelago.network.node.ClusterNode

All Implemented Interfaces:: TransceiverListener

public class ClusterNode
extends Object
implements TransceiverListener

Author:: Larry Lindsey

Constructor Summary

Constructors
Constructor and Description

ClusterNode(NodeParameters params, TransceiverExceptionListener tel)

Constructors
Constructor and Description
`ClusterNode(NodeParameters params, TransceiverExceptionListener tel)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBottler(Bottler bottler)`
`void`	`addListener(NodeStateListener listener)` Adds a NodeStateListener to the list of listeners that are notified when the state of this ClusterNode changes.
`boolean`	`cancelJob(long id)`
`void`	`close()`
`void`	`fail()` Like close, but indicates that the Cluster encountered a problem.
`int`	`getAvailableRamMB()`
`String`	`getExecPath()`
`String`	`getFilePath()`
`String`	`getHost()`
`long`	`getID()`
`int`	`getMaxRamMB()`
`NodeParameters`	`getParam()`
`List<ProcessManager>`	`getRunningProcesses()`
`ClusterNodeState`	`getState()`
`int`	`getThreadLimit()`
`int`	`getTotalRamMB()`
`String`	`getUser()`
`void`	`handleMessage(ClusterMessage cm)`
`boolean`	`isReady()`
`long`	`lastBeat()`
`int`	`numAvailableThreads()`
`int`	`numRunningThreads()`
`void`	`removeListener(NodeStateListener listener)`
`void`	`setActive(boolean active)`
`void`	`setExecPath(String path)`
`void`	`setFilePath(String path)`
`void`	`setIOStreams(InputStream is, OutputStream os)` Sets the InputStream and OutputStream used to communicate with the remote compute node.
`void`	`setMessageXC(MessageXC xc)`
`protected void`	`setState(ClusterNodeState nextState)`
`void`	`start(NodeShellListener listener)`
`static String`	`stateString(ClusterNodeState state)`
`void`	`streamClosed()`
`boolean`	`submit(ProcessManager<?> process, ProcessListener listener)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ClusterNode

public ClusterNode(NodeParameters params,
                   TransceiverExceptionListener tel)

Method Detail

setExecPath
```
public void setExecPath(String path)
```

setFilePath
```
public void setFilePath(String path)
```

streamClosed
```
public void streamClosed()
```
Specified by:

streamClosed in interface TransceiverListener

setIOStreams
```
public void setIOStreams(InputStream is,
                         OutputStream os)
                  throws IOException,
                         TimeoutException,
                         InterruptedException
```
Sets the InputStream and OutputStream used to communicate with the remote compute node. is and os are used to create a MessageXC.

Parameters:

is - InputStream to receive data from the remote machine

os - OutputStream to send data to the remote machine

Throws:

IOException - if a problem arises opening one of the streams

TimeoutException - if we time out while waiting for the remote node

InterruptedException - if we are interrupted while waiting for the remote node

setMessageXC

public void setMessageXC(MessageXC xc)

getHost
```
public String getHost()
```

getUser
```
public String getUser()
```

getExecPath
```
public String getExecPath()
```

getFilePath
```
public String getFilePath()
```

isReady
```
public boolean isReady()
```

getID
```
public long getID()
```

getParam
```
public NodeParameters getParam()
```

numRunningThreads
```
public int numRunningThreads()
```

numAvailableThreads
```
public int numAvailableThreads()
```

getThreadLimit
```
public int getThreadLimit()
```

setActive

public void setActive(boolean active)

submit

public boolean submit(ProcessManager<?> process,
                      ProcessListener listener)

lastBeat
```
public long lastBeat()
```

handleMessage
```
public void handleMessage(ClusterMessage cm)
```
Specified by:

handleMessage in interface TransceiverListener

getMaxRamMB
```
public int getMaxRamMB()
```

getAvailableRamMB
```
public int getAvailableRamMB()
```

getTotalRamMB
```
public int getTotalRamMB()
```

fail
```
public void fail()
```
Like close, but indicates that the Cluster encountered a problem.

close
```
public void close()
```

stateString

public static String stateString(ClusterNodeState state)

setState

protected void setState(ClusterNodeState nextState)

cancelJob
```
public boolean cancelJob(long id)
```

getRunningProcesses

public List<ProcessManager> getRunningProcesses()

addListener
```
public void addListener(NodeStateListener listener)
```
Adds a NodeStateListener to the list of listeners that are notified when the state of this ClusterNode changes. Immediately upon addition, the listener is called with the current state, and given that the last state was ClusterNodeState.INACTIVE to indicate that this is the initial call.

Parameters:

listener - a NodeStateListener to register with the ClusterNode

addBottler

public void addBottler(Bottler bottler)

removeListener

public void removeListener(NodeStateListener listener)

getState
```
public ClusterNodeState getState()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

start

public void start(NodeShellListener listener)
           throws ShellExecutionException

Throws:: ShellExecutionException

Class ClusterNode

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClusterNode

Method Detail

setExecPath

setFilePath

streamClosed

setIOStreams

setMessageXC

getHost

getUser

getExecPath

getFilePath

isReady

getID

getParam

numRunningThreads

numAvailableThreads

getThreadLimit

setActive

submit

lastBeat

handleMessage

getMaxRamMB

getAvailableRamMB

getTotalRamMB

fail

close

stateString

setState

cancelJob

getRunningProcesses

addListener

addBottler

removeListener

getState

toString

start