co.cask.cdap.messaging.data

Class MessageId

java.lang.Object

co.cask.cdap.messaging.data.MessageId

public class MessageId
extends Object

Uniquely identifies a message in the Messaging System.

See Also:

Design documentation

Field Summary

Fields

Modifier and Type	Field and Description
static int	RAW_ID_SIZE

Constructor Summary

Constructors

Constructor and Description
MessageId(byte[] rawId) Creates a instance based on the given raw id bytes.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
short	getPayloadSequenceId() Returns the sequence id generated when the message was written to the Payload Table.
long	getPayloadWriteTimestamp() Returns the timestamp when the message was written to the Payload Table.
long	getPublishTimestamp() Returns the publish timestamp in milliseconds of the message.
byte[]	getRawId() Returns the raw bytes representation of the message id.
short	getSequenceId() Returns the sequence id generated when the message was written.
int	hashCode()
static int	putRawId(long publishTimestamp, short sequenceId, long writeTimestamp, short payloadSequenceId, byte[] buffer, int offset) Computes the message raw ID and store it in the given byte array.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

RAW_ID_SIZE

public static final int RAW_ID_SIZE

See Also:

Constant Field Values

Constructor Detail

MessageId

public MessageId(byte[] rawId)

Creates a instance based on the given raw id bytes. The provided byte array will be store as is without copying.

Method Detail

putRawId

public static int putRawId(long publishTimestamp,
                           short sequenceId,
                           long writeTimestamp,
                           short payloadSequenceId,
                           byte[] buffer,
                           int offset)

Computes the message raw ID and store it in the given byte array.

Parameters:

publishTimestamp - publish timestamp of the message

sequenceId - publish sequence id of the message

writeTimestamp - write timestamp in the payload table of the message

payloadSequenceId - sequence id in the payload table of the message

buffer - the buffer to encode raw id to

offset - the starting offset in the buffer for storing the raw message id

Returns:

the offset in the buffer that points to the index right after then end of the raw message id

getPublishTimestamp

public long getPublishTimestamp()

Returns the publish timestamp in milliseconds of the message.

getSequenceId

public short getSequenceId()

Returns the sequence id generated when the message was written.

getPayloadWriteTimestamp

public long getPayloadWriteTimestamp()

Returns the timestamp when the message was written to the Payload Table. If the message is not from the Payload Table, 0 will be returned.

getPayloadSequenceId

public short getPayloadSequenceId()

Returns the sequence id generated when the message was written to the Payload Table. If the message is not from the Payload Table, 0 will be returned.

getRawId

public byte[] getRawId()

Returns the raw bytes representation of the message id.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object