net.sf.jrtps.message

Class Gap

java.lang.Object

net.sf.jrtps.message.SubMessage

net.sf.jrtps.message.Gap

public class Gap
extends SubMessage

This Submessage is sent from an RTPS Writer to an RTPS Reader and indicates to the RTPS Reader that a range of sequence numbers is no longer relevant. The set may be a contiguous range of sequence numbers or a specific set of sequence numbers.

see 8.3.7.4 Gap, 9.4.5.5 Gap Submessage

Author:

mcr70

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.jrtps.message.SubMessage

SubMessage.Kind

Field Summary

Fields

Modifier and Type	Field and Description
static int	KIND

Fields inherited from class net.sf.jrtps.message.SubMessage

header

Constructor Summary

Constructors

Constructor and Description
Gap(EntityId readerId, EntityId writerId, long gapStart, long gapEnd)

Method Summary

Modifier and Type	Method and Description
long	getGapEnd() Gets the last sequence number in this Gap.
SequenceNumberSet	getGapList() SequenceNumberSet.bitmapBase - 1 is the last sequence number of irrelevant seq nums.
long	getGapStart() Identifies the first sequence number in the interval of irrelevant sequence numbers.
EntityId	getReaderId() Get the Reader Entity that is being informed of the irrelevance of a set of sequence numbers.
EntityId	getWriterId() Get the Writer Entity to which the range of sequence numbers applies.
String	toString()
void	writeTo(RTPSByteBuffer bb) Writes this SubMessage into given RTPSByteBuffer.

Methods inherited from class net.sf.jrtps.message.SubMessage

getHeader, getKind

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

KIND

public static final int KIND

See Also:

Constant Field Values

Constructor Detail

Gap

public Gap(EntityId readerId,
           EntityId writerId,
           long gapStart,
           long gapEnd)

Method Detail

getReaderId

public EntityId getReaderId()

Get the Reader Entity that is being informed of the irrelevance of a set of sequence numbers.

Returns:

EntityId of the reader

getWriterId

public EntityId getWriterId()

Get the Writer Entity to which the range of sequence numbers applies.

Returns:

EntityId of the writer

getGapStart

public long getGapStart()

Identifies the first sequence number in the interval of irrelevant sequence numbers.

Returns:

First irrelevant sequence number

getGapEnd

public long getGapEnd()

Gets the last sequence number in this Gap.

Returns:

last sequence number

getGapList

public SequenceNumberSet getGapList()

SequenceNumberSet.bitmapBase - 1 is the last sequence number of irrelevant seq nums. SequenceNumberSet.bitmaps identifies additional irrelevant sequence numbers.

Returns:

SequenceNumberSet

writeTo

public void writeTo(RTPSByteBuffer bb)

Description copied from class: SubMessage

Writes this SubMessage into given RTPSByteBuffer.

Specified by:

writeTo in class SubMessage

Parameters:

bb - RTPSByteBuffer

toString

public String toString()

Overrides:

toString in class SubMessage