ns-3
ns3::Ping6 Class Reference

A ping6 application. More...

#include <ping6.h>

Inheritance diagram for ns3::Ping6:
Collaboration diagram for ns3::Ping6:

List of all members.

Public Member Functions

 Ping6 ()
 Constructor.
virtual ~Ping6 ()
 Destructor.
void SetLocal (Ipv6Address ipv6)
 Set the local address.
void SetRemote (Ipv6Address ipv6)
 Set the remote peer.
void SetIfIndex (uint32_t ifIndex)
 Set the out interface index. This is to send to link-local (unicast or multicast) address when a node has multiple interfaces.
void SetRouters (std::vector< Ipv6Address > routers)
 Set routers for routing type 0 (loose routing).
- Public Member Functions inherited from ns3::Application
void SetStartTime (Time start)
 Specify application start time.
void SetStopTime (Time stop)
 Specify application stop time.
Ptr< NodeGetNode () const
void SetNode (Ptr< Node > node)
- 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 ()
 Get the type ID.

Protected Member Functions

virtual void DoDispose ()
 Dispose this object;.
- Protected Member Functions inherited from ns3::Application
virtual void DoStart (void)
- Protected Member Functions inherited from ns3::Object
virtual void NotifyNewAggregate (void)
 Object (const Object &o)

Additional Inherited Members

- Protected Attributes inherited from ns3::Application
Ptr< Nodem_node
Time m_startTime
Time m_stopTime
EventId m_startEvent
EventId m_stopEvent

Detailed Description

A ping6 application.


Member Function Documentation

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

Get the type ID.

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

Returns:
type ID

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

  • /NodeList/[i]/ApplicationList/[i]/$ns3::Ping6

Attributes defined for this type:

  • MaxPackets: The maximum number of packets the application will send
  • Interval: The time to wait between packets
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +1000000000.0ns
    • Flags: construct write read
  • RemoteIpv6: The Ipv6Address of the outbound packets
    • Set with class: Ipv6AddressValue
    • Underlying type: Ipv6Address
    • Initial value: 0000:0000:0000:0000:0000:0000:0000:0000
    • Flags: construct write read
  • LocalIpv6: Local Ipv6Address of the sender
    • Set with class: Ipv6AddressValue
    • Underlying type: Ipv6Address
    • Initial value: 0000:0000:0000:0000:0000:0000:0000:0000
    • Flags: construct write read
  • PacketSize: Size of packets generated

Attributes defined in parent class ns3::Application:

  • StartTime: Time at which the application will start
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +0.0ns
    • Flags: construct write read
  • StopTime: Time at which the application will stop
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +0.0ns
    • Flags: construct write read

No TraceSources defined for this type.

Reimplemented from ns3::Application.

References ns3::Seconds(), and ns3::TypeId::SetParent().

Referenced by ns3::Ping6Helper::Ping6Helper().

void ns3::Ping6::SetIfIndex ( uint32_t  ifIndex)

Set the out interface index. This is to send to link-local (unicast or multicast) address when a node has multiple interfaces.

Parameters:
ifIndexinterface index
void ns3::Ping6::SetLocal ( Ipv6Address  ipv6)

Set the local address.

Parameters:
ipv6the local IPv6 address

References NS_LOG_FUNCTION.

void ns3::Ping6::SetRemote ( Ipv6Address  ipv6)

Set the remote peer.

Parameters:
ipv6IPv6 address of the peer

References NS_LOG_FUNCTION.

void ns3::Ping6::SetRouters ( std::vector< Ipv6Address routers)

Set routers for routing type 0 (loose routing).

Parameters:
routersrouters addresses

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