JNodeOS v1.1.5 API

edu.utah.janos.nodeos
Class FlowHandle

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

public final class FlowHandle
extends edu.utah.janos.nodeos.pj_FlowHandle

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

The FlowHandle is many-to-one and fixed with a child Flow. The particulars of this "cross-flow pointer" are implemented in the native FlowHandle.

Author:
Janos Ministry of Development
See Also:
Flow, Flow.newFlow(Credentials,ThreadPoolSpec,MemSpec,FlowStartSpec,Runnable)

Method Summary
 void destroy()
          Destroy the Flow.
 boolean getInChannelStats(int index, ChanStats cs)
          Get the statistics for an in channel in the flow.
 boolean getOutChannelStats(int index, ChanStats cs)
          Similar to the above except for out channels.
 void getStats(FlowStats fs)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getStats

public void getStats(FlowStats fs)
Parameters:
fs - An object to hold the flow statistics.

getInChannelStats

public boolean getInChannelStats(int index,
                                 ChanStats cs)
Get the statistics for an in channel in the flow. InChannels don't really have a `name' attached to them so we address them with instance numbers. Typically, if a parent flow was interested in what the children were doing it would increment the instance number until the function returned false, indicating that there weren't anymore channels.
Parameters:
index - An in channel instance to get stats from.
cs - The object that will hold the channels stats.
Returns:
True if the channel existed, false otherwise.

getOutChannelStats

public boolean getOutChannelStats(int index,
                                  ChanStats cs)
Similar to the above except for out channels.
Parameters:
index - An out channel instance to get stats from.
cs - The object that will hold the channels stats.
Returns:
True if the channel existed, false otherwise.

destroy

public void destroy()
Destroy the Flow. The termination handler in the parent flow (this flow) will be invoked.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

JNodeOS v1.1.5 API

This documentation is Copyright (C) 1998-2001 The University of Utah. All Rights Reserved. See the file LICENSE for distribution terms.
Documentation, software, and mailing list archives for Janos can be found at the Janos Project: http://www.cs.utah.edu/flux/janos/