A Discrete-Event Network Simulator
API
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 ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default 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 operator. 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
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Register this type. More...
 
- 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::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

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

- Public Types inherited from ns3::Application
typedef void(* DelayAddressCallback) (const Time &delay, const Address &from)
 Common callback signature for packet delay and address. More...
 
typedef void(* StateTransitionCallback) (const std::string &oldState, const std::string &newState)
 Common signature used by callbacks to application's state transition trace source. More...
 
- Protected Member Functions inherited from ns3::Application
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. 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

◆ SocketWriter()

ns3::SocketWriter::SocketWriter ( )

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

◆ ~SocketWriter()

ns3::SocketWriter::~SocketWriter ( )
virtual

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

References m_node, and m_socket.

Member Function Documentation

◆ Close()

void ns3::SocketWriter::Close ( void  )

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

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

+ Here is the call graph for this function:

◆ Connect()

void ns3::SocketWriter::Connect ( void  )

Definition at line 69 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:

◆ GetTypeId()

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

Register this type.

Returns
The TypeId.

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ Setup()

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

◆ StartApplication()

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 49 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:

◆ StopApplication()

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 56 of file ns3tcp-socket-writer.cc.

◆ Write()

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

Definition at line 80 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

◆ m_isConnected

bool ns3::SocketWriter::m_isConnected
private

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

Referenced by Connect(), and Write().

◆ m_isSetup

bool ns3::SocketWriter::m_isSetup
private

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

Referenced by Connect(), and Setup().

◆ m_node

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

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

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

◆ m_peer

Address ns3::SocketWriter::m_peer
private

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

Referenced by Connect(), and Setup().

◆ m_socket

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

Definition at line 49 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: