Generic "sequence number" class. More...

#include "sequence-number.h"

Inheritance diagram for ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >:

Collaboration diagram for ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >:

Public Member Functions
	SequenceNumber ()
	SequenceNumber (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &value)
	Constructs a SequenceNumber from a copy.
	SequenceNumber (NUMERIC_TYPE value)
	Constructs a SequenceNumber with the given value.
NUMERIC_TYPE	GetValue () const
	Extracts the numeric value of the sequence number.
bool	operator! () const =delete
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >	operator% (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &) const =delete
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >	operator& (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &) const =delete
bool	operator&& (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &) const =delete
int	operator* ()=delete
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >	operator* (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &) const =delete
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >	operator+ (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &other) const
	Operator defining addition of two sequence numbers.
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >	operator+ (SIGNED_TYPE delta) const
	Addition operator for adding numeric value to sequence number.
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >	operator++ ()
	Prefix increment operator.
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >	operator++ (int)
	Postfix increment operator.
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &	operator+= (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &)=delete
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &	operator+= (SIGNED_TYPE value)
	Plus equals operator.
SIGNED_TYPE	operator- (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &other) const
	Subtraction operator for subtracting sequence number from sequence number.
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >	operator- (SIGNED_TYPE delta) const
	Subtraction operator for subtracting numeric value from sequence number.
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >	operator-- ()
	Prefix decrement operator.
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >	operator-- (int)
	Postfix decrement operator.
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &	operator-= (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &)=delete
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &	operator-= (SIGNED_TYPE value)
	Minus equals operator.
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >	operator/ (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &) const =delete
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >	operator<< (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &) const =delete
constexpr std::strong_ordering	operator<=> (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &other) const
	Spaceship comparison operator.
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &	operator= (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &value)
	Constructs a SequenceNumber from an assignment of another sequence number.
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &	operator= (NUMERIC_TYPE value)
	Constructs a SequenceNumber from an assignment of given value.
bool	operator== (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &other) const
	Equality operator for comparing sequence number.
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >	operator>> (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &) const =delete
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >	operator^ (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &) const =delete
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >	operator\| (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &) const =delete
bool	operator\|\| (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &) const =delete
SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >	operator~ () const =delete

Private Attributes
NUMERIC_TYPE	m_value
	Sequence number value.

Friends
template<typename NUMERIC_TYPE2, typename SIGNED_TYPE2>
std::ostream &	operator<< (std::ostream &os, const SequenceNumber< NUMERIC_TYPE2, SIGNED_TYPE2 > &val)
	For printing sequence number.
template<typename NUMERIC_TYPE2, typename SIGNED_TYPE2>
std::istream &	operator>> (std::istream &is, const SequenceNumber< NUMERIC_TYPE2, SIGNED_TYPE2 > &val)
	For loading sequence number from input streams.

Detailed Description

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>
class ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >

Generic "sequence number" class.

This class can be used to handle sequence numbers. In networking protocols, sequence numbers are fixed precision integer numbers that are used to order events relative to each other. A sequence number is expected to increase over time but, since it has a limited number of bits, the number will "wrap around" from the maximum value that can represented with the given number of bits back to zero. For this reason, comparison of two sequence numbers, and subtraction, is non-trivial. The SequenceNumber class behaves like a number, with the usual arithmetic operators implemented, but knows how to correctly compare and subtract sequence numbers.

This is a templated class. To use it you need to supply two fundamental types as template parameters: NUMERIC_TYPE and SIGNED_TYPE. For instance, SequenceNumber<uint32_t, int32_t> gives you a 32-bit sequence number, while SequenceNumber<uint16_t, int16_t> is a 16-bit one. For your convenience, these are typedef'ed as SequenceNumber32 and SequenceNumber16, respectively.

Definition at line 51 of file sequence-number.h.

Constructor & Destructor Documentation

◆ SequenceNumber() [1/3]

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::SequenceNumber ( )

inline

Definition at line 54 of file sequence-number.h.

