All Packages  This Package  Class Hierarchy  Class Search  Index

java.lang.Object
   |
   +----edu.utah.janos.nodeos.ProtocolLayer

Summary

public abstract class  ProtocolLayer
     extends java.lang.Object
{
          // Fields 3
     private static Hashtable layers;
     private static int maxPacketLength;
     private static ProtocolLayer.PacketRecycler recycler;

          // Constructors 1
     public ProtocolLayer();

          // Methods 15
     static void attachRecycler(ProtocolLayer.PacketRecycler);
     static void detachRecycler(ProtocolLayer.PacketRecycler);
     static ProtocolLayer findLayer(String);
     static int getMaxPacketLength();
     static void installLayer(ProtocolLayer);
     static void recycle(ProtocolLayer.PacketBuffer);

     abstract void attachGenerator(ProtocolLayer.PacketGenerator);
     abstract void attachHandler(ProtocolLayer.PacketHandler) throws IOException;
     abstract ProtocolLayer.PacketAddress createAddress();
     abstract ProtocolLayer.PacketAddressMask createAddressMask();
     abstract void detachGenerator(ProtocolLayer.PacketGenerator);
     abstract void detachHandler(ProtocolLayer.PacketHandler);
     abstract void generatorReady(ProtocolLayer.PacketGenerator);
     abstract String getID();
     abstract int getPacketLength();

          // Inner Classes 7
     public static class ProtocolLayer.PacketAddressFormatException
     static interface ProtocolLayer.PacketAddress
     static interface ProtocolLayer.PacketAddressMask
     static final class ProtocolLayer.PacketBuffer
     abstract static class ProtocolLayer.PacketHandler
     abstract static class ProtocolLayer.PacketGenerator
     static interface ProtocolLayer.PacketRecycler
}

ProtocolLayer is supposed to act as an abstraction for simulating transport layers. Its made up of several interfaces and classes for moving packets through the layer to their destination.

Cross Reference

Extended By:

UDPLayer

Returned By:

ProtocolLayer.findLayer()

   private static int maxPacketLength

The maximum packet length for all the layers. Since packets are exchanged with users of the layers we have to make packets big enough to accomodate all the different protocol layers.

   private static Hashtable layers

The table of all registered protocol layers.

   private static ProtocolLayer.PacketRecycler recycler

The global packet recycler.

Constructors

· ProtocolLayer

Summary  |  Top

   public ProtocolLayer() 

Default constructor

   static int getMaxPacketLength() 

Return the current value of maxPacketLength.

   static void installLayer(ProtocolLayer pl) 

Install a new protocol layer, basically, this just makes the layer PACKAGEally available.

   static ProtocolLayer findLayer(String id) 

Find an installed protocol layer with the given name.

   static void attachRecycler(ProtocolLayer.PacketRecycler pr) 

   static void recycle(ProtocolLayer.PacketBuffer pb) 

   static void detachRecycler(ProtocolLayer.PacketRecycler pr) 

   abstract String getID() 

Return the string identifier for this protocol layer.

   abstract int getPacketLength() 

Get the maximum packet length for this protocol layer. This is pretty much for internal use only.

   abstract ProtocolLayer.PacketAddress createAddress() 

Create an address object that is compatible with this protocol layer.

   abstract ProtocolLayer.PacketAddressMask createAddressMask() 

Create an address mask object that is compatible with this protocol layer.

   abstract void attachHandler(ProtocolLayer.PacketHandler ph)  throws IOException

Attach a packet handler to the layer. The source mask for the handler determines what packets will be dispatched to the handler.

   abstract void detachHandler(ProtocolLayer.PacketHandler ph) 

Detach a packet handler from the layer.

   abstract void attachGenerator(ProtocolLayer.PacketGenerator pg) 

Attach a packet generator to the layer. The destination of the packet is determined by the destination address object in the packet generator object.

   abstract void generatorReady(ProtocolLayer.PacketGenerator pg) 

Signal that a generator has packets and is ready to be serviced.

   abstract void detachGenerator(ProtocolLayer.PacketGenerator pg) 

Detach a packet generator from the protocol layer.

All Packages  This Package  Class Hierarchy  Class Search  Index