ANTS v2.0 API

ants.core
Class ProtocolBooster

java.lang.Object
  |
  +--edu.utah.janos.nodeos.FlowRun
        |
        +--ants.core.Booster
              |
              +--ants.core.ProtocolBooster

public class ProtocolBooster
extends ants.core.Booster

Must be public as its the entrypoint for a new flow from the Java NodeOS.

This is invoked by PrimordialNode as the intial class in a new flow. This new flow is charged with taking the new (unknown protocol) PID, requesting and loading the code associated with that PID and then processing any enqueued packets.

Protocol's have a restricted namespace. See the exportedAntsClasses list in PrimordialNode.

Author:
Utah Janos Team
See Also:
AppBooster, PrimordialNode#fireUpNewProtocolFlow(TypeID,CommQueuePusher)

Field Summary
static int APP_CAPSULE
          Indicates an application capsule is queued up.
static int LOCAL_PROTOCOL
          Indicates a local protocol should be instantiated, the only argument is the name of the protocol class.
static int NEW_MID
          Indicates a new MID, arguments are the MID bytes and the previous node that the packet was at.
 
Constructor Summary
ProtocolBooster(edu.utah.janos.nodeos.ClassInstantiationKey key)
           
 
Method Summary
 void run(edu.utah.janos.nodeos.Flow flow, java.lang.String[] args, edu.utah.janos.nodeos.CommSpaceHandle commSpaceHandle)
          The entrypoint invoked in the context of the new flow.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NEW_MID

public static final int NEW_MID
Indicates a new MID, arguments are the MID bytes and the previous node that the packet was at.

LOCAL_PROTOCOL

public static final int LOCAL_PROTOCOL
Indicates a local protocol should be instantiated, the only argument is the name of the protocol class. Once this executes the protocol message handler thread is basically useless since the whole protocol is active.

APP_CAPSULE

public static final int APP_CAPSULE
Indicates an application capsule is queued up. Application capsules are queued here if they arrive before a new protocol is completely set up.
Constructor Detail

ProtocolBooster

public ProtocolBooster(edu.utah.janos.nodeos.ClassInstantiationKey key)
                throws java.lang.SecurityException
Method Detail

run

public void run(edu.utah.janos.nodeos.Flow flow,
                java.lang.String[] args,
                edu.utah.janos.nodeos.CommSpaceHandle commSpaceHandle)
The entrypoint invoked in the context of the new flow.

ANTS v2.0 API

This documentation is Copyright (C) 1998-2001 The University of Utah and the University of Washington. All Rights Reserved. See the individual source files for distribution terms.
Documentation, software, and mailing lists for ANTS v2.0 can be found at the Janos Project: http://www.cs.utah.edu/flux/janos/