Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions

ns3::Ipv4L3Protocol Class Reference

Implement the Ipv4 layer. More...

#include <ipv4-l3-protocol.h>

Inheritance diagram for ns3::Ipv4L3Protocol:
Inheritance graph
[legend]
Collaboration diagram for ns3::Ipv4L3Protocol:
Collaboration graph
[legend]

List of all members.

Public Types

enum  DropReason {
  DROP_TTL_EXPIRED = 1, DROP_NO_ROUTE, DROP_BAD_CHECKSUM, DROP_INTERFACE_DOWN,
  DROP_ROUTE_ERROR
}
 

Reason why a packet has been dropped.

More...

Public Member Functions

void SetRoutingProtocol (Ptr< Ipv4RoutingProtocol > routingProtocol)
 Register a new routing protocol to be used by this Ipv4 stack.
Ptr< Ipv4RoutingProtocol > GetRoutingProtocol (void) const
 Get the routing protocol to be used by this Ipv4 stack.
void Insert (Ptr< Ipv4L4Protocol > protocol)
Ptr< Ipv4L4Protocol > GetProtocol (int protocolNumber) const
void Remove (Ptr< Ipv4L4Protocol > protocol)
void SetDefaultTtl (uint8_t ttl)
void Receive (Ptr< NetDevice > device, Ptr< const Packet > p, uint16_t protocol, const Address &from, const Address &to, NetDevice::PacketType packetType)
void Send (Ptr< Packet > packet, Ipv4Address source, Ipv4Address destination, uint8_t protocol, Ptr< Ipv4Route > route)
uint32_t AddInterface (Ptr< NetDevice > device)
uint32_t GetNInterfaces (void) const
int32_t GetInterfaceForAddress (Ipv4Address addr) const
 Return the interface number of the interface that has been assigned the specified IP address.
int32_t GetInterfaceForPrefix (Ipv4Address addr, Ipv4Mask mask) const
 Return the interface number of first interface found that has an Ipv4 address within the prefix specified by the input address and mask parameters.
int32_t GetInterfaceForDevice (Ptr< const NetDevice > device) const
bool AddAddress (uint32_t i, Ipv4InterfaceAddress address)
Ipv4InterfaceAddress GetAddress (uint32_t interfaceIndex, uint32_t addressIndex) const
uint32_t GetNAddresses (uint32_t interface) const
bool RemoveAddress (uint32_t interfaceIndex, uint32_t addressIndex)
void SetMetric (uint32_t i, uint16_t metric)
uint16_t GetMetric (uint32_t i) const
uint16_t GetMtu (uint32_t i) const
bool IsUp (uint32_t i) const
void SetUp (uint32_t i)
void SetDown (uint32_t i)
bool IsForwarding (uint32_t i) const
void SetForwarding (uint32_t i, bool val)
Ptr< NetDevice > GetNetDevice (uint32_t i)

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::Ipv4L3Protocol.

Protected Member Functions

virtual void DoDispose (void)
virtual void NotifyNewAggregate ()

Detailed Description

Implement the Ipv4 layer.

This is the actual implementation of IP. It contains APIs to send and receive packets at the IP layer, as well as APIs for IP routing.

This class contains two distinct groups of trace sources. The trace sources 'Rx' and 'Tx' are called, respectively, immediately after receiving from the NetDevice and immediately before sending to a NetDevice for transmitting a packet. These are low level trace sources that include the Ipv4Header already serialized into the packet. In contrast, the Drop, SendOutgoing, UnicastForward, and LocalDeliver trace sources are slightly higher-level and pass around the Ipv4Header as an explicit parameter and not as part of the packet.

Member Enumeration Documentation

enum ns3::Ipv4L3Protocol::DropReason

Reason why a packet has been dropped.

Enumerator:
DROP_TTL_EXPIRED 

Packet TTL has expired

DROP_NO_ROUTE 

No route to host

DROP_BAD_CHECKSUM 

Bad checksum

DROP_INTERFACE_DOWN 

Interface is down so can not send packet

DROP_ROUTE_ERROR 

Route error

Member Function Documentation

bool ns3::Ipv4L3Protocol::AddAddress ( uint32_t  interface,
Ipv4InterfaceAddress  address 
) [virtual]
Parameters:
interface Interface number of an Ipv4 interface
address Ipv4InterfaceAddress address to associate with the underlying Ipv4 interface
Returns:
true if the operation succeeded

Implements ns3::Ipv4.

uint32_t ns3::Ipv4L3Protocol::AddInterface ( Ptr< NetDevice >  device  )  [virtual]
Parameters:
device device to add to the list of Ipv4 interfaces which can be used as output interfaces during packet forwarding.
Returns:
the index of the Ipv4 interface added.

Once a device has been added, it can never be removed: if you want to disable it, you can invoke Ipv4::SetDown which will make sure that it is never used during packet forwarding.

Implements ns3::Ipv4.

virtual void ns3::Ipv4L3Protocol::DoDispose ( void   )  [protected, virtual]

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

