SSF.OS.OSPF
Class Options

java.lang.Object
  |
  +--SSF.OS.OSPF.Options

public class Options
extends java.lang.Object

This class helps OSPF manage run-time options.


Field Summary
static int AS_AREA
          Indicates option to print the AS(es) and area(s) number in which OSPF router is located.
static int AS_NUM
          Indicates option to print the number of the AS in which the OSPF router is located.
static boolean debugging_on
          Whether or not plain debugging messages are turned on.
static int FWD_TABLE
          Indicates option to show info about the local forwarding table.
static int FWDTABLE1
          Indicates that the `fwdtable1' validation test is being performed.
static int FWDTABLE2
          Indicates that the `fwdtable2' validation test is being performed.
static int HELLO
          Indicates option to show when hello packets are sent and received.
static int IFS
          Indicates option to print IP and OSPF interfaces on which the router is running.
static int INTERFACES1
          Indicates that the `interfaces1' validation test is being performed.
static int INTERFACES2
          Indicates that the `interfaces2' validation test is being performed.
static int LSA
          Indicates option to show when LSAs have been sent.
static int LSDB
          Indicates option to show info about the link state database.
static int LSDB1
          Indicates that the `lsdb1' validation test is being performed.
static int LSDB2
          Indicates that the `lsdb2' validation test is being performed.
static int NO_TEST
          Indicates that no validation tests are being performed.
static boolean[] opt
          An array for several boolean debugging attributes/options.
static int ROUTERTYPE1
          Indicates that the `routertype1' validation test is being performed.
static int ROUTERTYPE2
          Indicates that the `routertype2' validation test is being performed.
static int RTR_TYPE
          Indicates option to print router's classification.
static boolean usenhi
          Whether or not to use full NHI addressing.
static int validation_test
          Indicates whether or not this simulation is a validation test (-1 means it isn't, non-negative means it is) and if so, which test number it is.
static boolean wrapup
          Whether or not any wrap-up functions need to be performed at the end of the simulation.
 
Constructor Summary
Options()
           
 
Method Summary
static void config(com.renesys.raceway.DML.Configuration cfg)
          Configures options set with the ospfoptions attribute in DML.
static void debugmsg(sOSPF ospf, int typ, int caseno, int i, int i2, java.lang.Object o, java.lang.Object o2)
          Prints a debugging message.
static void validation_msg(sOSPF ospf, int testnum, int msgnum, java.lang.Object o)
          Prints a message associated with a validation test.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

debugging_on

public static final boolean debugging_on
Whether or not plain debugging messages are turned on. Error and warning messages are always turned on. In order to run an efficient simulation, this code should be changed manually to set debugging_on to false and then recompiled.

See Also:
Constant Field Values

IFS

public static final int IFS
Indicates option to print IP and OSPF interfaces on which the router is running.

See Also:
Constant Field Values

AS_NUM

public static final int AS_NUM
Indicates option to print the number of the AS in which the OSPF router is located.

See Also:
Constant Field Values

AS_AREA

public static final int AS_AREA
Indicates option to print the AS(es) and area(s) number in which OSPF router is located. (Area numbers are not yet available.)

See Also:
Constant Field Values

RTR_TYPE

public static final int RTR_TYPE
Indicates option to print router's classification.

See Also:
Constant Field Values

HELLO

public static final int HELLO
Indicates option to show when hello packets are sent and received. (Currently not implemented.)

See Also:
Constant Field Values

LSA

public static final int LSA
Indicates option to show when LSAs have been sent.

See Also:
Constant Field Values

LSDB

public static final int LSDB
Indicates option to show info about the link state database.

See Also:
Constant Field Values

FWD_TABLE

public static final int FWD_TABLE
Indicates option to show info about the local forwarding table.

See Also:
Constant Field Values

NO_TEST

public static final int NO_TEST
Indicates that no validation tests are being performed.

See Also:
Constant Field Values

ROUTERTYPE1

public static final int ROUTERTYPE1
Indicates that the `routertype1' validation test is being performed.

See Also:
Constant Field Values

INTERFACES1

public static final int INTERFACES1
Indicates that the `interfaces1' validation test is being performed.

See Also:
Constant Field Values

LSDB1

public static final int LSDB1
Indicates that the `lsdb1' validation test is being performed.

See Also:
Constant Field Values

FWDTABLE1

public static final int FWDTABLE1
Indicates that the `fwdtable1' validation test is being performed.

See Also:
Constant Field Values

ROUTERTYPE2

public static final int ROUTERTYPE2
Indicates that the `routertype2' validation test is being performed.

See Also:
Constant Field Values

INTERFACES2

public static final int INTERFACES2
Indicates that the `interfaces2' validation test is being performed.

See Also:
Constant Field Values

LSDB2

public static final int LSDB2
Indicates that the `lsdb2' validation test is being performed.

See Also:
Constant Field Values

FWDTABLE2

public static final int FWDTABLE2
Indicates that the `fwdtable2' validation test is being performed.

See Also:
Constant Field Values

usenhi

public static boolean usenhi
Whether or not to use full NHI addressing. Using it means that AS numbers, IP prefixes and IP addresses will be converted to NHI addresses in output whenever possible.


opt

public static boolean[] opt
An array for several boolean debugging attributes/options.


wrapup

public static boolean wrapup
Whether or not any wrap-up functions need to be performed at the end of the simulation. It is true only if at least one of the dump options has been set.


validation_test

public static int validation_test
Indicates whether or not this simulation is a validation test (-1 means it isn't, non-negative means it is) and if so, which test number it is.

Constructor Detail

Options

public Options()
Method Detail

config

public static void config(com.renesys.raceway.DML.Configuration cfg)
                   throws com.renesys.raceway.DML.configException
Configures options set with the ospfoptions attribute in DML. All such options are "global" OSPF options--that is, they apply to all instances of OSPF in the simulation.

Parameters:
cfg - Contains attribute-value pairs for each configurable OSPF option attribute
Throws:
com.renesys.raceway.DML.configException - if any of the calls to find or findSingle throw such an exception.

debugmsg

public static void debugmsg(sOSPF ospf,
                            int typ,
                            int caseno,
                            int i,
                            int i2,
                            java.lang.Object o,
                            java.lang.Object o2)
Prints a debugging message.

Parameters:
ospf - The OSPF instance associated with the message.
typ - Indicates the type of situation that the message is reporting on.
caseno - A case number, applicable to certain message types.
i - Numeric data whose meaning varies depending on msg type.
i2 - Numeric data whose meaning varies depending on msg type.
o - An object whose meaning varies depending on msg type.
o2 - An object whose meaning varies depending on msg type.

validation_msg

public static void validation_msg(sOSPF ospf,
                                  int testnum,
                                  int msgnum,
                                  java.lang.Object o)
Prints a message associated with a validation test.

Parameters:
ospf - The OSPF instance that the message is associated with.
testnum - The indicative validation test number.
msgnum - Specifies which message should be printed.
o - An object whose meaning varies depending on which test and which message are specified.