Public Member Functions
	CorrelationId (String correlationAsText)

	CorrelationId ()

String	toString ()

long	getUnderlyingId ()

boolean	equals (Object o)

int	hashCode ()

Static Public Attributes
static final CorrelationId	EMPTY_CORRELATION = new CorrelationId("0")

Detailed Description

A correlation ID that allows events sent from the client or server to be linked via this ID. Calling the constructor with no parameters creates a new correlation. These are only unique for a time frame of hours to days. They should not be used for any purpose requiring persistence that could extend beyond that.

Constructor & Destructor Documentation

◆ CorrelationId() [1/2]

com.thecoderscorner.menu.remote.protocol.CorrelationId.CorrelationId ( String correlationAsText )

Creates a correlation id with the specified value, for existing correlation ids

Parameters

correlationAsText the id to be represented

◆ CorrelationId() [2/2]

com.thecoderscorner.menu.remote.protocol.CorrelationId.CorrelationId ( )

Creates a new correlation ID that is relatively unique

Member Function Documentation

◆ getUnderlyingId()

long com.thecoderscorner.menu.remote.protocol.CorrelationId.getUnderlyingId ( )

Gets the underlying ID.

Returns

◆ toString()

String com.thecoderscorner.menu.remote.protocol.CorrelationId.toString ( )

Gets the value of the ID as a hex string

Returns: the correlation ID as a hex string.

The documentation for this class was generated from the following file:

src/main/java/com/thecoderscorner/menu/remote/protocol/CorrelationId.java

Public Member Functions