Class McastService
java.lang.Object
org.apache.catalina.tribes.membership.McastService
- All Implemented Interfaces:
- McastServiceMBean,- MembershipListener,- MembershipService,- MessageListener
public class McastService
extends Object
implements MembershipService, MembershipListener, MessageListener, McastServiceMBean
A membership implementation using simple multicast.
 This is the representation of a multicast membership service.
 This class is responsible for maintaining a list of active cluster nodes in the cluster.
 If a node fails to send out a heartbeat, the node will be dismissed.
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected byte[]protected static final Member[]Return all the membersprotected McastServiceImplA handle to the actual low level implementationprotected MembershipListenerA membership listener delegate (should be the cluster :)protected MemberImplThe local memberprotected MessageListenerA message listener delegate for broadcastsprotected byte[]protected PropertiesThe implementation specific propertiesprotected static final StringManagerThe string manager for this package.Fields inherited from interface org.apache.catalina.tribes.MembershipServiceMBR_RX, MBR_TX
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionbooleanaccept(ChannelMessage msg) voidbroadcast(ChannelMessage message) Broadcasts a message to all members.findMemberByName(String name) Return the member by namegetBind()Return the channel that is related to this MembershipServicebyte[]longlongbooleangetLocalMember(boolean alive) Get the local member.Retrieve the specified member from the membership.Member[]String[]Return all the members by namebyte[]intgetPort()intbooleanlongintintgetTtl()booleanhas members?protected voidhasProperty(Properties properties, String name) Check if a required property is available.static voidSimple test programvoidmemberAdded(Member member) A member was added to the groupvoidmemberDisappeared(Member member) Callback from the impl when a new member has been receivedvoidReceive a message from the IO components in the Channel stackvoidRemove the membership listenervoidvoidsetAddress(String addr) voidvoidsetChannel(Channel channel) Set the channel that is related to this MembershipServiceprotected voidsetDefaults(Properties properties) voidsetDomain(byte[] domain) voidvoidsetDropTime(long time) voidsetFrequency(long time) voidsetLocalLoopbackDisabled(boolean localLoopbackDisabled) voidsetLocalMemberProperties(String listenHost, int listenPort, int securePort, int udpPort) Sets the local member properties for broadcasting.voidsetMcastBindAddress(String bindaddr) voidsetMcastDropTime(long time) voidsetMembershipListener(MembershipListener listener) Add a membership listener, this version only supports one listener per service, so calling this method twice will result in only the second listener being active.voidsetMessageListener(MessageListener listener) voidsetPayload(byte[] payload) Set a payload to be broadcasted with each membership broadcast.voidsetPort(int port) voidsetProperties(Properties properties) Sets the properties for the membership service.voidsetRecoveryCounter(int recoveryCounter) voidsetRecoveryEnabled(boolean recoveryEnabled) voidsetRecoverySleepTime(long recoverySleepTime) voidsetSoTimeout(int mcastSoTimeout) voidsetTtl(int mcastTTL) voidstart()Start broadcasting and listening to membership pingsvoidstart(int level) Starts the membership service.voidstop(int svc) Stop broadcasting and listening to membership pings
- 
Field Details- 
smThe string manager for this package.
- 
propertiesThe implementation specific properties
- 
implA handle to the actual low level implementation
- 
listenerA membership listener delegate (should be the cluster :)
- 
msglistenerA message listener delegate for broadcasts
- 
localMemberThe local member
- 
payloadprotected byte[] payload
- 
domainprotected byte[] domain
- 
EMPTY_MEMBERSReturn all the members
 
- 
- 
Constructor Details- 
McastServicepublic McastService()Create a membership service.
 
- 
- 
Method Details- 
setPropertiesSets the properties for the membership service.- Specified by:
- setPropertiesin interface- MembershipService
- Parameters:
- properties-
 All are required
 1. mcastPort - the port to listen to
 2. mcastAddress - the mcast group address
 4. bindAddress - the bind address if any - only one that can be null
 5. memberDropTime - the time a member is gone before it is considered gone.
 6. mcastFrequency - the frequency of sending messages
 7. tcpListenPort - the port this member listens to
 8. tcpListenHost - the bind address of this member
