|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object jgroup.relacs.gm.MembershipLayer
public final class MembershipLayer
The MembershipLayer
class implements the group membership
service interface and provide membership events to listeners.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface jgroup.core.Layer |
---|
Layer.FinalizeLayer |
Field Summary |
---|
Fields inherited from interface jgroup.relacs.events.EventTags |
---|
DAEMON_FAILURE_EVENT, DELIVERY_ACK, DELIVERY_EVENT, INSTALL_ACK, INSTALL_EVENT, JOIN_REQUEST, LEAVE_REQUEST, MEMBER_LEFT_EVENT, MULTICAST_REQUEST, PREPARE_ACK, PREPARE_EVENT |
Method Summary | |
---|---|
void |
addListener(java.lang.Object listener)
Add a listener object for this layer to provide upcalls to, in response to membership events. |
void |
complete(java.lang.Object server)
Post initialization of the MembershipLayer ; invoked once
all group manager layers have been constructed. |
int[] |
eventTypes()
Returns the set of event types supported by this listener. |
int |
getGid()
Returns the group identifier. |
static MembershipLayer |
getLayer(DispatcherService dispatcher)
|
int |
getMemberIndex()
Position index of this member in the array containing the local members of the current view. |
MemberTable |
getMemberTable()
Returns a MemberTable helper object that will be
notified of changes in the membership. |
MemberId |
getMyIdentifier()
Returns the member identifier of the local member. |
int |
getViewIndex()
Position index of this member in the array containing the members of the current view. |
boolean |
isJoining()
Returns true if the GroupManager is in the process of
joining some group. |
boolean |
isLeader()
Returns true if the local member is the group leader. |
boolean |
isMember()
Returns true if the GroupManager is member of some
group. |
boolean |
isMemberOrJoining()
Returns true if the GroupManager is member of some group
or is in the process of joining some group. |
boolean |
isUnused()
|
void |
join()
Requests to join the default group associated with the Jgroup daemon. |
void |
join(int gid)
Requests to join a group identified by groupId . |
void |
leave()
Request to leave a group. |
int |
members()
Return the number of members of this group. |
void |
notifyEvent(Event event)
This method is invoked by a dispatcher to notify a listener about an event. |
java.lang.String |
toString()
Returns a string representation of this object; currently only the status and group identifier. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public static MembershipLayer getLayer(DispatcherService dispatcher) throws JgroupException
JgroupException
public void addListener(java.lang.Object listener)
addListener
in interface Layer
listener
- An Object
representation of the listener interface.
This will typically be cast to the appropriate listener interface
type after checking the type with the instanceof operator.Layer.addListener(java.lang.Object)
public void complete(java.lang.Object server) throws JgroupException
MembershipLayer
; invoked once
all group manager layers have been constructed. This method is defined
in the FinalizeLayer
inherited through the
MembershipSerivce
.
This method is used to determine if the provided server should join the
group automatically, as soon as the group manager layer stack has been
completed. By default, automatic join is disabled. To enable auto join
you must configure it in the applications.xml
file.
complete
in interface Layer.FinalizeLayer
server
- The server using a layer implementing the FinalizeLayer
interface.
JgroupException
- Thrown if the layer could not be completed.public void join() throws JgroupException
MembershipService
Each Jgroup daemon has a default group. If a Jgroup daemon does not need to be shared by multiple groups, the application servers may simply join the default group without having to specify group identifiers.
join
in interface MembershipService
JgroupException
- Raised if the membership service receives a request to join a
group to which it is already a member.public void join(int gid) throws JgroupException
MembershipService
groupId
.
join
in interface MembershipService
gid
- Non-negative integer identifying the group.
JgroupException
- Raised if the membership service receives a request to join a
group to which it is already a member.public void leave() throws JgroupException
MembershipService
hasLeft
method is invoked. After this invocation,
the member will not receive any further event notification related
to the group.
leave
in interface MembershipService
JgroupException
- Rasied if the server is not member of any group, or is already
leaving its current group.public boolean isMember()
MembershipService
GroupManager
is member of some
group. Otherwise, false is returned.
isMember
in interface MembershipService
public boolean isJoining()
MembershipService
GroupManager
is in the process of
joining some group. Otherwise, false is returned.
isJoining
in interface MembershipService
public boolean isMemberOrJoining()
MembershipService
GroupManager
is member of some group
or is in the process of joining some group. Otherwise, false is returned.
isMemberOrJoining
in interface MembershipService
public boolean isUnused()
public boolean isLeader()
MembershipService
isLeader
in interface MembershipService
public MemberId getMyIdentifier()
MembershipService
getMyIdentifier
in interface MembershipService
public int getGid()
MembershipService
getGid
in interface MembershipService
public MemberTable getMemberTable()
MembershipService
MemberTable
helper object that will be
notified of changes in the membership. This is used to provide
application developers with additional information about members
of their current view.
getMemberTable
in interface MembershipService
public int members()
MembershipService
members
in interface MembershipService
public int getViewIndex()
MembershipService
getViewIndex
in interface MembershipService
public int getMemberIndex()
MembershipService
getMemberIndex
in interface MembershipService
public int[] eventTypes()
DispatcherListener
EventTags
interface.
eventTypes
in interface DispatcherListener
public void notifyEvent(Event event)
DispatcherListener
notifyEvent
in interface DispatcherListener
event
- The Event
object to be processed.public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |