Sequence Number Support

<<extension>> Sequence number type and defines. More...

Data Structures
struct	DDS_SequenceNumber_t
	Type for sequence number representation. More...

Typedefs
typedef struct DDS_SequenceNumber_t	DDS_SequenceNumber_t
	Type for sequence number representation. More...

Functions
void	DDS_SequenceNumber_subtract (struct DDS_SequenceNumber_t *answer, const struct DDS_SequenceNumber_t *sn1, const struct DDS_SequenceNumber_t *sn2)
	Stores the value (sn1 - sn2) in answer More...
void	DDS_SequenceNumber_add (struct DDS_SequenceNumber_t *answer, const struct DDS_SequenceNumber_t *sn1, const struct DDS_SequenceNumber_t *sn2)
	Stores the value (sn1 + sn2) in answer More...
void	DDS_SequenceNumber_plusplus (struct DDS_SequenceNumber_t *sn)
	Increases the value of the input sequence number by one More...
void	DDS_SequenceNumber_minusminus (struct DDS_SequenceNumber_t *sn)
	Decreases the value of the input sequence number by one More...
int	DDS_SequenceNumber_compare (const struct DDS_SequenceNumber_t *sn1, const struct DDS_SequenceNumber_t *sn2)
	Compares two sequence numbers. More...

Variables
const struct DDS_SequenceNumber_t	DDS_SEQUENCE_NUMBER_UNKNOWN
	Unknown sequence number. More...
const struct DDS_SequenceNumber_t	DDS_SEQUENCE_NUMBER_ZERO
	Zero value for the sequence number. More...
const struct DDS_SequenceNumber_t	DDS_SEQUENCE_NUMBER_MAX
	Highest, most positive value for the sequence number. More...
const struct DDS_SequenceNumber_t	DDS_AUTO_SEQUENCE_NUMBER
	The sequence number is internally determined by RTI Connext. More...

Detailed Description

<<extension>> Sequence number type and defines.

Typedef Documentation

DDS_SequenceNumber_t

typedef struct DDS_SequenceNumber_t DDS_SequenceNumber_t

Type for sequence number representation.

Represents a 64-bit sequence number.

Function Documentation

DDS_SequenceNumber_subtract()

void DDS_SequenceNumber_subtract	(	struct DDS_SequenceNumber_t *	answer,
		const struct DDS_SequenceNumber_t *	sn1,
		const struct DDS_SequenceNumber_t *	sn2
	)

Stores the value (sn1 - sn2) in answer

Parameters

answer	<<out>> Result sequence number. Cannot be NULL.
sn1	<<in>> First sequence number. Cannot be NULL.
sn2	<<in>> Second sequence number. Cannot be NULL.

DDS_SequenceNumber_add()

void DDS_SequenceNumber_add	(	struct DDS_SequenceNumber_t *	answer,
		const struct DDS_SequenceNumber_t *	sn1,
		const struct DDS_SequenceNumber_t *	sn2
	)

Stores the value (sn1 + sn2) in answer

Parameters

answer	<<out>> Result sequence number. Cannot be NULL.
sn1	<<in>> First sequence number. Cannot be NULL.
sn2	<<in>> Second sequence number. Cannot be NULL.

DDS_SequenceNumber_plusplus()

void DDS_SequenceNumber_plusplus

(

struct DDS_SequenceNumber_t *

sn

)

Increases the value of the input sequence number by one

Parameters

sn	<<inout>> Sequence number. Cannot be NULL.

DDS_SequenceNumber_minusminus()

void DDS_SequenceNumber_minusminus

(

struct DDS_SequenceNumber_t *

sn

)

Decreases the value of the input sequence number by one

Parameters

sn	<<inout>> Sequence number. Cannot be NULL.

DDS_SequenceNumber_compare()

int DDS_SequenceNumber_compare	(	const struct DDS_SequenceNumber_t *	sn1,
		const struct DDS_SequenceNumber_t *	sn2
	)

Compares two sequence numbers.

Parameters

sn1	<<in>> Sequence number to compare. Cannot be NULL.
sn2	<<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.

Variable Documentation

DDS_SEQUENCE_NUMBER_UNKNOWN

const struct DDS_SequenceNumber_t DDS_SEQUENCE_NUMBER_UNKNOWN

extern

Unknown sequence number.

DDS_SEQUENCE_NUMBER_ZERO

const struct DDS_SequenceNumber_t DDS_SEQUENCE_NUMBER_ZERO

extern

Zero value for the sequence number.

DDS_SEQUENCE_NUMBER_MAX

const struct DDS_SequenceNumber_t DDS_SEQUENCE_NUMBER_MAX

extern

Highest, most positive value for the sequence number.

DDS_AUTO_SEQUENCE_NUMBER

const struct DDS_SequenceNumber_t DDS_AUTO_SEQUENCE_NUMBER

extern

The sequence number is internally determined by RTI Connext.