jarol.messages
Interface MessageHeader

All Superinterfaces:

MessagePart

public interface MessageHeader
extends MessagePart

Message header interface. Each message group has its own way of encoding the header. An header is seen as an object encoding at least the message id, the message payload in bytes and the message timestamp.

Version:

0.1

Author:

Eduardo Marques

Method Summary

int	getMessageId() Get the message id.
int	getPayloadSize() Get the length in bytes of the message payload
long	getSequenceId() Get sequence id encoded in header
double	getTimestamp() Get the header timestamp field
void	setMessageId(int id) Set message id.
void	setPayloadSize(int payload) Set payload header field in bytes.
void	setSequenceId(long seqid) Set sequence id field in header.
void	setTimestamp(double timestamp) Set timestamp header field.

Methods inherited from interface jarol.messages.MessagePart

dump, serialize, serialSize, unserialize, validate

Method Detail

getMessageId

int getMessageId()

Get the message id.

Returns:

message id

getPayloadSize

int getPayloadSize()

Get the length in bytes of the message payload

Returns:

payload size

getSequenceId

long getSequenceId()

Get sequence id encoded in header

Returns:

sequence id in header field

getTimestamp

double getTimestamp()

Get the header timestamp field

Returns:

header timestamp

setMessageId

void setMessageId(int id)

Set message id.

Parameters:

id - the message id

setPayloadSize

void setPayloadSize(int payload)

Set payload header field in bytes.

Parameters:

payload - length in bytes of the message payload

setSequenceId

void setSequenceId(long seqid)

Set sequence id field in header.

Parameters:

seqid - sequence id

setTimestamp

void setTimestamp(double timestamp)

Set timestamp header field.

Parameters:

timestamp - value of the timestamp