FleetProcess (FleetCode API Documentation)

edu.berkeley.fleet.api
Class FleetProcess

Object
  FleetProcess

Represents a running "slave" fleet with debugging facilities controlled by the "master" JVM.

Each Fleet which supports this API must include:

The ability to dispatch instructions, words, and tokens from the master, "on the fly".
A "debug.in" dock such that any words delivered there are sent back to the master.

Constructor Summary
`FleetProcess()`

Method Summary
`void`	`finalize()`
`abstract void`	`flush()` flush all instructions, words, and tokens dispatched so far
`abstract Dock`	`getDebugInputDock()` the dock used to read back data from the slave
`abstract Fleet`	`getFleet()` return the Fleet that this FleetProcess controls
`boolean`	`isTerminated()` Returns true if the process is terminated
`abstract BitVector`	`recvWord()` returns the next word delivered at the dock specified by `getDebugInputDock()`
`abstract void`	`sendInstruction(Instruction i)` dispatch an instruction; may be buffered
`abstract void`	`sendToken(Destination d)` dispatch a token to a given destination; may be buffered
`abstract void`	`sendWord(Destination d, BitVector word)` dispatch a word to a given destination; may be buffered
`void`	`terminate()` Terminate the process.

Methods inherited from class Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

public FleetProcess()

Method Detail

public abstract void sendInstruction(Instruction i)

dispatch an instruction; may be buffered

public abstract void sendWord(Destination d,
                              BitVector word)

dispatch a word to a given destination; may be buffered

public abstract void sendToken(Destination d)

dispatch a token to a given destination; may be buffered

public abstract void flush()

flush all instructions, words, and tokens dispatched so far

public abstract Dock getDebugInputDock()

the dock used to read back data from the slave

public abstract BitVector recvWord()

returns the next word delivered at the dock specified by getDebugInputDock()

public final void terminate()

Terminate the process.

public final boolean isTerminated()

Returns true if the process is terminated

public void finalize()

public abstract Fleet getFleet()

return the Fleet that this FleetProcess controls