A Discrete-Event Network Simulator
API
Network

This section documents the API of the ns-3 network module. More...

+ Collaboration diagram for Network:

Modules

 Address
 Network Address abstractions, including MAC, IPv4 and IPv6.
 
 Channel
 
 Data Rate
 
 Error Model
 
 Network Device
 
 Network module unit tests
 
 Packet
 
 Packet Performance
 The current implementation of the byte buffers and tag list is based on COW (Copy On Write.
 
 Queue
 
 Queue size
 
 Socket
 

Classes

class  ns3::ChannelList
 the list of simulation channels. More...
 
class  ns3::ChannelListPriv
 private implementation detail of the ChannelList API. More...
 
class  ns3::DynamicQueueLimits
 DynamicQueueLimits would be used in conjunction with a producer/consumer type queue (possibly a netdevice queue). More...
 
class  ns3::EthernetHeader
 Packet header for Ethernet. More...
 
class  ns3::EthernetTrailer
 Packet trailer for Ethernet. More...
 
class  ns3::LlcSnapHeader
 Header for the LLC/SNAP encapsulation. More...
 
class  ns3::Mac8Address
 A class used for addressing MAC8 MAC's. More...
 
class  MyHeader
 A simple example of an Header implementation. More...
 
class  MyTag
 A simple example of an Tag implementation. More...
 
class  ns3::Node
 A network Node. More...
 
class  ns3::NodeList
 the list of simulation nodes. More...
 
class  ns3::NodeListPriv
 private implementation detail of the NodeList API. More...
 
class  ns3::QueueDiscItem
 QueueDiscItem is the abstract base class for items that are stored in a queue disc. More...
 
class  ns3::QueueLimits
 Abstract base class for NetDevice queue length controller. More...
 
class  ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >
 Generic "sequence number" class. More...
 

Typedefs

typedef SequenceNumber< uint16_t, int16_t > ns3::SequenceNumber16
 16 bit Sequence number. More...
 
typedef SequenceNumber< uint32_t, int32_t > ns3::SequenceNumber32
 32 bit Sequence number. More...
 
typedef void(* ns3::TracedValueCallback::SequenceNumber32) (SequenceNumber32 oldValue, SequenceNumber32 newValue)
 TracedValue callback signature for SequenceNumber32. More...
 
typedef SequenceNumber< uint8_t, int8_t > ns3::SequenceNumber8
 8 bit Sequence number. More...
 

Enumerations

enum  ns3::ethernet_header_t { ns3::LENGTH, ns3::VLAN, ns3::QINQ }
 Types of ethernet packets. More...
 

Detailed Description

This section documents the API of the ns-3 network module.

For a generic functional description, please refer to the ns-3 manual.

Typedef Documentation

typedef SequenceNumber<uint16_t, int16_t> ns3::SequenceNumber16

16 bit Sequence number.

Definition at line 478 of file sequence-number.h.

typedef SequenceNumber<uint32_t, int32_t> ns3::SequenceNumber32

32 bit Sequence number.

Definition at line 473 of file sequence-number.h.

typedef void(* ns3::TracedValueCallback::SequenceNumber32) (SequenceNumber32 oldValue, SequenceNumber32 newValue)

TracedValue callback signature for SequenceNumber32.

Parameters
[in]oldValueoriginal value of the traced variable
[in]newValuenew value of the traced variable

Definition at line 494 of file sequence-number.h.

typedef SequenceNumber<uint8_t, int8_t> ns3::SequenceNumber8

8 bit Sequence number.

Definition at line 483 of file sequence-number.h.

Enumeration Type Documentation

Types of ethernet packets.

Indicates the type of the current header.

Enumerator
LENGTH 

Basic ethernet packet, no tags, type/length field indicates packet length or IP/ARP packet.

VLAN 

Single tagged packet.

Header includes VLAN tag

QINQ 

Double tagged packet.

Header includes two VLAN tags

Definition at line 36 of file ethernet-header.h.