A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::dsdv::QueueEntry Class Reference

DSDV Queue Entry. More...

#include "dsdv-packet-queue.h"

+ Collaboration diagram for ns3::dsdv::QueueEntry:

Public Types

typedef Ipv4RoutingProtocol::ErrorCallback ErrorCallback
 Error callback function typedef.
 
typedef Ipv4RoutingProtocol::UnicastForwardCallback UnicastForwardCallback
 Unicast forward call back function typedef.
 

Public Member Functions

 QueueEntry (Ptr< const Packet > pa=nullptr, const Ipv4Header &h=Ipv4Header(), UnicastForwardCallback ucb=UnicastForwardCallback(), ErrorCallback ecb=ErrorCallback())
 c-tor
 
ErrorCallback GetErrorCallback () const
 Get error callback function.
 
Time GetExpireTime () const
 Get expire time.
 
Ipv4Header GetIpv4Header () const
 Get IP header.
 
Ptr< const PacketGetPacket () const
 Get packet.
 
UnicastForwardCallback GetUnicastForwardCallback () const
 Get unicast forward callback function.
 
bool operator== (const QueueEntry &o) const
 Compare queue entries.
 
void SetErrorCallback (ErrorCallback ecb)
 Set error callback function.
 
void SetExpireTime (Time exp)
 Set expire time.
 
void SetIpv4Header (Ipv4Header h)
 Set IP header.
 
void SetPacket (Ptr< const Packet > p)
 Set packet.
 
void SetUnicastForwardCallback (UnicastForwardCallback ucb)
 Set unicast forward callback function.
 

Private Attributes

ErrorCallback m_ecb
 Error callback.
 
Time m_expire
 Expire time for queue entry.
 
Ipv4Header m_header
 IP header.
 
Ptr< const Packetm_packet
 Data packet.
 
UnicastForwardCallback m_ucb
 Unicast forward callback.
 

Detailed Description

DSDV Queue Entry.

Definition at line 36 of file dsdv-packet-queue.h.

Member Typedef Documentation

◆ ErrorCallback

Error callback function typedef.

Definition at line 42 of file dsdv-packet-queue.h.

◆ UnicastForwardCallback

Unicast forward call back function typedef.

Definition at line 40 of file dsdv-packet-queue.h.

Constructor & Destructor Documentation

◆ QueueEntry()

ns3::dsdv::QueueEntry::QueueEntry ( Ptr< const Packet > pa = nullptr,
const Ipv4Header & h = Ipv4Header(),
UnicastForwardCallback ucb = UnicastForwardCallback(),
ErrorCallback ecb = ErrorCallback() )
inline

c-tor

Parameters
pathe packet to create the entry
hthe Ipv4Header
ucbthe UnicastForwardCallback function
ecbthe ErrorCallback function

Definition at line 52 of file dsdv-packet-queue.h.

Member Function Documentation

◆ GetErrorCallback()

ErrorCallback ns3::dsdv::QueueEntry::GetErrorCallback ( ) const
inline

Get error callback function.

Returns
the error callback

Definition at line 99 of file dsdv-packet-queue.h.

References m_ecb.

◆ GetExpireTime()

Time ns3::dsdv::QueueEntry::GetExpireTime ( ) const
inline

Get expire time.

Returns
the expire time

Definition at line 162 of file dsdv-packet-queue.h.

References m_expire, and ns3::Simulator::Now().

Referenced by ns3::dsdv::IsExpired::operator()().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetIpv4Header()

Ipv4Header ns3::dsdv::QueueEntry::GetIpv4Header ( ) const
inline

Get IP header.

Returns
the IPv4 header

Definition at line 135 of file dsdv-packet-queue.h.

References m_header.

Referenced by ns3::dsdv::PacketQueue::Drop(), ns3::dsdv::PacketQueue::Enqueue(), and ns3::dsdv::RoutingProtocol::SendPacketFromQueue().

+ Here is the caller graph for this function:

◆ GetPacket()

