org.jgroups.stack
Class GossipClient

java.lang.Object
  org.jgroups.stack.GossipClient

public class GossipClient
extends java.lang.Object

Local stub for clients to access one (or more) GossipRouters. Will use proprietary protocol (using GossipData PDUs) based on TCP to connect to GossipRouter.

Version:

$Id: GossipClient.java,v 1.27 2008/12/10 15:15:56 vlada Exp $

Author:

Bela Ban Oct 4 2001

Field Summary

protected org.apache.commons.logging.Log

log

Constructor Summary

GossipClient(IpAddress gossip_host, long expiry, int sock_conn_timeout, TimeScheduler timer)

GossipClient(java.util.List<IpAddress> gossip_hosts, long expiry, int sock_conn_timeout, TimeScheduler timer)
Creates the GossipClient

Method Summary

void	addGossipRouter(IpAddress gossip_host) Adds a GossipRouter to be accessed.
void	destroy()
java.util.List<Address>	getMembers(java.lang.String group)
java.util.List<Address>	getMembers(java.lang.String group, long timeout) Returns all members of a given group
long	getRefreshInterval()
int	getSocketConnectionTimeout()
int	getSocketReadTimeout()
boolean	isRefresherEnabled()
static void	main(java.lang.String[] args)
void	register(java.lang.String group, Address mbr)
void	register(java.lang.String group, Address mbr, boolean synchronous) Adds the member to the given group.
void	setRefresherEnabled(boolean refresher_enabled)
void	setRefreshInterval(long refresh_interval)
void	setSocketConnectionTimeout(int sock_conn_timeout)
void	setSocketReadTimeout(int sock_read_timeout)
void	setTimer(TimeScheduler timer)
void	stop()
void	stopTimer()
void	unregister(java.lang.String group, Address mbr)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected final org.apache.commons.logging.Log log

Constructor Detail

GossipClient

public GossipClient(IpAddress gossip_host,
                    long expiry,
                    int sock_conn_timeout,
                    TimeScheduler timer)

GossipClient

public GossipClient(java.util.List<IpAddress> gossip_hosts,
                    long expiry,
                    int sock_conn_timeout,
                    TimeScheduler timer)

Creates the GossipClient

Parameters:

gossip_hosts - List of IpAddresses

expiry - Interval (in msecs) for the refresher task

Method Detail

isRefresherEnabled

public boolean isRefresherEnabled()

setRefresherEnabled

public void setRefresherEnabled(boolean refresher_enabled)

getSocketConnectionTimeout

public int getSocketConnectionTimeout()

setSocketConnectionTimeout

public void setSocketConnectionTimeout(int sock_conn_timeout)

getSocketReadTimeout

public int getSocketReadTimeout()

setSocketReadTimeout

public void setSocketReadTimeout(int sock_read_timeout)

getRefreshInterval

public long getRefreshInterval()

setRefreshInterval

public void setRefreshInterval(long refresh_interval)

setTimer

public void setTimer(TimeScheduler timer)

stop

public void stop()

stopTimer

public void stopTimer()

destroy

public void destroy()

addGossipRouter

public void addGossipRouter(IpAddress gossip_host)

Adds a GossipRouter to be accessed.

register

public void register(java.lang.String group,
                     Address mbr,
                     boolean synchronous)

Adds the member to the given group. If the group already has an entry for the member, its timestamp will be updated, preventing the cache cleaner from removing the entry.

The entry will be registered with all GossipRouters that GossipClient is configured to access

register

public void register(java.lang.String group,
                     Address mbr)

unregister

public void unregister(java.lang.String group,
                       Address mbr)

getMembers

public java.util.List<Address> getMembers(java.lang.String group,
                                          long timeout)

Returns all members of a given group

Parameters:

group - The group name

Returns:

List A list of Addresses

getMembers

public java.util.List<Address> getMembers(java.lang.String group)

main

public static void main(java.lang.String[] args)