- Throws:
- IllegalArgumentException- if a property is missing.
 
- 
getProperties- Specified by:
- getPropertiesin interface- McastServiceMBean
- Specified by:
- getPropertiesin interface- MembershipService
- Returns:
- the properties for the configuration used.
 
- 
getLocalMemberName- Specified by:
- getLocalMemberNamein interface- McastServiceMBean
- Returns:
- the local member name
 
- 
getLocalMemberDescription copied from interface:MembershipServiceGet the local member.- Specified by:
- getLocalMemberin interface- MembershipService
- Parameters:
- alive-- trueto set the alive time on the local member
- Returns:
- the member object that defines this member
 
- 
setLocalMemberPropertiespublic void setLocalMemberProperties(String listenHost, int listenPort, int securePort, int udpPort) Description copied from interface:MembershipServiceSets the local member properties for broadcasting.- Specified by:
- setLocalMemberPropertiesin interface- MembershipService
- Parameters:
- listenHost- Listen to host
- listenPort- Listen to port
- securePort- Use a secure port
- udpPort- Use UDP
 
- 
setAddress
- 
getAddress- Specified by:
- getAddressin interface- McastServiceMBean
 
- 
setMcastBindAddress
- 
setBind
- 
getBind- Specified by:
- getBindin interface- McastServiceMBean
 
- 
setPortpublic void setPort(int port) 
- 
setRecoveryCounterpublic void setRecoveryCounter(int recoveryCounter) 
- 
getRecoveryCounterpublic int getRecoveryCounter()- Specified by:
- getRecoveryCounterin interface- McastServiceMBean
 
- 
setRecoveryEnabledpublic void setRecoveryEnabled(boolean recoveryEnabled) 
- 
getRecoveryEnabledpublic boolean getRecoveryEnabled()- Specified by:
- getRecoveryEnabledin interface- McastServiceMBean
 
- 
setRecoverySleepTimepublic void setRecoverySleepTime(long recoverySleepTime) 
- 
getRecoverySleepTimepublic long getRecoverySleepTime()- Specified by:
- getRecoverySleepTimein interface- McastServiceMBean
 
- 
setLocalLoopbackDisabledpublic void setLocalLoopbackDisabled(boolean localLoopbackDisabled) 
- 
getLocalLoopbackDisabledpublic boolean getLocalLoopbackDisabled()- Specified by:
- getLocalLoopbackDisabledin interface- McastServiceMBean
 
- 
getPortpublic int getPort()- Specified by:
- getPortin interface- McastServiceMBean
 
- 
setFrequencypublic void setFrequency(long time) 
- 
getFrequencypublic long getFrequency()- Specified by:
- getFrequencyin interface- McastServiceMBean
 
- 
setMcastDropTimepublic void setMcastDropTime(long time) 
- 
setDropTimepublic void setDropTime(long time) 
- 
getDropTimepublic long getDropTime()- Specified by:
- getDropTimein interface- McastServiceMBean
 
- 
hasPropertyCheck if a required property is available.- Parameters:
- properties- The set of properties
- name- The property to check for
 
- 
startStart broadcasting and listening to membership pings- Specified by:
- startin interface- MembershipService
- Throws:
- Exception- if a IO error occurs
 
- 
startDescription copied from interface:MembershipServiceStarts the membership service. If a membership listeners is added the listener will start to receive membership events.- Specified by:
- startin interface- MembershipService
- Parameters:
- level- - level MBR_RX starts listening for members, level MBR_TX starts broad casting the server
- Throws:
- Exception- if the service fails to start.
- IllegalArgumentException- if the level is incorrect.
 
- 
stoppublic void stop(int svc) Stop broadcasting and listening to membership pings- Specified by:
- stopin interface- MembershipService
- Parameters:
- svc- - level MBR_RX stops listening for members, level MBR_TX stops broad casting the server
 