Referenced by ns3::SequenceNumber< uint32_t, int32_t >::operator+(), ns3::SequenceNumber< uint32_t, int32_t >::operator+(), and ns3::SequenceNumber< uint32_t, int32_t >::operator-().

Here is the caller graph for this function:

◆ SequenceNumber() [2/3]

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::SequenceNumber ( NUMERIC_TYPE value )

inlineexplicit

Constructs a SequenceNumber with the given value.

Parameters

value the sequence number value

Definition at line 63 of file sequence-number.h.

◆ SequenceNumber() [3/3]

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::SequenceNumber ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & value )

inline

Constructs a SequenceNumber from a copy.

Parameters

value sequence number to copy

Definition at line 72 of file sequence-number.h.

Member Function Documentation

◆ GetValue()

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

NUMERIC_TYPE ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::GetValue ( ) const

inline

Extracts the numeric value of the sequence number.

Returns: the sequence number value

Definition at line 112 of file sequence-number.h.

Referenced by ns3::OpenFlowSwitchNetDevice::BufferFromPacket(), ns3::TcpTxBuffer::CopyFromSequence(), SequenceNumberTestCase::DoRun(), ns3::TcpSocketBase::IsPacingEnabled(), ns3::TcpTxBuffer::NextSeg(), TcpFastRetrTest::ProcessedAck(), TcpFastRetrTest::RcvAck(), TcpFastRetrTest::Rx(), TcpPktsAckedOpenTest::Rx(), TcpSlowStartNormalTest::Rx(), ns3::TcpOptionSack::Serialize(), TcpTxBufferTestCase::TestNextSeg(), anonymous_namespace{traced-value-callback-typedef-test-suite.cc}::TracedValueCbSink< SequenceNumber32 >(), TcpFastRetrTest::Tx(), and TcpTimeRtoTest::Tx().

Here is the caller graph for this function:

◆ operator!()

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

bool ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator! ( ) const

delete

◆ operator%()

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator% ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & ) const

delete

◆ operator&()

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator& ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & ) const

delete

◆ operator&&()

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

bool ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator&& ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & ) const

delete

◆ operator*() [1/2]

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

int ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator* ( )

delete

◆ operator*() [2/2]

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator* ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & ) const

delete

◆ operator+() [1/2]

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator+ ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & other ) const

inline

Operator defining addition of two sequence numbers.

Parameters

other sequence number added to this

Returns: sequence number representing sum

Definition at line 186 of file sequence-number.h.

◆ operator+() [2/2]

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator+ ( SIGNED_TYPE delta ) const

inline

Addition operator for adding numeric value to sequence number.

Parameters

delta value to add to sequence number

Returns: sequence number representing sum

Definition at line 197 of file sequence-number.h.

◆ operator++() [1/2]

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator++ ( )

inline

Prefix increment operator.

Returns: incremented sequence number

Definition at line 121 of file sequence-number.h.

◆ operator++() [2/2]

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator++ ( int )

inline

Postfix increment operator.

Returns: incremented sequence number

Definition at line 131 of file sequence-number.h.

◆ operator+=() [1/2]

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator+= ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & )

delete

◆ operator+=() [2/2]

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator+= ( SIGNED_TYPE value )

inline

Plus equals operator.

Parameters

value value to add to sequence number

Returns: incremented sequence number

Definition at line 164 of file sequence-number.h.

◆ operator-() [1/2]

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SIGNED_TYPE ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator- ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & other ) const

inline

Subtraction operator for subtracting sequence number from sequence number.

Parameters

other sequence number to subtract from this sequence number

Returns: numeric value representing the difference

Definition at line 217 of file sequence-number.h.

◆ operator-() [2/2]

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator- ( SIGNED_TYPE delta ) const

inline

Subtraction operator for subtracting numeric value from sequence number.

Parameters

delta value to subtract from sequence number

Returns: sequence number representing difference

Definition at line 207 of file sequence-number.h.

◆ operator--() [1/2]

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator-- ( )

inline

Prefix decrement operator.

Returns: decremented sequence number

Definition at line 142 of file sequence-number.h.

