ns-3
ns3::BulkSendApplication Class Reference
Inheritance diagram for ns3::BulkSendApplication:
Collaboration diagram for ns3::BulkSendApplication:

List of all members.

Public Member Functions

void SetMaxBytes (uint32_t maxBytes)
Ptr< SocketGetSocket (void) const
- 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 (void)
 This method returns the TypeId associated to ns3::BulkSendApplication.

Protected Member Functions

virtual void DoDispose (void)
- 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

Member Function Documentation

void ns3::BulkSendApplication::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::Application.

References NS_LOG_FUNCTION.

Ptr< Socket > ns3::BulkSendApplication::GetSocket ( void  ) const
Returns:
pointer to associated socket

References NS_LOG_FUNCTION.

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

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

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

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

Attributes defined for this type:

  • SendSize: The amount of data to send each time.
  • Remote: The address of the destination
    • Set with class: AddressValue
    • Underlying type: Address
    • Initial value: 00-00-00
    • Flags: construct write read
  • MaxBytes: The total number of bytes to send. Once these bytes are sent, no data is sent again. The value zero means that there is no limit.
  • Protocol: The type of protocol to use.

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

TraceSources defined for this type:

  • Tx: A new packet is created and is sent

Reimplemented from ns3::Application.

References ns3::TcpSocketFactory::GetTypeId(), ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

void ns3::BulkSendApplication::SetMaxBytes ( uint32_t  maxBytes)
Parameters:
maxBytesthe upper bound of bytes to send

Set the upper bound for the total number of bytes to send. Once this bound is reached, no more application bytes are sent. If the application is stopped during the simulation and restarted, the total number of bytes sent is not reset; however, the maxBytes bound is still effective and the application will continue sending up to maxBytes. The value zero for maxBytes means that there is no upper bound; i.e. data is sent until the application or simulation is stopped.

References NS_LOG_FUNCTION.


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