com.tenduke.networking.peergroup
Interface PeerGroupWrapper

All Known Subinterfaces:

GroupRequestPeerGroupWrapper

All Known Implementing Classes:

JGroupsPeerGroup, StaticConfiguredGlobalPeerGroup

public interface PeerGroupWrapper

Interface for peer group implementations.

Method Summary

void	cleanup() Calling cleanup gives the peer group implementation a chance to shut down gracefully and clean up.
int	getNumRegisterPeerGroupEventListeners() Returning number of listeners registered with registerPeerGroupEventListener.
boolean	joinGroup(java.lang.String groupName) Joining a group.
boolean	leaveAllGroups() Leaving all groups.
boolean	leaveGroup(java.lang.String groupName) Leaving a group.
int	registerPeerGroupEventListener(PeerGroupEventListener observer) Registering listener for peer group events.
int	unregisterPeerGroupEventListener(PeerGroupEventListener observer) Unregistering peer group event listener.

Method Detail

cleanup

void cleanup()
             throws java.lang.InterruptedException

Calling cleanup gives the peer group implementation a chance to shut down gracefully and clean up.

Throws:

java.lang.InterruptedException - Operation was interrupted while the cleanup was going on.

getNumRegisterPeerGroupEventListeners

int getNumRegisterPeerGroupEventListeners()

Returning number of listeners registered with registerPeerGroupEventListener.

Returns:

Number of listeners registered with registerPeerGroupEventListener.

joinGroup

boolean joinGroup(java.lang.String groupName)

Joining a group. Depending on peer group implementation, each peer can join one or more groups.

Parameters:

groupName - Name of the group to join.

Returns:

Returns true if join is accepted.

leaveAllGroups

boolean leaveAllGroups()

Leaving all groups.

Returns:

Returns true if leave is accepted.

leaveGroup

boolean leaveGroup(java.lang.String groupName)

Leaving a group.

Parameters:

groupName - Name of the group to leave.

Returns:

Returns true if leave is accepted.

registerPeerGroupEventListener

int registerPeerGroupEventListener(PeerGroupEventListener observer)

Registering listener for peer group events.

Parameters:

observer - The listener object

Returns:

Number of registered listeners after registering the new listener

unregisterPeerGroupEventListener

int unregisterPeerGroupEventListener(PeerGroupEventListener observer)

Unregistering peer group event listener.

Parameters:

observer - The listener object.

Returns:

Number of registered listeners after unregistering the listener.