Ptr< const Packet > ns3::dsdv::QueueEntry::GetPacket ( ) const
inline

Get packet.

Returns
the current packet

Definition at line 117 of file dsdv-packet-queue.h.

References m_packet.

Referenced by ns3::dsdv::PacketQueue::Drop(), ns3::dsdv::PacketQueue::Enqueue(), and ns3::dsdv::RoutingProtocol::SendPacketFromQueue().

+ Here is the caller graph for this function:

◆ GetUnicastForwardCallback()

UnicastForwardCallback ns3::dsdv::QueueEntry::GetUnicastForwardCallback ( ) const
inline

Get unicast forward callback function.

Returns
the unicast forward callback

Definition at line 81 of file dsdv-packet-queue.h.

References m_ucb.

Referenced by ns3::dsdv::RoutingProtocol::SendPacketFromQueue().

+ Here is the caller graph for this function:

◆ operator==()

bool ns3::dsdv::QueueEntry::operator== ( const QueueEntry & o) const
inline

Compare queue entries.

Parameters
oQueueEntry to compare
Returns
true if equal

Definition at line 69 of file dsdv-packet-queue.h.

References ns3::Ipv4Header::GetDestination(), m_expire, m_header, and m_packet.

+ Here is the call graph for this function:

◆ SetErrorCallback()

void ns3::dsdv::QueueEntry::SetErrorCallback ( ErrorCallback ecb)
inline

Set error callback function.

Parameters
ecbthe error callback

Definition at line 108 of file dsdv-packet-queue.h.

References m_ecb.

◆ SetExpireTime()

void ns3::dsdv::QueueEntry::SetExpireTime ( Time exp)
inline

Set expire time.

Parameters
exp

Definition at line 153 of file dsdv-packet-queue.h.

References m_expire, and ns3::Simulator::Now().

Referenced by ns3::dsdv::PacketQueue::Enqueue().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetIpv4Header()

void ns3::dsdv::QueueEntry::SetIpv4Header ( Ipv4Header h)
inline

Set IP header.

Parameters
hThe IPv4 header

Definition at line 144 of file dsdv-packet-queue.h.

References m_header.

◆ SetPacket()

void ns3::dsdv::QueueEntry::SetPacket ( Ptr< const Packet > p)
inline

Set packet.

Parameters
pThe current packet

Definition at line 126 of file dsdv-packet-queue.h.

References m_packet.

◆ SetUnicastForwardCallback()

void ns3::dsdv::QueueEntry::SetUnicastForwardCallback ( UnicastForwardCallback ucb)
inline

Set unicast forward callback function.

Parameters
ucbthe unicast forward callback

Definition at line 90 of file dsdv-packet-queue.h.

References m_ucb.

Member Data Documentation

◆ m_ecb

ErrorCallback ns3::dsdv::QueueEntry::m_ecb
private

Error callback.

Definition at line 175 of file dsdv-packet-queue.h.

Referenced by GetErrorCallback(), and SetErrorCallback().

◆ m_expire

Time ns3::dsdv::QueueEntry::m_expire
private

Expire time for queue entry.

Definition at line 177 of file dsdv-packet-queue.h.

Referenced by GetExpireTime(), operator==(), and SetExpireTime().

◆ m_header

Ipv4Header ns3::dsdv::QueueEntry::m_header
private

IP header.

Definition at line 171 of file dsdv-packet-queue.h.

Referenced by GetIpv4Header(), operator==(), and SetIpv4Header().

◆ m_packet

Ptr<const Packet> ns3::dsdv::QueueEntry::m_packet
private

Data packet.

Definition at line 169 of file dsdv-packet-queue.h.

Referenced by GetPacket(), operator==(), and SetPacket().

◆ m_ucb

UnicastForwardCallback ns3::dsdv::QueueEntry::m_ucb
private

Unicast forward callback.

Definition at line 173 of file dsdv-packet-queue.h.

Referenced by GetUnicastForwardCallback(), and SetUnicastForwardCallback().


The documentation for this class was generated from the following file: