org.axonframework.jgroups.commandhandling

Class JoinMessage

java.lang.Object

org.axonframework.jgroups.commandhandling.JoinMessage

All Implemented Interfaces:

Externalizable, Serializable

public class JoinMessage
extends Object
implements Externalizable

This message represents a notification of a Member joining the DistributedCommandBus with a given loadFactor. Upon receiving this message, members should recalculate their Consistent Hash Ring, including this member.

Since:

2.0

Author:

Allard Buijze

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JoinMessage() Default constructor required by the Streamable and Externalizable interfaces.
JoinMessage(int loadFactor, Predicate<? super CommandMessage<?>> messageFilter, int order, boolean expectReply) Initializes a JoinMessage with the given loadFactor.

Method Summary

Modifier and Type	Method and Description
int	getLoadFactor() Returns the loadFactor the member wishes to join with.
int	getOrder() The index of this message compared to others about the same sender.
boolean	isExpectReply() Indicates whether the sender of this message expects a reply
Predicate<? super CommandMessage<?>>	messageFilter() Returns the command message filter used by the member.
void	readExternal(ObjectInput in)
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

JoinMessage

public JoinMessage()

Default constructor required by the Streamable and Externalizable interfaces. Do not use directly.

JoinMessage

public JoinMessage(int loadFactor,
                   Predicate<? super CommandMessage<?>> messageFilter,
                   int order,
                   boolean expectReply)

Initializes a JoinMessage with the given loadFactor.

Parameters:

loadFactor - The loadFactor the member wishes to join with

messageFilter - A predicate the will filter command messages this node will accept.

order - The index of this update, allowing recipients to order them

expectReply - Indicates whether the sending member expects a reply with membership information

Method Detail

getLoadFactor

public int getLoadFactor()

Returns the loadFactor the member wishes to join with.

Returns:

the loadFactor the member wishes to join with.

isExpectReply

public boolean isExpectReply()

Indicates whether the sender of this message expects a reply

Returns:

whether the sender of this message expects a reply

getOrder

public int getOrder()

The index of this message compared to others about the same sender.

Returns:

the relative order of this update

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

messageFilter

public Predicate<? super CommandMessage<?>> messageFilter()

Returns the command message filter used by the member.

Returns:

the member's message filter