net.sf.jrtps.message

Class Header

java.lang.Object

net.sf.jrtps.message.Header

public class Header
extends Object

The Header identifies the message as belonging to the RTPS protocol. The Header identifies the version of the protocol and the vendor that sent the message.

Author:

mcr70

Constructor Summary

Constructors

Constructor and Description
Header(GuidPrefix prefix) Constructor for Header.
Header(GuidPrefix prefix, ProtocolVersion version, VendorId vendorId) Constructor with given values.

Method Summary

Modifier and Type	Method and Description
GuidPrefix	getGuidPrefix() Defines a default prefix to use for all GUIDs that appear within the Submessages contained in the message.
VendorId	getVendorId() Indicates the vendor that provides the implementation of the RTPS protocol.
ProtocolVersion	getVersion() Identifies the version of the RTPS protocol.
String	toString()
void	writeTo(RTPSByteBuffer bb) Writer this Header to given RTPSByteBuffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

Header

public Header(GuidPrefix prefix)

Constructor for Header. ProtocolVersion is set to 2.1 and VendorId is set to jRTPS.

Parameters:

prefix - GuidPrefix of the header

Header

public Header(GuidPrefix prefix,
              ProtocolVersion version,
              VendorId vendorId)

Constructor with given values.

Parameters:

prefix - GuidPrefix

version - Version of the RTPS protocol

vendorId - VendorId

Method Detail

writeTo

public void writeTo(RTPSByteBuffer bb)

Writer this Header to given RTPSByteBuffer.

Parameters:

bb - RTPSByteBuffer to write to

getGuidPrefix

public GuidPrefix getGuidPrefix()

Defines a default prefix to use for all GUIDs that appear within the Submessages contained in the message.

Returns:

GuidPrefix associated with submessages

getVendorId

public VendorId getVendorId()

Indicates the vendor that provides the implementation of the RTPS protocol.

Returns:

VendorId

getVersion

public ProtocolVersion getVersion()

Identifies the version of the RTPS protocol.

Returns:

ProtocolVersion

toString

public String toString()

Overrides:

toString in class Object