org.apache.catalina.tribes

Interface Member

public interface Member

The Member interface, defines a member in the group. Each member can carry a set of properties, defined by the actual implementation.
A member is identified by the host/ip/uniqueId
The host is what interface the member is listening to, to receive data
The port is what port the member is listening to, to receive data
The uniqueId defines the session id for the member. This is an important feature since a member that has crashed and the starts up again on the same port/host is not guaranteed to be the same member, so no state transfers will ever be confused

Version: $Revision: 467222 $, $Date: 2006-10-24 05:17:11 +0200 (Tue, 24 Oct 2006) $

Author: Filip Hanik

Field Summary
static byte[]SHUTDOWN_PAYLOAD
When a member leaves the cluster, the payload of the memberDisappeared member will be the following bytes.
Method Summary
byte[]getCommand()
returns the command associated with this member
byte[]getDomain()
Domain for this cluster
byte[]getHost()
Returns the listen host for the ChannelReceiver implementation
longgetMemberAliveTime()
Contains information on how long this member has been online.
StringgetName()
Returns the name of this node, should be unique within the group.
byte[]getPayload()
returns the payload associated with this member
intgetPort()
Returns the listen port for the ChannelReceiver implementation
intgetSecurePort()
Returns the secure listen port for the ChannelReceiver implementation.
byte[]getUniqueId()
returns a UUID unique for this member over all sessions.
booleanisFailing()
booleanisReady()
The current state of the member
booleanisSuspect()
The current state of the member

Field Detail

SHUTDOWN_PAYLOAD

public static final byte[] SHUTDOWN_PAYLOAD
When a member leaves the cluster, the payload of the memberDisappeared member will be the following bytes. This indicates a soft shutdown, and not a crash

Method Detail

getCommand

public byte[] getCommand()
returns the command associated with this member

Returns: byte[]

getDomain

public byte[] getDomain()
Domain for this cluster

Returns: byte[]

getHost

public byte[] getHost()
Returns the listen host for the ChannelReceiver implementation

Returns: IPv4 or IPv6 representation of the host address this member listens to incoming data

See Also: ChannelReceiver

getMemberAliveTime

public long getMemberAliveTime()
Contains information on how long this member has been online. The result is the number of milli seconds this member has been broadcasting its membership to the group.

Returns: nr of milliseconds since this member started.

getName

public String getName()
Returns the name of this node, should be unique within the group.

getPayload

public byte[] getPayload()
returns the payload associated with this member

Returns: byte[]

getPort

public int getPort()
Returns the listen port for the ChannelReceiver implementation

Returns: the listen port for this member, -1 if its not listening on an unsecure port

See Also: ChannelReceiver

getSecurePort

public int getSecurePort()
Returns the secure listen port for the ChannelReceiver implementation. Returns -1 if its not listening to a secure port.

Returns: the listen port for this member, -1 if its not listening on a secure port

See Also: ChannelReceiver

getUniqueId

public byte[] getUniqueId()
returns a UUID unique for this member over all sessions. If the member crashes and restarts, the uniqueId will be different.

Returns: byte[]

isFailing

public boolean isFailing()

Returns: boolean - true if the member has been confirmed to malfunction

isReady

public boolean isReady()
The current state of the member

Returns: boolean - true if the member is functioning correctly

isSuspect

public boolean isSuspect()
The current state of the member

Returns: boolean - true if the member is suspect, but the crash has not been confirmed

Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.