A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::NscTcpL4Protocol Class Reference

Nsc wrapper glue, to interface with the Ipv4 protocol underneath. More...

#include <nsc-tcp-l4-protocol.h>

+ Inheritance diagram for ns3::NscTcpL4Protocol:
+ Collaboration diagram for ns3::NscTcpL4Protocol:

Public Member Functions

 NscTcpL4Protocol ()
 Constructor.
virtual ~NscTcpL4Protocol ()
Ipv4EndPointAllocate (void)
Ipv4EndPointAllocate (Ipv4Address address)
Ipv4EndPointAllocate (uint16_t port)
Ipv4EndPointAllocate (Ipv4Address address, uint16_t port)
Ipv4EndPointAllocate (Ipv4Address localAddress, uint16_t localPort, Ipv4Address peerAddress, uint16_t peerPort)
Ptr< SocketCreateSocket (void)
void DeAllocate (Ipv4EndPoint *endPoint)
virtual
IpL4Protocol::DownTargetCallback 
GetDownTarget (void) const
virtual
IpL4Protocol::DownTargetCallback6 
GetDownTarget6 (void) const
std::string GetNscLibrary (void) const
virtual int GetProtocolNumber (void) const
virtual int GetVersion (void) const
virtual IpL4Protocol::RxStatus Receive (Ptr< Packet > p, Ipv4Header const &header, Ptr< Ipv4Interface > incomingInterface)
 Receive a packet up the protocol stack.
virtual IpL4Protocol::RxStatus Receive (Ptr< Packet > p, Ipv6Address &src, Ipv6Address &dst, Ptr< Ipv6Interface > interface)
virtual void SetDownTarget (IpL4Protocol::DownTargetCallback cb)
virtual void SetDownTarget6 (IpL4Protocol::DownTargetCallback6 cb)
void SetNode (Ptr< Node > node)
void SetNscLibrary (const std::string &lib)
- Public Member Functions inherited from ns3::IpL4Protocol
virtual ~IpL4Protocol ()
virtual void ReceiveIcmp (Ipv4Address icmpSource, uint8_t icmpTtl, uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo, Ipv4Address payloadSource, Ipv4Address payloadDestination, const uint8_t payload[8])
virtual void ReceiveIcmp (Ipv6Address icmpSource, uint8_t icmpTtl, uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo, Ipv6Address payloadSource, Ipv6Address payloadDestination, const uint8_t payload[8])
- Public Member Functions inherited from ns3::Object
 Object ()
virtual ~Object ()
void AggregateObject (Ptr< Object > other)
void Dispose (void)
AggregateIterator GetAggregateIterator (void) const
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions

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

Static Public Attributes

static const uint8_t PROT_NUMBER = 6

Protected Member Functions

virtual void DoDispose (void)
virtual void NotifyNewAggregate ()

Private Member Functions

 NscTcpL4Protocol (NscTcpL4Protocol const &)
void AddInterface (void)
void gettime (unsigned int *sec, unsigned int *usec)
NscTcpL4Protocoloperator= (NscTcpL4Protocol const &)
void send_callback (const void *data, int datalen)
void SoftInterrupt (void)
void wakeup ()

Private Attributes

void * m_dlopenHandle
IpL4Protocol::DownTargetCallback m_downTarget
Ipv4EndPointDemuxm_endPoints
Ptr< Nodem_node
NscInterfaceImplm_nscInterface
std::string m_nscLibrary
INetStackm_nscStack
std::vector< Ptr
< NscTcpSocketImpl > > 
m_sockets
Timer m_softTimer

Friends

class NscInterfaceImpl
class NscTcpSocketImpl

Additional Inherited Members

