Class VCLEndOut

java.lang.Object
   |
   +----VCLEndpoint
           |
           +----VCLEndOut

public class VCLEndOut
extends VCLEndpoint

Class definition for a VCL endpoint which is outbound to a switch port.

Version:: $Revision: 1.9 $, $Date: 2000/10/31 20:32:04 $
Author:: Mike Spengler, Joseph Thomas

forward: A forward link to an externally connected inbound VCL endpoint, if this VCL terminates at another ATM switch.
reverse: A reverse link to the inbound VCL endpoint in this switch which is mapped to this endpoint.
vcc: The completed VCC, if this VCL terminates at an endsystem.

VCLEndOut(SwitchPort, int, int, int): Constructs an outbound VCL endpoint.
VCLEndOut(SwitchPort, int, int, int, int, int): Constructs an outbound VCL endpoint.

clearVCC(): Clears any reference to a VCC for this VCL.
completedVCC(VCLEndIn): Processes a newly constructed VCC path, terminating at this VCL.
delete(): Deletes this VCL.
deleteVCC(): Deletes all VCCs which traverse this VCL.
dumpStateComponent(FIFO): Dumps the current state of this VCL's components.
findOrigin(): Gets the VCL endpoint which is at the origin of the VCC path leading to this VCL.
findTerminus(VCLEndIn): Locates all the termini for VCC paths which traverse this VCL.
getForwardMap(): Gets the forward link to the VCL termination point.
getReverseMap(): Gets the reverse link to the VCL endpoint which is mapped to this endpoint.
getReverseVCC(VCLEndIn): Gets the previously completed VCC, if one exists, whose VCL path is in the reverse direction from the endpoints supplied.
setForwardMap(VCLEndIn): Sets the forward link to the VCL termination point.
setReverseMap(VCLEndIn): Sets the reverse link to the VCL endpoint which is mapped to this endpoint.

forward

 private VCLEndIn forward

A forward link to an externally connected inbound VCL endpoint, if this VCL terminates at another ATM switch.

reverse

 private VCLEndIn reverse

A reverse link to the inbound VCL endpoint in this switch which is mapped to this endpoint.

vcc

 private VCC vcc

The completed VCC, if this VCL terminates at an endsystem.

VCLEndOut

 public VCLEndOut(SwitchPort port,
                  int vpi,
                  int vci,
                  int proto,
                  int uptime,
                  int cells)

Constructs an outbound VCL endpoint.

Parameters:: port - The switch port originating the VCL.; vpi - The VPI.; vci - The VPI.; proto - The switching protocol.; uptime - The VCL uptime.; cells - The output cell count for this VCL.

VCLEndOut

 public VCLEndOut(SwitchPort port,
                  int vpi,
                  int vci,
                  int proto)

Constructs an outbound VCL endpoint.

Parameters:: port - The switch port originating the VCL.; vpi - The VPI.; vci - The VPI.; proto - The switching protocol.

findTerminus

 public void findTerminus(VCLEndIn orig)

Locates all the termini for VCC paths which traverse this VCL. Partial construction of incomplete paths will always take place while traversing towards the terminating endpoints.

Parameters:: orig - the VCL's origin point

findOrigin

 public VCLEndIn findOrigin()

Gets the VCL endpoint which is at the origin of the VCC path leading to this VCL. Partial construction of incomplete paths will always take place while traversing towards the origin endpoint.

Returns:: the origin VCL endpoint which leads to this VCL

completedVCC

 public void completedVCC(VCLEndIn orig)

Processes a newly constructed VCC path, terminating at this VCL.

Parameters:: orig - the VCC's origin point

getReverseVCC

 public VCC getReverseVCC(VCLEndIn orig)

Gets the previously completed VCC, if one exists, whose VCL path is in the reverse direction from the endpoints supplied.

Parameters:: orig - the VCC's origin point
Returns:: the previously completed reverse VCC, or null

delete

 public void delete()

Deletes this VCL.

deleteVCC

 public void deleteVCC()

Deletes all VCCs which traverse this VCL.

getForwardMap

 public VCLEndIn getForwardMap()

Gets the forward link to the VCL termination point.

Returns:: the externally connected VCL endpoint at this VCL's termination

setForwardMap

 public void setForwardMap(VCLEndIn term)

Sets the forward link to the VCL termination point.

Parameters:: term - the VCL's termination point

getReverseMap

 public VCLEndIn getReverseMap()

Gets the reverse link to the VCL endpoint which is mapped to this endpoint.

Returns:: the VCL endpoint which is mapped to this endpoint

setReverseMap

 public void setReverseMap(VCLEndIn in)

Sets the reverse link to the VCL endpoint which is mapped to this endpoint.

Parameters:: in - the VCL endpoint which is mapped to this endpoint

clearVCC

 public void clearVCC()

Clears any reference to a VCC for this VCL.

dumpStateComponent

 public void dumpStateComponent(FIFO f)

Dumps the current state of this VCL's components.

Parameters:: f - where to queue the ModelUpdate objects representing the model's current state