All Packages  This Package  Class Hierarchy  Class Search  Index

Class edu.utah.janos.antsr.core.MIDIDResponseCapsule
java.lang.Object
   |
   +----edu.utah.janos.antsr.core.Capsule
           |
           +----edu.utah.janos.antsr.core.MIDIDResponseCapsule

  Summary

class  MIDIDResponseCapsule
     extends edu.utah.janos.antsr.core.Capsule
{
          // Fields 7
     private static final byte[] MID;
     private static final byte[] PID;
     public static final String VERSION;
     private TypeID gid;
     private TypeID pid;
     private TypeID requestMID;
     private UserID userInfo;

          // Constructors 2
     MIDIDResponseCapsule();
     MIDIDResponseCapsule(int, TypeID, TypeID, TypeID, UserID);

          // Methods 7
     public Xdr decode();
     public Xdr encode();
     public boolean evaluate(Node);
     public int length();
     protected byte[] mid();
     protected byte[] pid();
     public String toString();
}

MID ID Response Capule.

MIDIDResponseCapsules are only created by a MIDIDRequestCapsule that has been delivered to a node that can satisfy the request. MIDIDResponseCapsules contain information describing the MID.

A MIDIDResponseCapsule packet contains the following fields (on top of the base Capsule fields):

See Also: DLProtocol, MIDIDRequestCapsule, CodeGroup




  Fields

· VERSION

Summary  |  Top

   public static final String VERSION


· MID

Summary  |  Top
   private static final byte[] MID


· PID

Summary  |  Top
   private static final byte[] PID


· requestMID

Summary  |  Top
   private TypeID requestMID

The MID that initiated the request.


· pid

Summary  |  Top
   private TypeID pid

PID associated with the requestMID.


· gid

Summary  |  Top
   private TypeID gid

GID associated with the requestMID.


· userInfo

Summary  |  Top
   private UserID userInfo

User information associated with the PID.


  Constructors

· MIDIDResponseCapsule

Summary  |  Top

   MIDIDResponseCapsule() 

Construct a blank MIDIDResponseCapsule.

This is only invoked when a MIDIDResponseCapsule capsule is received at a node and the node must construct a capsule before decoding the packet into it.



· MIDIDResponseCapsule

Summary  |  Top
   MIDIDResponseCapsule(int dst, 
                        TypeID unknownMID, 
                        TypeID pid, 
                        TypeID gid, 
                        UserID userInfo) 

Construct a MIDIDResponseCapsule to send back in response to a MIDIDRequestCapsule. Only invoked by MIDIDRequestCapsule.evaluate().

See Also: evaluate



  Methods

· mid

Summary  |  Top
   protected byte[] mid() 
Overrides:
mid in class Capsule


· pid

Summary  |  Top
   protected byte[] pid() 
Overrides:
pid in class Capsule


· length

Summary  |  Top
   public int length() 
Overrides:
length in class Capsule


· encode

Summary  |  Top
   public Xdr encode() 
Overrides:
encode in class Capsule


· decode

Summary  |  Top
   public Xdr decode() 
Overrides:
decode in class Capsule


· evaluate

Summary  |  Top
   public boolean evaluate(Node node) 

Evalute a MIDIDResponseCapsule at this node.

XXX should deal with unanticipated MIDIDResponseCapsules better.

Overrides:
evaluate in class Capsule


· toString

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


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