ns-3
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:

List of all members.

Public Member Functions

 NscTcpL4Protocol ()
 Constructor.
void SetNode (Ptr< Node > node)
void SetNscLibrary (const std::string &lib)
std::string GetNscLibrary (void) const
virtual int GetProtocolNumber (void) const
virtual int GetVersion (void) const
Ptr< SocketCreateSocket (void)
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)
void DeAllocate (Ipv4EndPoint *endPoint)
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)
virtual
IpL4Protocol::DownTargetCallback 
GetDownTarget (void) const
virtual
IpL4Protocol::DownTargetCallback6 
GetDownTarget6 (void) const
- Public Member Functions inherited from ns3::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
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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::NscTcpL4Protocol.

Static Public Attributes

static const uint8_t PROT_NUMBER = 6

Protected Member Functions

virtual void DoDispose (void)
virtual void NotifyNewAggregate ()

Friends

class NscInterfaceImpl
class NscTcpSocketImpl

Additional Inherited Members

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

Detailed Description

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


Member Function Documentation

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

References NS_LOG_FUNCTION.

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

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.

References NS_LOG_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.

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

Implements ns3::IpL4Protocol.

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

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

Attributes defined for this type:

  • SocketList: The list of sockets associated to this protocol.
  • Library: Set the linux library to be used to create the stack
    • Set with class: StringValue
    • Underlying type: std::string
    • Initial value: liblinux2.6.26.so
    • Flags: construct read

Attributes defined in parent class ns3::IpL4Protocol:

  • ProtocolNumber: The Ip protocol number.

No TraceSources defined for this type.

Reimplemented from ns3::IpL4Protocol.

References ns3::TypeId::ATTR_CONSTRUCT, ns3::TypeId::ATTR_GET, and ns3::TypeId::SetParent().

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.

References ns3::Object::AggregateObject(), ns3::Ipv4L3Protocol::Insert(), ns3::MakeCallback(), ns3::Ipv4L3Protocol::Send(), and SetDownTarget().

IpL4Protocol::RxStatus ns3::NscTcpL4Protocol::Receive ( Ptr< Packet p,
Ipv4Header const &  header,
Ptr< Ipv4Interface incomingInterface 
)
virtual
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.

Referenced by NotifyNewAggregate().


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