SequenceNumber_t Class Reference

Type for sequence number representation. More...

Inherits Struct.

Public Member Functions
	SequenceNumber_t ()
	Constructor. More...
	SequenceNumber_t (SequenceNumber_t sn)
	Copy constructor. More...
	SequenceNumber_t (int high, long low)
	Constructor. More...
int	compare (SequenceNumber_t sn)
	Compares two sequence numbers. More...
void	plusplus ()
	Increases the value of this by one More...
void	minusminus ()
	Decreases the value of this by one More...
SequenceNumber_t	add (SequenceNumber_t val)
	Returns a sequence number whose value is (this + val) More...
SequenceNumber_t	subtract (SequenceNumber_t val)
	Returns a sequence number whose value is (this - val) More...

Public Attributes
int	high
	The most significant part of the sequence number. More...
long	low
	The least significant part of the sequence number. More...

Static Public Attributes
static final SequenceNumber_t	SEQUENCE_NUMBER_UNKNOWN
	Unknown sequence number. More...
static final SequenceNumber_t	AUTO_SEQUENCE_NUMBER
	The sequence number is internally determined by RTI Connext. More...
static final SequenceNumber_t	SEQUENCE_NUMBER_ZERO
	Zero value for the sequence number. More...
static final SequenceNumber_t	SEQUENCE_NUMBER_MAX
	Highest, most positive value for the sequence number. More...

Detailed Description

Type for sequence number representation.

Represents a 64-bit sequence number.

Constructor & Destructor Documentation

SequenceNumber_t() [1/3]

SequenceNumber_t

(

)

Constructor.

References SequenceNumber_t.SEQUENCE_NUMBER_UNKNOWN.

Referenced by SequenceNumber_t.add(), and SequenceNumber_t.subtract().

SequenceNumber_t() [2/3]

SequenceNumber_t

(

SequenceNumber_t

sn

)

Copy constructor.

Parameters

sn	The sequence number instance to copy. It must not be null.

References SequenceNumber_t.high, and SequenceNumber_t.low.

SequenceNumber_t() [3/3]

SequenceNumber_t	(	int	high,
		long	low
	)

Constructor.

Parameters

high	must be in the interval [0,0xffffffff]
low	must be in the interval [0,0x00000000ffffffff]

Exceptions

RETCODE_BAD_PARAMETER

References SequenceNumber_t.high, and SequenceNumber_t.low.

Member Function Documentation

compare()

int compare

(

SequenceNumber_t

sn

)

Compares two sequence numbers.

Parameters

sn	<<in>> Sequence number to compare. Cannot be null.

Returns

If the two sequence numbers are equal, the function returns 0. If sn1 is greater than sn2 the function returns a positive number; otherwise, it returns a negative number.

References SequenceNumber_t.high, and SequenceNumber_t.low.

plusplus()

void plusplus

(

)

Increases the value of this by one

References SequenceNumber_t.high, and SequenceNumber_t.low.

minusminus()

void minusminus

(

)

Decreases the value of this by one

References SequenceNumber_t.high, and SequenceNumber_t.low.

add()

SequenceNumber_t add

(

SequenceNumber_t

val

)

Returns a sequence number whose value is (this + val)

Returns

(this+val)

References SequenceNumber_t.high, SequenceNumber_t.low, and SequenceNumber_t.SequenceNumber_t().

subtract()

SequenceNumber_t subtract

(

SequenceNumber_t

val

)

Returns a sequence number whose value is (this - val)

Returns

(this-val)

References SequenceNumber_t.high, SequenceNumber_t.low, and SequenceNumber_t.SequenceNumber_t().

Member Data Documentation

SEQUENCE_NUMBER_UNKNOWN

final SequenceNumber_t SEQUENCE_NUMBER_UNKNOWN

static

Unknown sequence number.

Referenced by SequenceNumber_t.SequenceNumber_t().

AUTO_SEQUENCE_NUMBER

final SequenceNumber_t AUTO_SEQUENCE_NUMBER

static

The sequence number is internally determined by RTI Connext.

SEQUENCE_NUMBER_ZERO

final SequenceNumber_t SEQUENCE_NUMBER_ZERO

static

Zero value for the sequence number.

SEQUENCE_NUMBER_MAX

final SequenceNumber_t SEQUENCE_NUMBER_MAX

static

Highest, most positive value for the sequence number.

high

int high

The most significant part of the sequence number.

Referenced by SequenceNumber_t.add(), SequenceNumber_t.compare(), SequenceNumber_t.minusminus(), SequenceNumber_t.plusplus(), SequenceNumber_t.SequenceNumber_t(), and SequenceNumber_t.subtract().

low

long low

The least significant part of the sequence number.

Referenced by SequenceNumber_t.add(), SequenceNumber_t.compare(), SequenceNumber_t.minusminus(), SequenceNumber_t.plusplus(), SequenceNumber_t.SequenceNumber_t(), and SequenceNumber_t.subtract().