- 
getMembersByNameReturn all the members by name- Specified by:
- getMembersByNamein interface- McastServiceMBean
- Specified by:
- getMembersByNamein interface- MembershipService
- Returns:
- all members by name
 
- 
findMemberByNameReturn the member by name- Specified by:
- findMemberByNamein interface- McastServiceMBean
- Specified by:
- findMemberByNamein interface- MembershipService
- Parameters:
- name- The member name
- Returns:
- the member
 
- 
hasMemberspublic boolean hasMembers()has members?- Specified by:
- hasMembersin interface- McastServiceMBean
- Specified by:
- hasMembersin interface- MembershipService
- Returns:
- true if the the group contains members
 
- 
getMemberDescription copied from interface:MembershipServiceRetrieve the specified member from the membership.- Specified by:
- getMemberin interface- MembershipService
- Parameters:
- mbr- The member to retrieve
- Returns:
- the member
 
- 
getMembers- Specified by:
- getMembersin interface- MembershipService
- Returns:
- a list of all the members in the cluster.
 
- 
setMembershipListenerAdd a membership listener, this version only supports one listener per service, so calling this method twice will result in only the second listener being active.- Specified by:
- setMembershipListenerin interface- MembershipService
- Parameters:
- listener- The listener
 
- 
setMessageListener
- 
removeMessageListenerpublic void removeMessageListener()
- 
removeMembershipListenerpublic void removeMembershipListener()Remove the membership listener- Specified by:
- removeMembershipListenerin interface- MembershipService
 
- 
memberAddedDescription copied from interface:MembershipListenerA member was added to the group- Specified by:
- memberAddedin interface- MembershipListener
- Parameters:
- member- Member - the member that was added
 
- 
memberDisappearedCallback from the impl when a new member has been received- Specified by:
- memberDisappearedin interface- MembershipListener
- Parameters:
- member- The member
- See Also:
 
- 
messageReceivedDescription copied from interface:MessageListenerReceive a message from the IO components in the Channel stack- Specified by:
- messageReceivedin interface- MessageListener
- Parameters:
- msg- ChannelMessage
 
- 
accept- Specified by:
- acceptin interface- MessageListener
 
- 
broadcastDescription copied from interface:MembershipServiceBroadcasts a message to all members.- Specified by:
- broadcastin interface- MembershipService
- Parameters:
- message- The message to broadcast
- Throws:
- ChannelException- Message broadcast failed
 
- 
getSoTimeoutpublic int getSoTimeout()- Specified by:
- getSoTimeoutin interface- McastServiceMBean
 
- 
setSoTimeoutpublic void setSoTimeout(int mcastSoTimeout) 
- 
getTtlpublic int getTtl()- Specified by:
- getTtlin interface- McastServiceMBean
 
- 
getPayloadpublic byte[] getPayload()
- 
getDomainpublic byte[] getDomain()- Specified by:
- getDomainin interface- McastServiceMBean
 
- 
setTtlpublic void setTtl(int mcastTTL) 
- 
setPayloadpublic void setPayload(byte[] payload) Description copied from interface:MembershipServiceSet a payload to be broadcasted with each membership broadcast.- Specified by:
- setPayloadin interface- MembershipService
- Parameters:
- payload- byte[]
 
- 
setDomainpublic void setDomain(byte[] domain) - Specified by:
- setDomainin interface- MembershipService
 
- 
setDomain
- 
getChannelDescription copied from interface:MembershipServiceReturn the channel that is related to this MembershipService- Specified by:
- getChannelin interface- MembershipService
- Returns:
- Channel
 
- 
setChannelDescription copied from interface:MembershipServiceSet the channel that is related to this MembershipService- Specified by:
- setChannelin interface- MembershipService
- Parameters:
- channel- The channel
 
- 
setDefaults
- 
mainSimple test program- Parameters:
- args- Command-line arguments
- Throws:
- Exception- If an error occurs
 
 
-