- Public Types inherited from ns3::IpL4Protocol
typedef Callback< void, Ptr
< Packet >, Ipv4Address,
Ipv4Address, uint8_t, Ptr
< Ipv4Route > > 
DownTargetCallback
typedef Callback< void, Ptr
< Packet >, Ipv6Address,
Ipv6Address, uint8_t, Ptr
< Ipv6Route > > 
DownTargetCallback6
enum  RxStatus { RX_OK, RX_CSUM_FAILED, RX_ENDPOINT_CLOSED, RX_ENDPOINT_UNREACH }

Detailed Description

Nsc wrapper glue, to interface with the Ipv4 protocol underneath.

Definition at line 46 of file nsc-tcp-l4-protocol.h.

Constructor & Destructor Documentation

ns3::NscTcpL4Protocol::NscTcpL4Protocol ( )

Constructor.

Definition at line 120 of file nsc-tcp-l4-protocol.cc.

References m_dlopenHandle, and NS_LOG_LOGIC.

ns3::NscTcpL4Protocol::~NscTcpL4Protocol ( )
virtual

Definition at line 130 of file nsc-tcp-l4-protocol.cc.

References m_dlopenHandle, and NS_LOG_FUNCTION.

ns3::NscTcpL4Protocol::NscTcpL4Protocol ( NscTcpL4Protocol const &  )
private

Member Function Documentation

void ns3::NscTcpL4Protocol::AddInterface ( void  )
private
Ipv4EndPoint * ns3::NscTcpL4Protocol::Allocate ( void  )

Definition at line 261 of file nsc-tcp-l4-protocol.cc.

References ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, and NS_LOG_FUNCTION.

Referenced by ns3::NscTcpSocketImpl::Bind(), and ns3::NscTcpSocketImpl::CompleteFork().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Ipv4EndPoint * ns3::NscTcpL4Protocol::Allocate ( Ipv4Address  address)

Definition at line 268 of file nsc-tcp-l4-protocol.cc.

References ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Ipv4EndPoint * ns3::NscTcpL4Protocol::Allocate ( uint16_t  port)

Definition at line 275 of file nsc-tcp-l4-protocol.cc.

References ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Ipv4EndPoint * ns3::NscTcpL4Protocol::Allocate ( Ipv4Address  address,
uint16_t  port 
)

Definition at line 282 of file nsc-tcp-l4-protocol.cc.

References ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Ipv4EndPoint * ns3::NscTcpL4Protocol::Allocate ( Ipv4Address  localAddress,
uint16_t  localPort,
Ipv4Address  peerAddress,
uint16_t  peerPort 
)

Definition at line 289 of file nsc-tcp-l4-protocol.cc.

References ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Ptr< Socket > ns3::NscTcpL4Protocol::CreateSocket ( void  )
Returns
A smart Socket pointer to a NscTcpSocketImpl, allocated by this instance of the TCP protocol

Definition at line 249 of file nsc-tcp-l4-protocol.cc.

References m_node, m_sockets, NS_LOG_FUNCTION, ns3::NscTcpSocketImpl::SetNode(), and ns3::NscTcpSocketImpl::SetTcp().

Referenced by ns3::NscTcpSocketFactoryImpl::CreateSocket().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::NscTcpL4Protocol::DeAllocate ( Ipv4EndPoint endPoint)

Definition at line 298 of file nsc-tcp-l4-protocol.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::NscTcpSocketImpl::~NscTcpSocketImpl().

+ Here is the caller graph for this function:

void ns3::NscTcpL4Protocol::DoDispose ( void  )
protectedvirtual

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.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

Definition at line 225 of file nsc-tcp-l4-protocol.cc.

References m_downTarget, m_endPoints, m_node, m_nscInterface, m_sockets, NS_LOG_FUNCTION, and ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::Nullify().

+ Here is the call graph for this function:

IpL4Protocol::DownTargetCallback ns3::NscTcpL4Protocol::GetDownTarget ( void  ) const
virtual

This method allows a caller to get the current down target callback set for this L4 protocol, for

Returns
current Callback for the L4 protocol

Implements ns3::IpL4Protocol.