Reimplemented from ns3::Object.

Ipv4InterfaceAddress ns3::Ipv4L3Protocol::GetAddress ( uint32_t  interface,
uint32_t  addressIndex 
) const [virtual]

Because addresses can be removed, the addressIndex is not guaranteed to be static across calls to this method.

Parameters:
interface Interface number of an Ipv4 interface
addressIndex index of Ipv4InterfaceAddress
Returns:
the Ipv4InterfaceAddress associated to the interface and addresIndex

Implements ns3::Ipv4.

int32_t ns3::Ipv4L3Protocol::GetInterfaceForAddress ( Ipv4Address  address  )  const [virtual]

Return the interface number of the interface that has been assigned the specified IP address.

Parameters:
address The IP address being searched for
Returns:
The interface number of the Ipv4 interface with the given address or -1 if not found.

Each IP interface has one or more IP addresses associated with it. This method searches the list of interfaces for one that holds a particular address. This call takes an IP address as a parameter and returns the interface number of the first interface that has been assigned that address, or -1 if not found. There must be an exact match.

Implements ns3::Ipv4.

int32_t ns3::Ipv4L3Protocol::GetInterfaceForDevice ( Ptr< const NetDevice >  device  )  const [virtual]
Parameters:
device The NetDevice for an Ipv4Interface
Returns:
The interface number of an Ipv4 interface or -1 if not found.

Implements ns3::Ipv4.

int32_t ns3::Ipv4L3Protocol::GetInterfaceForPrefix ( Ipv4Address  address,
Ipv4Mask  mask 
) const [virtual]

Return the interface number of first interface found that has an Ipv4 address within the prefix specified by the input address and mask parameters.

Parameters:
address The IP address assigned to the interface of interest.
mask The IP prefix to use in the mask
Returns:
The interface number of the Ipv4 interface with the given address or -1 if not found.

Each IP interface has one or more IP addresses associated with it. This method searches the list of interfaces for the first one found that holds an address that is included within the prefix formed by the input address and mask parameters. The value -1 is returned if no match is found.

Implements ns3::Ipv4.

uint16_t ns3::Ipv4L3Protocol::GetMetric ( uint32_t  interface  )  const [virtual]
Parameters:
interface The interface number of an Ipv4 interface
Returns:
routing metric (cost) associated to the underlying Ipv4 interface

Implements ns3::Ipv4.

uint16_t ns3::Ipv4L3Protocol::GetMtu ( uint32_t  interface  )  const [virtual]
Parameters:
interface Interface number of Ipv4 interface
Returns:
the Maximum Transmission Unit (in bytes) associated to the underlying Ipv4 interface

Implements ns3::Ipv4.

uint32_t ns3::Ipv4L3Protocol::GetNAddresses ( uint32_t  interface  )  const [virtual]
Parameters:
interface Interface number of an Ipv4 interface
Returns:
the number of Ipv4InterfaceAddress entries for the interface.

Implements ns3::Ipv4.

Ptr<NetDevice> ns3::Ipv4L3Protocol::GetNetDevice ( uint32_t  interface  )  [virtual]
Parameters:
interface The interface number of an Ipv4 interface.
Returns:
The NetDevice associated with the Ipv4 interface number.

Implements ns3::Ipv4.

uint32_t ns3::Ipv4L3Protocol::GetNInterfaces ( void   )  const [virtual]
Returns:
the number of interfaces added by the user.

Implements ns3::Ipv4.

Ptr<Ipv4L4Protocol> ns3::Ipv4L3Protocol::GetProtocol ( int  protocolNumber  )  const
Parameters:
protocolNumber number of protocol to lookup in this L4 Demux
Returns:
a matching L4 Protocol

This method is typically called by lower layers to forward packets up the stack to the right protocol. It is also called from NodeImpl::GetUdp for example.

Ptr<Ipv4RoutingProtocol> ns3::Ipv4L3Protocol::GetRoutingProtocol ( void   )  const [virtual]

Get the routing protocol to be used by this Ipv4 stack.

Returns:
smart pointer to Ipv4RoutingProtocol object, or null pointer if none

Implements ns3::Ipv4.

static TypeId ns3::Ipv4L3Protocol::GetTypeId ( void   )  [static]

This method returns the TypeId associated to ns3::Ipv4L3Protocol.

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/$ns3::Ipv4L3Protocol

Attributes defined for this type:

Attributes defined in parent class ns3::Ipv4:

  • IpForward: Globally enable or disable IP forwarding for all current and future Ipv4 devices.
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read

TraceSources defined for this type:

  • Tx: Send ipv4 packet to outgoing interface.
  • Rx: Receive ipv4 packet from incoming interface.
  • Drop: Drop ipv4 packet
  • SendOutgoing: A newly-generated packet by this node is about to be queued for transmission
  • UnicastForward: A unicast IPv4 packet was received by this node and is being forwarded to another node
  • LocalDeliver: An IPv4 packet was received by/for this node, and it is being forward up the stack

Reimplemented from ns3::Ipv4.

void ns3::Ipv4L3Protocol::Insert ( Ptr< Ipv4L4Protocol >  protocol  ) 
Parameters:
protocol a template for the protocol to add to this L4 Demux.
Returns:
the L4Protocol effectively added.

Invoke Copy on the input template to get a copy of the input protocol which can be used on the Node on which this L4 Demux is running. The new L4Protocol is registered internally as a working L4 Protocol and returned from this method. The caller does not get ownership of the returned pointer.

bool ns3::Ipv4L3Protocol::IsForwarding ( uint32_t  interface  )  const [virtual]
Parameters:
interface Interface number of Ipv4 interface
Returns:
true if IP forwarding enabled for input datagrams on this device

Implements ns3::Ipv4.

bool ns3::Ipv4L3Protocol::IsUp ( uint32_t  interface  )  const [virtual]
Parameters:
interface Interface number of Ipv4 interface
Returns:
true if the underlying interface is in the "up" state, false otherwise.

Implements ns3::Ipv4.

virtual void ns3::Ipv4L3Protocol::NotifyNewAggregate (  )  [protected, virtual]

This function will notify other components connected to the node that a new stack member is now connected This will be used to notify Layer 3 protocol of layer 4 protocol stack to connect them together.

Reimplemented from ns3::Object.

void ns3::Ipv4L3Protocol::Receive ( Ptr< NetDevice >  device,
Ptr< const Packet >  p,
uint16_t  protocol,
const Address &  from,
const Address &  to,
NetDevice::PacketType  packetType 
)

Lower layer calls this method after calling L3Demux::Lookup The ARP subclass needs to know from which NetDevice this packet is coming to:

  • implement a per-NetDevice ARP cache
  • send back arp replies on the right device
    Parameters:
    device network device
    p the packet
    protocol protocol value
    from address of the correspondant
    to address of the destination
    packetType type of the packet
void ns3::Ipv4L3Protocol::Remove ( Ptr< Ipv4L4Protocol >  protocol  ) 
Parameters:
protocol protocol to remove from this demux.

The input value to this method should be the value returned from the Ipv4L4Protocol::Insert method.

bool ns3::Ipv4L3Protocol::RemoveAddress ( uint32_t  interface,
uint32_t  addressIndex 
) [virtual]

Remove the address at addressIndex on named interface. The addressIndex for all higher indices will decrement by one after this method is called; so, for example, to remove 5 addresses from an interface i, one could call RemoveAddress (i, 0); 5 times.

Parameters:
interface Interface number of an Ipv4 interface
addressIndex index of Ipv4InterfaceAddress to remove
Returns:
true if the operation succeeded

Implements ns3::Ipv4.

void ns3::Ipv4L3Protocol::Send ( Ptr< Packet >  packet,
Ipv4Address  source,
Ipv4Address  destination,
uint8_t  protocol,
Ptr< Ipv4Route >  route 
)
Parameters:
packet packet to send
source source address of packet
destination address of packet
protocol number of packet
route route entry

Higher-level layers call this method to send a packet down the stack to the MAC and PHY layers.

void ns3::Ipv4L3Protocol::SetDefaultTtl ( uint8_t  ttl  ) 
Parameters:
ttl default ttl to use

When we need to send an ipv4 packet, we use this default ttl value.

void ns3::Ipv4L3Protocol::SetDown ( uint32_t  interface  )  [virtual]
Parameters:
interface Interface number of Ipv4 interface

Set the interface into the "down" state. In this state, it is ignored during Ipv4 forwarding.

Implements ns3::Ipv4.

void ns3::Ipv4L3Protocol::SetForwarding ( uint32_t  interface,
bool  val 
) [virtual]
Parameters:
interface Interface number of Ipv4 interface
val Value to set the forwarding flag

If set to true, IP forwarding is enabled for input datagrams on this device

Implements ns3::Ipv4.

void ns3::Ipv4L3Protocol::SetMetric ( uint32_t  interface,
uint16_t  metric 
) [virtual]
Parameters:
interface The interface number of an Ipv4 interface
metric routing metric (cost) associated to the underlying Ipv4 interface

Implements ns3::Ipv4.

void ns3::Ipv4L3Protocol::SetRoutingProtocol ( Ptr< Ipv4RoutingProtocol >  routingProtocol  )  [virtual]

Register a new routing protocol to be used by this Ipv4 stack.

This call will replace any routing protocol that has been previously registered. If you want to add multiple routing protocols, you must add them to a Ipv4ListRoutingProtocol directly.

Parameters:
routingProtocol smart pointer to Ipv4RoutingProtocol object

Implements ns3::Ipv4.

void ns3::Ipv4L3Protocol::SetUp ( uint32_t  interface  )  [virtual]
Parameters:
interface Interface number of Ipv4 interface

Set the interface into the "up" state. In this state, it is considered valid during Ipv4 forwarding.

Implements ns3::Ipv4.

The documentation for this class was generated from the following files:
Generated on Sat Apr 23 2011 14:56:50 for NS-3 by  doxygen 1.7.1