net.openhft.chronicle.wire

Class MessagePathClassifier

java.lang.Object

net.openhft.chronicle.wire.MessagePathClassifier

All Implemented Interfaces:

IntSupplier

public class MessagePathClassifier
extends Object
implements IntSupplier

Classifies message paths based on the history of each message.

In systems where messages may traverse several hops, known routes can be registered as patterns of source IDs. Each pattern is linked to a pathId which can later be used for metrics, monitoring or routing decisions. The longest matching pattern wins.

Implements IntSupplier so the current thread's MessageHistory can be classified directly via getAsInt().

Constructor Summary

Constructors

Constructor and Description
MessagePathClassifier()

Method Summary

Modifier and Type	Method and Description
MessagePathClassifier	addPathForSourcesEnding(int pathId, int... sources) Registers a path ID for message histories that end with the supplied sequence of source IDs.
int	getAsInt() Returns the path ID for the current thread's MessageHistory.
int	pathFor(MessageHistory messageHistory) Determines the pathId for the supplied history.
String	toString() Returns a readable representation of the classifier state.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessagePathClassifier

public MessagePathClassifier()

Method Detail

addPathForSourcesEnding

public MessagePathClassifier addPathForSourcesEnding(int pathId,
                                                     int... sources)

Registers a path ID for message histories that end with the supplied sequence of source IDs.

This method enables the user to define how the classifier should categorize certain patterns of message history.

Parameters:

pathId - the identifier to associate with this pattern

sources - the sequence of source IDs that must appear at the end of a message history

Returns:

this classifier for chaining

Throws:

IllegalArgumentException - if the same sequence is registered with a different pathId

getAsInt

public int getAsInt()

Returns the path ID for the current thread's MessageHistory.

Specified by:

getAsInt in interface IntSupplier

pathFor

public int pathFor(MessageHistory messageHistory)

Determines the pathId for the supplied history.

All registered patterns are checked and the longest matching suffix is selected.

Parameters:

messageHistory - the history to classify

Returns:

the matching path ID

Throws:

IllegalStateException - if none of the patterns apply

toString

public String toString()

Returns a readable representation of the classifier state.

Overrides:

toString in class Object