sime

Class NetworkElement

java.lang.Object

sime.NetworkElement

Direct Known Subclasses:

Endpoint, Link, Router

public abstract class NetworkElement
extends java.lang.Object

The interface for simulated network elements (nodes and links).
Provides two universal methods: send(NetworkElement, Packet) for downcall and handle(NetworkElement, Packet) for upcall, from components that are above or below this component in the protocol stack.

Author:

Ivan Marsic

Field Summary

Fields

Modifier and Type	Field and Description
protected double	lastTimeProcessCalled Indicates when the last time the method process(int) was called, so that the Link knows how much time elapsed since the last call.
(package private) java.lang.String	name The given name of this network element, used mostly for reporting/debugging purposes.
protected Simulator	simulator Object that provides the runtime environment, mainly stuff related to the simulation clock, such as timer management and the reference time.

Constructor Summary

Constructors

Constructor and Description
NetworkElement(Simulator simulator_, java.lang.String name_)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getName() Attribute getter.
Simulator	getSimulator() Getter method.
abstract void	handle(NetworkElement source_, Packet packet_) The method to receive packets from a lower-layer protocol.
abstract void	process(int mode_) The method used by the simulator to signal the passage of time to this network element.
abstract void	send(NetworkElement source_, Packet packet_) The method to send data from an upper-layer protocol. Note that parameter source_ is usually ignored but Link.send(NetworkElement, Packet) uses it to distinguish the nodes connected to its ends.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

lastTimeProcessCalled

protected double lastTimeProcessCalled

Indicates when the last time the method process(int) was called, so that the Link knows how much time elapsed since the last call.

name

java.lang.String name

The given name of this network element, used mostly for reporting/debugging purposes.

simulator

protected Simulator simulator

Object that provides the runtime environment, mainly stuff related to the simulation clock, such as timer management and the reference time.

Constructor Detail

NetworkElement

public NetworkElement(Simulator simulator_,
              java.lang.String name_)

Method Detail

getName

public java.lang.String getName()

Attribute getter.

Returns:

the name given to this network element

See Also:

name

getSimulator

public Simulator getSimulator()

Getter method.

Returns:

the simulator runtime environment

handle

public abstract void handle(NetworkElement source_,
          Packet packet_)

The method to receive packets from a lower-layer protocol.

Parameters:

source_ - the immediate source network element that passes this packet; which may not be the original source that generated this packet

packet_ - a packet to receive from below and process

process

public abstract void process(int mode_)

The method used by the simulator to signal the passage of time to this network element. The element then needs to do the work appropriate for the amount of time elapsed since the previous call to this method (lastTimeProcessCalled).

Parameters:

mode_ - the processing mode, depends on the actual network element

See Also:

Simulator.run(java.nio.ByteBuffer, int)

send

public abstract void send(NetworkElement source_,
        Packet packet_)

The method to send data from an upper-layer protocol.
Note that parameter source_ is usually ignored but Link.send(NetworkElement, Packet) uses it to distinguish the nodes connected to its ends.

Parameters:

source_ - the immediate source network element that sends this packet; note that this may not be the original source that generated this packet, but rather a router that simply relays someone else's packet

packet_ - a packet from above to transmit