Definition at line 471 of file nsc-tcp-l4-protocol.cc.

References m_downTarget.

IpL4Protocol::DownTargetCallback6 ns3::NscTcpL4Protocol::GetDownTarget6 ( void  ) const
virtual

Implements ns3::IpL4Protocol.

Definition at line 477 of file nsc-tcp-l4-protocol.cc.

std::string ns3::NscTcpL4Protocol::GetNscLibrary ( void  ) const

Definition at line 150 of file nsc-tcp-l4-protocol.cc.

References m_nscLibrary.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

int ns3::NscTcpL4Protocol::GetProtocolNumber ( void  ) const
virtual
Returns
the protocol number of this protocol.

Implements ns3::IpL4Protocol.

Definition at line 214 of file nsc-tcp-l4-protocol.cc.

References PROT_NUMBER.

void ns3::NscTcpL4Protocol::gettime ( unsigned int *  sec,
unsigned int *  usec 
)
private

Definition at line 399 of file nsc-tcp-l4-protocol.cc.

References ns3::Time::GetMicroSeconds(), and ns3::Now().

Referenced by ns3::NscInterfaceImpl::gettime().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

TypeId ns3::NscTcpL4Protocol::GetTypeId ( void  )
static

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

Attributes defined for this type:

  • ProtocolNumber: The Ip protocol number.

No TraceSources defined for this type.

Reimplemented from ns3::IpL4Protocol.

Definition at line 96 of file nsc-tcp-l4-protocol.cc.