◆ operator--() [2/2]

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator-- ( int )

inline

Postfix decrement operator.

Returns: decremented sequence number

Definition at line 152 of file sequence-number.h.

◆ operator-=() [1/2]

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator-= ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & )

delete

◆ operator-=() [2/2]

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator-= ( SIGNED_TYPE value )

inline

Minus equals operator.

Parameters

value value to subtract from sequence number

Returns: decremented sequence number

Definition at line 175 of file sequence-number.h.

◆ operator/()

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator/ ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & ) const

delete

◆ operator<<()

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator<< ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & ) const

delete

◆ operator<=>()

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

std::strong_ordering ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator<=> ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & other ) const

inlineconstexpr

Spaceship comparison operator.

All the other comparison operators are automatically generated from this one.

Here is the critical part, how the comparison is made taking into account wrap-around. From RFC 3626:

The sequence number S1 is said to be "greater than" the sequence number S2 if: S1 > S2 AND S1 - S2 <= MAXVALUE/2 OR S2 > S1 AND S2 - S1 > MAXVALUE/2

Parameters

other sequence number to compare to this one

Returns: The result of the comparison.

Definition at line 284 of file sequence-number.h.

◆ operator=() [1/2]

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator= ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & value )

inline

Constructs a SequenceNumber from an assignment of another sequence number.

Parameters

value sequence number to copy

Returns: reference to the assignee

Definition at line 93 of file sequence-number.h.

◆ operator=() [2/2]

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator= ( NUMERIC_TYPE value )

inline

Constructs a SequenceNumber from an assignment of given value.

Parameters

value sequence number to copy

Returns: reference to the assignee

Definition at line 82 of file sequence-number.h.

◆ operator==()

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

bool ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator== ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & other ) const

inline

Equality operator for comparing sequence number.

Parameters

other sequence number to compare to this sequence number

Returns: true if the sequence numbers are equal

Definition at line 264 of file sequence-number.h.

◆ operator>>()

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator>> ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & ) const

delete

◆ operator^()

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator^ ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & ) const

delete

◆ operator|()

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator| ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & ) const

delete

◆ operator||()

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

bool ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator|| ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > & ) const

delete

◆ operator~()

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator~ ( ) const

delete

◆ operator<<

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

template<typename NUMERIC_TYPE2, typename SIGNED_TYPE2>

std::ostream & operator<<	(	std::ostream &	os,
		const SequenceNumber< NUMERIC_TYPE2, SIGNED_TYPE2 > &	val )

friend

For printing sequence number.

Parameters

os	output stream
val	sequence number to display

Returns: output stream os

◆ operator>>

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

template<typename NUMERIC_TYPE2, typename SIGNED_TYPE2>

std::istream & operator>>	(	std::istream &	is,
		const SequenceNumber< NUMERIC_TYPE2, SIGNED_TYPE2 > &	val )

friend

For loading sequence number from input streams.

Parameters

is	input stream
val	sequence number to load

Returns: input stream is

Member Data Documentation

◆ m_value

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>

NUMERIC_TYPE ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::m_value

private

Sequence number value.

Definition at line 351 of file sequence-number.h.

Referenced by ns3::SequenceNumber< uint32_t, int32_t >::operator+(), ns3::SequenceNumber< uint32_t, int32_t >::operator-(), ns3::operator<<(), ns3::SequenceNumber< uint32_t, int32_t >::operator<=>(), ns3::SequenceNumber< uint32_t, int32_t >::operator==(), and ns3::operator>>().

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

src/network/utils/sequence-number.h

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SequenceNumber() [1/3]

◆ SequenceNumber() [2/3]

◆ SequenceNumber() [3/3]

Member Function Documentation

◆ GetValue()

◆ operator!()

◆ operator%()

◆ operator&()

◆ operator&&()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator+() [1/2]

◆ operator+() [2/2]

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator/()

◆ operator<<()

◆ operator<=>()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator>>()

◆ operator^()

◆ operator|()

◆ operator||()

◆ operator~()

Friends And Related Symbol Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ m_value