ns3::TcpTxBuffer Class Reference
[Tcp]

class for keeping the data sent by the application to the TCP socket, i.e. the sending buffer. More...

#include <tcp-tx-buffer.h>

Inheritance diagram for ns3::TcpTxBuffer:

[legend]

Collaboration diagram for ns3::TcpTxBuffer:

[legend]

List of all members.

Public Member Functions
	TcpTxBuffer (uint32_t n=0)
SequenceNumber32	HeadSequence (void) const
SequenceNumber32	TailSequence (void) const
uint32_t	Size (void) const
uint32_t	MaxBufferSize (void) const
void	SetMaxBufferSize (uint32_t n)
uint32_t	Available (void) const
bool	Add (Ptr< Packet > p)
uint32_t	SizeFromSequence (const SequenceNumber32 &seq) const
Ptr< Packet >	CopyFromSequence (uint32_t numBytes, const SequenceNumber32 &seq)
void	SetHeadSequence (const SequenceNumber32 &seq)
void	DiscardUpTo (const SequenceNumber32 &seq)
Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::Object.

---

Detailed Description

class for keeping the data sent by the application to the TCP socket, i.e. the sending buffer.

---

Member Function Documentation

bool ns3::TcpTxBuffer::Add

(

Ptr< Packet >

p

)

Append a data packet to the end of the buffer

Parameters:

p

The packet to be appended to the Tx buffer

Returns:

Boolean to indicate success

uint32_t ns3::TcpTxBuffer::Available

(

void

)

const

Returns the available capacity in this Tx window

Ptr<Packet> ns3::TcpTxBuffer::CopyFromSequence	(	uint32_t	numBytes,
		const SequenceNumber32 &	seq
	)

Copy data of size numBytes into a packet, data from the range [seq, seq+numBytes)

void ns3::TcpTxBuffer::DiscardUpTo

(

const SequenceNumber32 &

seq

)

Discard data up to but not including this sequence number.

Parameters:

seq

The sequence number of the head byte

static TypeId ns3::TcpTxBuffer::GetTypeId

(

void

)

[static]

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

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

• /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager
• /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/NoiseModel
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/PropagationModel
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/NoiseModel
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Object.

SequenceNumber32 ns3::TcpTxBuffer::HeadSequence

(

void

)

const

Returns the first byte's sequence number

uint32_t ns3::TcpTxBuffer::MaxBufferSize

(

void

)

const

Returns the Tx window size

void ns3::TcpTxBuffer::SetHeadSequence

(

const SequenceNumber32 &

seq

)

Set the m_firstByteSeq to seq. Supposed to be called only when the connection is just set up and we did not send any data out yet.

void ns3::TcpTxBuffer::SetMaxBufferSize

(

uint32_t

n

)

Set the Tx window size

uint32_t ns3::TcpTxBuffer::Size

(

void

)

const

Returns total number of bytes in this Tx buffer

uint32_t ns3::TcpTxBuffer::SizeFromSequence

(

const SequenceNumber32 &

seq

)

const

Returns the number of bytes from the buffer in the range [seq, tailSequence)

SequenceNumber32 ns3::TcpTxBuffer::TailSequence

(

void

)

const

Returns the last byte's sequence number + 1

---

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

• src/internet-stack/tcp-tx-buffer.h