References ns3::TypeId::ATTR_CONSTRUCT, ns3::TypeId::ATTR_GET, GetNscLibrary(), m_sockets, ns3::MakeObjectVectorAccessor(), SetNscLibrary(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

int ns3::NscTcpL4Protocol::GetVersion ( void  ) const
virtual

Definition at line 219 of file nsc-tcp-l4-protocol.cc.

void ns3::NscTcpL4Protocol::NotifyNewAggregate ( void  )
protectedvirtual

This method is invoked whenever two sets of objects are aggregated together. It is invoked exactly once for each object in both sets. This method can be overriden by subclasses who wish to be notified of aggregation events. These subclasses must chain up to their base class NotifyNewAggregate method. It is safe to call GetObject and AggregateObject from within this method.

This function must be implemented in the stack that needs to notify other stacks connected to the node of their presence in the node.

Reimplemented from ns3::Object.

Definition at line 191 of file nsc-tcp-l4-protocol.cc.

References ns3::Object::AggregateObject(), ns3::Ipv4L3Protocol::Insert(), ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_downTarget, m_node, ns3::MakeCallback(), ns3::Ipv4L3Protocol::Send(), SetDownTarget(), and SetNode().

+ Here is the call graph for this function:

NscTcpL4Protocol& ns3::NscTcpL4Protocol::operator= ( NscTcpL4Protocol const &  )
private
IpL4Protocol::RxStatus ns3::NscTcpL4Protocol::Receive ( Ptr< Packet p,
Ipv4Header const &  header,
Ptr< Ipv4Interface incomingInterface 
)
virtual
IpL4Protocol::RxStatus ns3::NscTcpL4Protocol::Receive ( Ptr< Packet p,
Ipv6Address src,
Ipv6Address dst,
Ptr< Ipv6Interface interface 
)
virtual

Implements ns3::IpL4Protocol.

Definition at line 342 of file nsc-tcp-l4-protocol.cc.

References ns3::IpL4Protocol::RX_ENDPOINT_UNREACH.

void ns3::NscTcpL4Protocol::send_callback ( const void *  data,
int  datalen 
)
private

Definition at line 354 of file nsc-tcp-l4-protocol.cc.

References data, ns3::Object::GetObject(), INetStack::if_send_finish(), m_downTarget, m_node, m_nscStack, NS_ASSERT, NS_ASSERT_MSG, and PROT_NUMBER.

Referenced by ns3::NscInterfaceImpl::send_callback().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::NscTcpL4Protocol::SetDownTarget ( IpL4Protocol::DownTargetCallback  cb)
virtual

This method allows a caller to set the current down target callback set for this L4 protocol

Parameters
cbcurrent Callback for the L4 protocol

Implements ns3::IpL4Protocol.

Definition at line 460 of file nsc-tcp-l4-protocol.cc.

References m_downTarget.

Referenced by NotifyNewAggregate().

+ Here is the caller graph for this function:

void ns3::NscTcpL4Protocol::SetDownTarget6 ( IpL4Protocol::DownTargetCallback6  cb)
virtual

Implements ns3::IpL4Protocol.

Definition at line 466 of file nsc-tcp-l4-protocol.cc.

void ns3::NscTcpL4Protocol::SetNode ( Ptr< Node node)
void ns3::NscTcpL4Protocol::SetNscLibrary ( const std::string &  lib)

Definition at line 137 of file nsc-tcp-l4-protocol.cc.

References m_dlopenHandle, m_nscLibrary, NS_ASSERT, and NS_FATAL_ERROR.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

void ns3::NscTcpL4Protocol::SoftInterrupt ( void  )
private

Definition at line 347 of file nsc-tcp-l4-protocol.cc.

References INetStack::increment_ticks(), m_nscStack, m_softTimer, ns3::Timer::Schedule(), and INetStack::timer_interrupt().

Referenced by SetNode().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::NscTcpL4Protocol::wakeup ( )
private

Definition at line 385 of file nsc-tcp-l4-protocol.cc.

References ns3::Ipv4EndPointDemux::GetAllEndPoints(), and m_endPoints.

Referenced by Receive(), and ns3::NscInterfaceImpl::wakeup().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Friends And Related Function Documentation

friend class NscInterfaceImpl
friend

Definition at line 122 of file nsc-tcp-l4-protocol.h.

friend class NscTcpSocketImpl
friend

Definition at line 123 of file nsc-tcp-l4-protocol.h.

Member Data Documentation

void* ns3::NscTcpL4Protocol::m_dlopenHandle
private

Definition at line 128 of file nsc-tcp-l4-protocol.h.

Referenced by NscTcpL4Protocol(), SetNode(), SetNscLibrary(), and ~NscTcpL4Protocol().

IpL4Protocol::DownTargetCallback ns3::NscTcpL4Protocol::m_downTarget
private
Ipv4EndPointDemux* ns3::NscTcpL4Protocol::m_endPoints
private

Definition at line 125 of file nsc-tcp-l4-protocol.h.

Referenced by Allocate(), DoDispose(), and wakeup().

Ptr<Node> ns3::NscTcpL4Protocol::m_node
private
NscInterfaceImpl* ns3::NscTcpL4Protocol::m_nscInterface
private

Definition at line 127 of file nsc-tcp-l4-protocol.h.

Referenced by DoDispose(), and SetNode().

std::string ns3::NscTcpL4Protocol::m_nscLibrary
private

Definition at line 129 of file nsc-tcp-l4-protocol.h.

Referenced by GetNscLibrary(), and SetNscLibrary().

INetStack* ns3::NscTcpL4Protocol::m_nscStack
private
std::vector<Ptr<NscTcpSocketImpl> > ns3::NscTcpL4Protocol::m_sockets
private

Definition at line 131 of file nsc-tcp-l4-protocol.h.

Referenced by CreateSocket(), DoDispose(), and GetTypeId().

Timer ns3::NscTcpL4Protocol::m_softTimer
private

Definition at line 130 of file nsc-tcp-l4-protocol.h.

Referenced by SetNode(), and SoftInterrupt().

const uint8_t ns3::NscTcpL4Protocol::PROT_NUMBER = 6
static

Definition at line 48 of file nsc-tcp-l4-protocol.h.

Referenced by GetProtocolNumber(), Receive(), and send_callback().


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