A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > Class Template Reference

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 (NUMERIC_TYPE value)
 Constructs a SequenceNumber with the given value. More...
 
 SequenceNumber (SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > const &value)
 Constructs a SequenceNumber from a copy. More...
 
NUMERIC_TYPE GetValue () const
 Extracts the numeric value of the sequence number. More...
 
bool operator!= (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &other) const
 Inequality operator for comparing sequence numbers. More...
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > 
operator+ (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &other) const
 Operator defining addition of two sequence numbers. More...
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > 
operator+ (SIGNED_TYPE delta) const
 Addition operator for adding numeric value to sequence number. More...
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > 
operator++ ()
 Prefix increment operator. More...
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > 
operator++ (int)
 Postfix increment operator. More...
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > & 
operator+= (SIGNED_TYPE value)
 Plus equals operator. More...
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > 
operator- (SIGNED_TYPE delta) const
 Subtraction operator for subtracting numeric value from sequence number. More...
 
SIGNED_TYPE operator- (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &other) const
 Subtraction operator for subtracting sequence number from sequence number. More...
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > 
operator-- ()
 Prefix decrement operator. More...
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > 
operator-- (int)
 Postfix decrement operator. More...
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > & 
operator-= (SIGNED_TYPE value)
 Minus equals operator. More...
 
bool operator< (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &other) const
 Less than operator for comparing sequence numbers. More...
 
bool operator<= (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &other) const
 Less than or equal operator for comparing sequence numbers. More...
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > & 
operator= (NUMERIC_TYPE value)
 Constructs a SequenceNumber from an assignment of given value. More...
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > & 
operator= (SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > const &value)
 Constructs a SequenceNumber from an assignment of another sequence number. More...
 
bool operator== (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &other) const
 Equality operator for comparing sequence number. More...
 
bool operator> (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &other) const
 Here is the critical part, how the comparison is made taking into account wrap-around. More...
 
bool operator>= (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &other) const
 Greater than or equal operator for comparing sequence numbers. More...
 

Private Member Functions

bool operator! () const
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > 
operator% (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &b) const
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > 
operator& (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &b) const
 
bool operator&& (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &b) const
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > 
operator* (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &b) const
 
int operator* ()
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > & 
operator+= (SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > const &value)
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > & 
operator-= (SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > const &value)
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > 
operator/ (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &b) const
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > 
operator<< (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &b) const
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > 
operator>> (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &b) const
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > 
operator^ (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &b) const
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > 
operator| (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &b) const
 
bool operator|| (const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &b) const
 
SequenceNumber< NUMERIC_TYPE,
SIGNED_TYPE > 
operator~ () const
 

Private Attributes

NUMERIC_TYPE m_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. More...
 
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. More...
 

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 arythmetic 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 52 of file sequence-number.h.

Constructor & Destructor Documentation

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>
ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::SequenceNumber ( )
inline

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

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
valuethe sequence number value

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

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

Constructs a SequenceNumber from a copy.

Parameters
valuesequence number to copy

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

Member Function Documentation

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>
NUMERIC_TYPE ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::GetValue ( void  ) const
inline

Extracts the numeric value of the sequence number.

Returns
the sequence number value

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

Referenced by SequenceNumberTestCase::DoRun(), and ns3::TcpHeader::Serialize().

+ Here is the caller graph for this function:

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>
bool ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator! ( ) const
private
template<typename NUMERIC_TYPE, typename SIGNED_TYPE>
bool ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator!= ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &  other) const
inline

Inequality operator for comparing sequence numbers.

Parameters
othersequence number to compare to this sequence number
Returns
true if the sequence numbers are not equal

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

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 > &  b) const
private
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 > &  b) const
private
template<typename NUMERIC_TYPE, typename SIGNED_TYPE>
bool ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator&& ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &  b) const
private
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 > &  b) const
private
template<typename NUMERIC_TYPE, typename SIGNED_TYPE>
int ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator* ( )
private
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
othersequence number added to this
Returns
sequence number representing sum

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

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
deltavalue to add to sequence number
Returns
sequence number representing sum

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

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 118 of file sequence-number.h.

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 128 of file sequence-number.h.

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
valuevalue to add to sequence number
Returns
incremented sequence number

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

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>
SequenceNumber<NUMERIC_TYPE, SIGNED_TYPE>& ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator+= ( SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > const &  value)
private
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
deltavalue to subtract from sequence number
Returns
sequence number representing difference

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

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
othersequence number to subtract from this sequence number
Returns
numeric value representing the difference

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

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 139 of file sequence-number.h.

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
incremented sequence number

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

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
valuevalue to subtract from sequence number
Returns
decremented sequence number

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

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>
SequenceNumber<NUMERIC_TYPE, SIGNED_TYPE>& ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator-= ( SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > const &  value)
private
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 > &  b) const
private
template<typename NUMERIC_TYPE, typename SIGNED_TYPE>
bool ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator< ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &  other) const
inline

Less than operator for comparing sequence numbers.

Parameters
othersequence number to compare to this sequence number
Returns
true if this sequence number is less than other

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

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 > &  b) const
private
template<typename NUMERIC_TYPE, typename SIGNED_TYPE>
bool ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator<= ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &  other) const
inline

Less than or equal operator for comparing sequence numbers.

Parameters
othersequence number to compare to this sequence number
Returns
true if this sequence number is less than or equal to other

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

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
valuesequence number to copy
Returns
reference to the assignee

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

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

Constructs a SequenceNumber from an assignment of another sequence number.

Parameters
valuesequence number to copy
Returns
reference to the assignee

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

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
othersequence number to compare to this sequence number
Returns
true if the sequence numbers are equal

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

template<typename NUMERIC_TYPE, typename SIGNED_TYPE>
bool ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator> ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &  other) const
inline

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
othersequence number to compare to this one
Returns
true if this sequence number is greater than other

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

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

+ Here is the caller graph for this function:

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

Greater than or equal operator for comparing sequence numbers.

Parameters
othersequence number to compare to this sequence number
Returns
true if this sequence number is greater than or equal to other

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

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 > &  b) const
private
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 > &  b) const
private
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 > &  b) const
private
template<typename NUMERIC_TYPE, typename SIGNED_TYPE>
bool ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator|| ( const SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE > &  b) const
private
template<typename NUMERIC_TYPE, typename SIGNED_TYPE>
SequenceNumber<NUMERIC_TYPE, SIGNED_TYPE> ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::operator~ ( ) const
private

Friends And Related Function Documentation

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
osoutput stream
valsequence number to display
Returns
output stream os
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
isinput stream
valsequence number to load
Returns
input stream is

Member Data Documentation


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