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

#include <ns3tcp-socket-writer.h>

+ Inheritance diagram for ns3::SocketWriter:
+ Collaboration diagram for ns3::SocketWriter:

Public Member Functions

 SocketWriter ()
 
virtual ~SocketWriter ()
 
void Close ()
 
void Connect ()
 
void Setup (Ptr< Node > node, Address peer)
 
void Write (uint32_t numBytes)
 
- Public Member Functions inherited from ns3::Application
 Application ()
 
virtual ~Application ()
 
Ptr< NodeGetNode () const
 
void SetNode (Ptr< Node > node)
 
void SetStartTime (Time start)
 Specify application start time. More...
 
void SetStopTime (Time stop)
 Specify application stop time. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
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 Initialize (void)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
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)
 

Private Member Functions

virtual void StartApplication (void)
 Application specific startup code. More...
 
virtual void StopApplication (void)
 Application specific shutdown code. More...
 

Private Attributes

bool m_isConnected
 
bool m_isSetup
 
Ptr< Nodem_node
 
Address m_peer
 
Ptr< Socketm_socket
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::Application
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Protected Member Functions inherited from ns3::Application
virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 
- Protected Attributes inherited from ns3::Application
Ptr< Nodem_node
 The node that this application is installed on. More...
 
EventId m_startEvent
 The event that will fire at m_startTime to start the application. More...
 
Time m_startTime
 The simulation time that the application will start. More...
 
EventId m_stopEvent
 The event that will fire at m_stopTime to end the application. More...
 
Time m_stopTime
 The simulation time that the application will end. More...
 

Detailed Description

Definition at line 28 of file ns3tcp-socket-writer.h.

Constructor & Destructor Documentation

ns3::SocketWriter::SocketWriter ( )

Definition at line 26 of file ns3tcp-socket-writer.cc.

ns3::SocketWriter::~SocketWriter ( )
virtual

Definition at line 30 of file ns3tcp-socket-writer.cc.

References m_node, and m_socket.

Member Function Documentation

void ns3::SocketWriter::Close ( void  )

Definition at line 79 of file ns3tcp-socket-writer.cc.

References ns3::Socket::Close(), and m_socket.

+ Here is the call graph for this function:

void ns3::SocketWriter::Connect ( void  )

Definition at line 57 of file ns3tcp-socket-writer.cc.

References ns3::Socket::Connect(), m_isConnected, m_isSetup, m_peer, m_socket, and NS_FATAL_ERROR.

Referenced by Write().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::SocketWriter::Setup ( Ptr< Node node,
Address  peer 
)
void ns3::SocketWriter::StartApplication ( void  )
privatevirtual

Application specific startup code.

The StartApplication method is called at the start time specified by Start This method should be overridden by all or most application subclasses.

Reimplemented from ns3::Application.

Definition at line 37 of file ns3tcp-socket-writer.cc.

References ns3::Socket::Bind(), ns3::Socket::CreateSocket(), ns3::TcpSocketFactory::GetTypeId(), m_node, and m_socket.

+ Here is the call graph for this function:

void ns3::SocketWriter::StopApplication ( void  )
privatevirtual

Application specific shutdown code.

The StopApplication method is called at the stop time specified by Stop This method should be overridden by all or most application subclasses.

Reimplemented from ns3::Application.

Definition at line 44 of file ns3tcp-socket-writer.cc.

void ns3::SocketWriter::Write ( uint32_t  numBytes)

Definition at line 68 of file ns3tcp-socket-writer.cc.

References Connect(), m_isConnected, m_socket, and ns3::Socket::Send().

+ Here is the call graph for this function:

Member Data Documentation

bool ns3::SocketWriter::m_isConnected
private

Definition at line 45 of file ns3tcp-socket-writer.h.

Referenced by Connect(), and Write().

bool ns3::SocketWriter::m_isSetup
private

Definition at line 44 of file ns3tcp-socket-writer.h.

Referenced by Connect(), and Setup().

Ptr<Node> ns3::SocketWriter::m_node
private

Definition at line 42 of file ns3tcp-socket-writer.h.

Referenced by Setup(), StartApplication(), and ~SocketWriter().

Address ns3::SocketWriter::m_peer
private

Definition at line 41 of file ns3tcp-socket-writer.h.

Referenced by Connect(), and Setup().

Ptr<Socket> ns3::SocketWriter::m_socket
private

Definition at line 43 of file ns3tcp-socket-writer.h.

Referenced by Close(), Connect(), StartApplication(), Write(), and ~SocketWriter().


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