Simple class to write data to sockets. More...

#include "ns3tcp-socket-writer.h"

Inheritance diagram for ns3::SocketWriter:

Collaboration diagram for ns3::SocketWriter:

Public Member Functions
	SocketWriter ()

	~SocketWriter () override

void	Close ()
	Close the socket.

void	Connect ()
	Connect the socket.

void	Setup (Ptr< Node > node, Address peer)
	Setup the socket.

void	Write (uint32_t numBytes)
	Write to the socket.

Public Member Functions inherited from ns3::Application
	Application ()

	~Application () override

virtual int64_t	AssignStreams (int64_t stream)
	Assign a fixed random variable stream number to the random variables used by this Application object.

Ptr< Node >	GetNode () const

void	SetNode (Ptr< Node > node)

void	SetStartTime (Time start)
	Specify application start time.

void	SetStopTime (Time stop)
	Specify application stop time.

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const final
	Get the most derived TypeId for this Object.

template<typename T>
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T>
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::Application
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Member Functions
void	StartApplication () override
	Application specific startup code.

void	StopApplication () override
	Application specific shutdown code.

Private Attributes
bool	m_isConnected
	True if the socket setup has been done.

bool	m_isSetup
	True if the socket is connected.

Ptr< Node >	m_node
	Node pointer.

Address	m_peer
	Peer's address.

Ptr< Socket >	m_socket
	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.

typedef void(*	StateTransitionCallback) (const std::string &oldState, const std::string &newState)
	Common signature used by callbacks to application's state transition trace source.

Protected Member Functions inherited from ns3::Application
void	DoDispose () override
	Destructor implementation.

void	DoInitialize () override
	Initialize() implementation.

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Protected Attributes inherited from ns3::Application
Ptr< Node >	m_node
	The node that this application is installed on.

EventId	m_startEvent
	The event that will fire at m_startTime to start the application.

Time	m_startTime
	The simulation time that the application will start.

EventId	m_stopEvent
	The event that will fire at m_stopTime to end the application.

Time	m_stopTime
	The simulation time that the application will end.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Simple class to write data to sockets.

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

Constructor & Destructor Documentation

◆ SocketWriter()

ns3::SocketWriter::SocketWriter ( )

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

References m_isConnected, m_isSetup, m_node, and m_socket.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ ~SocketWriter()

ns3::SocketWriter::~SocketWriter ( )

override

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

References m_node, and m_socket.

Member Function Documentation

◆ Close()

void ns3::SocketWriter::Close ( )

Close the socket.

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

References m_socket.

Referenced by Ns3TcpNoDelayTestCase::DoRun(), Ns3TcpSocketTestCaseCsma::DoRun(), and Ns3TcpSocketTestCaseP2P::DoRun().

Here is the caller graph for this function:

◆ Connect()

void ns3::SocketWriter::Connect ( )

Connect the socket.

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

References m_isConnected, m_isSetup, m_peer, m_socket, and NS_FATAL_ERROR.

Referenced by Ns3TcpNoDelayTestCase::DoRun(), Ns3TcpSocketTestCaseCsma::DoRun(), Ns3TcpSocketTestCaseP2P::DoRun(), and Write().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::SocketWriter::GetTypeId ( )

static

Register this type.

Returns: The TypeId.

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

References ns3::Application::Application(), SocketWriter(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Setup()

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

Setup the socket.

Parameters

node	The node owning the socket.
peer	The destination address.

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

References m_isSetup, m_node, and m_peer.

◆ StartApplication()

void ns3::SocketWriter::StartApplication ( )

overrideprivatevirtual

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

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

Here is the call graph for this function:

◆ StopApplication()

void ns3::SocketWriter::StopApplication ( )

overrideprivatevirtual

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

◆ Write()

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

Write to the socket.

Parameters

numBytes The number of bytes to write.

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

References Connect(), ns3::Create(), m_isConnected, and m_socket.

Referenced by Ns3TcpNoDelayTestCase::DoRun(), Ns3TcpSocketTestCaseCsma::DoRun(), and Ns3TcpSocketTestCaseP2P::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_isConnected

bool ns3::SocketWriter::m_isConnected

private

True if the socket setup has been done.

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

Referenced by SocketWriter(), Connect(), and Write().

◆ m_isSetup

bool ns3::SocketWriter::m_isSetup

private

True if the socket is connected.

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

Referenced by SocketWriter(), Connect(), and Setup().

◆ m_node

Ptr<Node> ns3::SocketWriter::m_node

private

Node pointer.

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

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

◆ m_peer

Address ns3::SocketWriter::m_peer

private

Peer's address.

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

Referenced by Connect(), and Setup().

◆ m_socket

Ptr<Socket> ns3::SocketWriter::m_socket

private

Socket.

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

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

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

src/test/ns3tcp/ns3tcp-socket-writer.h
src/test/ns3tcp/ns3tcp-socket-writer.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SocketWriter()

◆ ~SocketWriter()

Member Function Documentation

◆ Close()

◆ Connect()

◆ GetTypeId()

◆ Setup()

◆ StartApplication()

◆ StopApplication()

◆ Write()

Member Data Documentation

◆ m_isConnected

◆ m_isSetup

◆ m_node

◆ m_peer

◆ m_socket