public abstract class MembershipServiceBase extends Object implements MembershipService, MembershipListener
Modifier and Type | Field and Description |
---|---|
protected Channel |
channel |
protected MembershipListener |
listener |
protected Properties |
properties
The implementation specific properties
|
MBR_RX, MBR_TX
Constructor and Description |
---|
MembershipServiceBase() |
Modifier and Type | Method and Description |
---|---|
void |
broadcast(ChannelMessage message)
Broadcasts a message to all members.
|
Member |
findMemberByName(String name)
Get a member.
|
Channel |
getChannel()
Return the channel that is related to this MembershipService
|
Member |
getMember(Member mbr)
Retrieve the specified member from the membership.
|
Member[] |
getMembers() |
String[] |
getMembersByName() |
Properties |
getProperties() |
boolean |
hasMembers() |
void |
memberAdded(Member member)
A member was added to the group
|
void |
memberDisappeared(Member member)
A member was removed from the group
If the member left voluntarily, the Member.getCommand will contain the Member.SHUTDOWN_PAYLOAD data |
void |
removeMembershipListener()
Removes the membership listener.
|
void |
setChannel(Channel channel)
Set the channel that is related to this MembershipService
|
void |
setMembershipListener(MembershipListener listener)
Sets the membership listener, only one listener can be added.
|
void |
setProperties(Properties properties)
Sets the properties for the membership service.
|
void |
start()
Starts the membership service.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getLocalMember, getMembershipProvider, setDomain, setLocalMemberProperties, setPayload, start, stop
protected Properties properties
protected volatile MembershipListener listener
protected Channel channel
public void setProperties(Properties properties)
start()
method is called.
The properties are implementation specific.setProperties
in interface MembershipService
properties
- - to be used to configure the membership service.public Properties getProperties()
getProperties
in interface MembershipService
public boolean hasMembers()
hasMembers
in interface MembershipService
public Member getMember(Member mbr)
MembershipService
getMember
in interface MembershipService
mbr
- The member to retrievepublic Member[] getMembers()
getMembers
in interface MembershipService
public String[] getMembersByName()
getMembersByName
in interface MembershipService
public Member findMemberByName(String name)
MembershipService
findMemberByName
in interface MembershipService
name
- The member namepublic void setMembershipListener(MembershipListener listener)
MembershipService
setMembershipListener
in interface MembershipService
listener
- The listenerpublic void removeMembershipListener()
MembershipService
removeMembershipListener
in interface MembershipService
public void memberAdded(Member member)
MembershipListener
memberAdded
in interface MembershipListener
member
- Member - the member that was addedpublic void memberDisappeared(Member member)
MembershipListener
memberDisappeared
in interface MembershipListener
member
- MemberMember.SHUTDOWN_PAYLOAD
public void broadcast(ChannelMessage message) throws ChannelException
MembershipService
broadcast
in interface MembershipService
message
- The message to broadcastChannelException
- Message broadcast failedpublic Channel getChannel()
MembershipService
getChannel
in interface MembershipService
public void setChannel(Channel channel)
MembershipService
setChannel
in interface MembershipService
channel
- The channelpublic void start() throws Exception
MembershipService
start
in interface MembershipService
Exception
- if the service fails to start.Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.