SequenceNumber_t Class Reference

Type for sequence number representation. More...

Inherits Struct.

Public Member Functions
	SequenceNumber_t ()
	Constructor.
	SequenceNumber_t (SequenceNumber_t sn)
	Copy constructor.
	SequenceNumber_t (int high, long low)
	Constructor.
int	compare (SequenceNumber_t sn)
	Compares two sequence numbers.
void	plusplus ()
	Increases the value of this by one.
void	minusminus ()
	Decreases the value of this by one.
SequenceNumber_t	add (SequenceNumber_t val)
	Returns a sequence number whose value is (this + val)
SequenceNumber_t	subtract (SequenceNumber_t val)
	Returns a sequence number whose value is (this - val)
Public Member Functions inherited from Struct
abstract boolean	equals (Object obj)
abstract int	hashCode ()
String	toString ()

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

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

Additional Inherited Members
Protected Member Functions inherited from Struct
	Struct ()
abstract void	pull_from_nativeI (long native_status)
abstract void	push_to_nativeI (long native_status)

Detailed Description

Type for sequence number representation.

Represents a 64-bit sequence number.

Constructor & Destructor Documentation

SequenceNumber_t

(

)

Constructor.

SequenceNumber_t

(

SequenceNumber_t

sn

)

Copy constructor.

Parameters

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

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

Member Function Documentation

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.

void plusplus

(

)

Increases the value of this by one.

void minusminus

(

)

Decreases the value of this by one.

SequenceNumber_t add

(

SequenceNumber_t

val

)

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

Returns

(this+val)

SequenceNumber_t subtract

(

SequenceNumber_t

val

)

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

Returns

(this-val)

Member Data Documentation

final SequenceNumber_t SEQUENCE_NUMBER_UNKNOWN

static

Unknown sequence number.

final SequenceNumber_t AUTO_SEQUENCE_NUMBER

static

The sequence number is internally determined by RTI Connext.

final SequenceNumber_t SEQUENCE_NUMBER_ZERO

static

Zero value for the sequence number.

final SequenceNumber_t SEQUENCE_NUMBER_MAX

static

Highest, most positive value for the sequence number.

int high

The most significant part of the sequence number.

long low

The least significant part of the sequence number.