All Packages  This Package  Class Hierarchy  Class Search  Index

Class edu.utah.janos.nodeos.FlowHandle
java.lang.Object
   |
   +----edu.utah.janos.nodeos.FlowHandle

  Summary

public final class  FlowHandle
     extends java.lang.Object
{
          // Fields 2
     final Flow flow;
     final Runnable termHandler;

          // Constructors 1
     FlowHandle(Flow, Runnable);

          // Methods 2
     public void destroy();
     public String toString();
}

Parent's handle on a child flow. Returned from Flow.newFlow().

Author:
Janos Ministry of Development


  Cross Reference

Returned By:
Flow.newFlow()





  Fields

· flow

Summary  |  Top
   final Flow flow

The flow this handle is associated with. Fixed when the FlowHandle is contstructed.


· termHandler

Summary  |  Top
   final Runnable termHandler

TermHandler executed when this flow is termainted. May be null.

XXX why is this here (and not in the Flow proper)?


  Constructors

· FlowHandle

Summary  |  Top

   FlowHandle(Flow flow, 
              Runnable termHandler) 

FlowHandles are created implicitly by a call to Flow.newFlow() and returned.

XXX Why is termHandler kept here?

Parameter Description
flow the flow this handle is associated with
termHandler the handler to invoke when the flow is terminated.



  Methods

· destroy

Summary  |  Top
   public void destroy() 

Destroy the Flow. The termination handler in the parent flow will be invoked.

XXX the existence of this method means that FlowHandle objects must not be made visible to (other) untrusted Flows.

XXX this doesn't work yet.



· toString

Summary  |  Top
   public String toString() 
Overrides:
toString in class Object


All Packages  This Package  Class Hierarchy  Class Search  Index
Freshly brewed Java API Documentation automatically generated with polardoc Version 1.0.7