|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectptolemy.actor.process.Branch
A Branch transfers tokens through a channel that crosses a composite actor boundary. Branch implements the Runnable class and the execution of a branch object is controlled by an instantiation of the BranchController class. Each branch object is assigned two receiver objects and each of these receiver objects must implement the ProcessReceiver class. One of the assigned receivers is referred to as the producer receiver (the channel source) and the other is referred to as the consumer receiver (the channel destination).
During its execution a branch attempts to get data from the producer receiver and put data in the consumer receiver. The communication semantics of the producer receiver get() method are dependent upon the model of computation associated with the producer receiver. In cases where a blocking read occurs, the producer receiver registers the block with the calling branch leading to a blocked branch. So that the producer receiver knows which branch to register the block with, a branch always invokes the receiver's get() method by passing itself as an argument. A blocked branch registers the block with the branch controller that it is assigned to.
Putting data in a consumer receiver is symmetrically analogous to getting data from a producer receiver. In cases where a blocking write occurs, the consumer receiver registers the block with the calling branch leading to a blocked branch. So that the consumer receiver knows which branch to register the block with, a branch always invokes the receiver's put() method by passing itself as an argument.
| Red (davisj) |
| Red (davisj) |
| Constructor Summary | |
Branch(BranchController controller)
Deprecated. Use this constructor for testing purposes only. |
|
Branch(ProcessReceiver producerReceiver,
ProcessReceiver consumerReceiver,
BranchController controller)
Construct a branch object with a producer receiver, a consumer receiver and a branch controller. |
|
| Method Summary | |
ProcessReceiver |
getConsReceiver()
Return the consumer receiver that this branch puts data into. |
ProcessReceiver |
getProdReceiver()
Return the producer receiver that this branch gets data from. |
boolean |
isActive()
Return true if this branch is active. |
void |
registerReceiverBlocked(ProcessReceiver receiver)
Register that the receiver controlled by this branch is blocked. |
void |
registerReceiverUnBlocked(ProcessReceiver receiver)
Register that the receiver controlled by this branch is no longer blocked. |
void |
run()
Repeatedly transfer a single token between the producer receiver and the consumer receiver as long as the branch is active or until a TerminateProcessException is thrown. |
void |
setActive(boolean value)
Set a flag indicating this branch is no longer active. |
void |
transferToken()
Transfer a single token from the producer receiver to the consumer receiver. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public Branch(BranchController controller)
throws IllegalActionException
controller - The branch controller assigned to this branch.
public Branch(ProcessReceiver producerReceiver,
ProcessReceiver consumerReceiver,
BranchController controller)
throws IllegalActionException
producerReceiver - The producer receiver assigned to this branch.consumerReceiver - The consumer receiver assigned to this branch.controller - The branch controller assigned to this branch.
IllegalActionException - If the receivers assigned to
this branch are null or improperly configured.| Method Detail |
public ProcessReceiver getConsReceiver()
BoundaryDetectorpublic ProcessReceiver getProdReceiver()
BoundaryDetectorpublic boolean isActive()
public void registerReceiverBlocked(ProcessReceiver receiver)
receiver - The receiver assigned to this branch that
is blocked.public void registerReceiverUnBlocked(ProcessReceiver receiver)
receiver - The receiver assigned to this branch for
which a block is being removed.public void run()
run in interface java.lang.Runnablepublic void setActive(boolean value)
value - A boolean indicating whether this branch is
still active.public void transferToken()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||