org.apache.catalina.tribes
public interface MembershipService
MembershipService
interface is the membership component
at the bottom layer, the IO layer (for layers see the javadoc for the Channel interface).Version: $Revision: 467222 $, $Date: 2006-10-24 05:17:11 +0200 (Tue, 24 Oct 2006) $
Field Summary | |
---|---|
static int | MBR_RX |
static int | MBR_TX |
Method Summary | |
---|---|
Member | findMemberByName(String name)
Return the member by name |
Member | getLocalMember(boolean incAliveTime)
Returns the member object that defines this member |
Member | getMember(Member mbr) |
Member[] | getMembers()
Returns a list of all the members in the cluster. |
String[] | getMembersByName()
Return all members by name |
Properties | getProperties()
Returns the properties for the configuration used. |
boolean | hasMembers() |
void | removeMembershipListener()
removes the membership listener. |
void | setDomain(byte[] domain) |
void | setLocalMemberProperties(String listenHost, int listenPort)
Sets the local member properties for broadcasting |
void | setMembershipListener(MembershipListener listener)
Sets the membership listener, only one listener can be added.
|
void | setPayload(byte[] payload)
Set a payload to be broadcasted with each membership
broadcast. |
void | setProperties(Properties properties)
Sets the properties for the membership service. |
void | start()
Starts the membership service. |
void | start(int level)
Starts the membership service. |
void | stop(int level)
Starts the membership service. |
Parameters: mbr Member
Returns: Member
Returns: true if the the group contains members
Parameters: listener The listener
Parameters: payload byte[]
start()
method is called.
The properties are implementation specific.Parameters: properties - to be used to configure the membership service.
Throws: java.lang.Exception if the service fails to start.
Parameters: level - level MBR_RX starts listening for members, level MBR_TX starts broad casting the server
Throws: java.lang.Exception if the service fails to start. java.lang.IllegalArgumentException if the level is incorrect.
Parameters: level - level MBR_RX stops listening for members, level MBR_TX stops broad casting the server
Throws: java.lang.Exception if the service fails to stop java.lang.IllegalArgumentException if the level is incorrect.