org.jgroups.protocols

Class TCPGOSSIP

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.Discovery

org.jgroups.protocols.TCPGOSSIP

All Implemented Interfaces:

RouterStub.MembersNotification

public class TCPGOSSIP
extends Discovery
implements RouterStub.MembersNotification

The TCPGOSSIP protocol layer retrieves the initial membership (used by the GMS when started by sending event FIND_INITIAL_MBRS down the stack). We do this by contacting one or more GossipRouters, which must be running at well-known addresses:ports. The responses should allow us to determine the coordinator whom we have to contact, e.g. in case we want to join the group. When we are a server (after having received the BECOME_SERVER event), we'll respond to TCPGOSSIP requests with a TCPGOSSIP response.

The FIND_INITIAL_MBRS event will eventually be answered with a FIND_INITIAL_MBRS_OK event up the stack.

Author:

Bela Ban

Nested Class Summary

Nested classes/interfaces inherited from class org.jgroups.protocols.Discovery

Discovery.DiscoveryCacheDisseminationTask

Field Summary

Fields

Modifier and Type	Field and Description
protected RouterStubManager	stubManager
protected boolean	use_nio

Fields inherited from class org.jgroups.protocols.Discovery

always_send_physical_addr_with_discovery_request, async_discovery, async_discovery_use_separate_thread_per_request, break_on_coord_rsp, cluster_name, current_coord, discovery_rsp_expiry_time, force_sending_discovery_rsps, is_coord, is_leaving, is_server, local_addr, max_members_in_discovery_request, members, num_discovery_requests, num_initial_members, num_initial_srv_members, ping_responses, return_entire_cache, send_cache_on_join, stagger_timeout, timeout, timer, transport_supports_multicasting, use_disk_cache, view, WHITESPACE

Fields inherited from class org.jgroups.stack.Protocol

after_creation_hook, down_prot, ergonomics, id, log, name, stack, stats, up_prot

Constructor Summary

Constructors

Constructor and Description
TCPGOSSIP()

Method Summary

Modifier and Type	Method and Description
void	addInitialHost(java.lang.String hostname, int port)
void	destroy() This method is called on a Channel.close().
void	findMembers(java.util.List<Address> members, boolean initial_discovery, Responses responses) Fetches information (e.g.
java.util.List<java.net.InetSocketAddress>	getInitialHosts()
RouterStubManager	getStubManager()
void	handleConnect()
void	handleDisconnect()
void	init() Called after instance has been created (null constructor) and before protocol is started.
boolean	isDynamic()
void	members(java.util.List<PingData> mbrs)
java.lang.String	print()
java.lang.String	printReconnectList()
java.lang.String	printStubs()
boolean	removeInitialHost(java.lang.String hostname, int port)
void	setInitialHosts(java.util.List<java.net.InetSocketAddress> hosts)
void	start() This method is called on a Channel.connect(String).
void	stop() This method is called on a Channel.disconnect().

Methods inherited from class org.jgroups.protocols.Discovery

addDiscoveryResponseToCaches, addResponse, addressAsString, addToCache, breakOnCoordResponse, breakOnCoordResponse, deserialize, discoveryRequestReceived, discoveryRspExpiryTime, disseminateDiscoveryInformation, down, dumpCache, findInitialMembersAsString, findMembers, forceDiscoveryResponses, forceDiscoveryResponses, getCurrentCoord, getNumberOfDiscoveryRequestsSent, getNumInitialMembers, getTimeout, getView, getViewId, handleDiscoveryResponse, isCoord, isMergeRunning, marshal, numInitialMembers, numInitialMembers, providedUpServices, read, readPingData, resetStats, returnEntireCache, returnEntireCache, sendCacheInformation, sendDiscoveryResponse, serializeWithoutView, setForceSendingDiscoveryRsps, setNumInitialMembers, setTimeout, staggerTimeout, staggerTimeout, startCacheDissemination, timeout, timeout, up, useDiskCache, useDiskCache, weedOutCompletedDiscoveryResponses, write

Methods inherited from class org.jgroups.stack.Protocol

accept, afterCreationHook, dumpStats, enableStats, getConfigurableObjects, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, parse, printStats, providedDownServices, requiredDownServices, requiredUpServices, resetStatistics, setDownProtocol, setErgonomics, setId, setLevel, setProtocolStack, setSocketFactory, setUpProtocol, setValue, setValues, statsEnabled, up

Methods inherited from class java.lang.Object

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

Field Detail

use_nio

protected boolean use_nio

stubManager

protected volatile RouterStubManager stubManager

Constructor Detail

TCPGOSSIP

public TCPGOSSIP()

Method Detail

setInitialHosts

public void setInitialHosts(java.util.List<java.net.InetSocketAddress> hosts)

getInitialHosts

public java.util.List<java.net.InetSocketAddress> getInitialHosts()

isDynamic

public boolean isDynamic()

Specified by:

isDynamic in class Discovery

getStubManager

public RouterStubManager getStubManager()

init

public void init()
          throws java.lang.Exception

Description copied from class: Protocol

Called after instance has been created (null constructor) and before protocol is started. Properties are already set. Other protocols are not yet connected and events cannot yet be sent.

Overrides:

init in class Discovery

Throws:

java.lang.Exception - Thrown if protocol cannot be initialized successfully. This will cause the ProtocolStack to fail, so the channel constructor will throw an exception

start

public void start()
           throws java.lang.Exception

Description copied from class: Protocol

This method is called on a Channel.connect(String). Starts work. Protocols are connected and queues are ready to receive events. Will be called from bottom to top. This call will replace the START and START_OK events.

Overrides:

start in class Discovery

Throws:

java.lang.Exception - Thrown if protocol cannot be started successfully. This will cause the ProtocolStack to fail, so Channel.connect(String) will throw an exception

stop

public void stop()

Description copied from class: Protocol

This method is called on a Channel.disconnect(). Stops work (e.g. by closing multicast socket). Will be called from top to bottom. This means that at the time of the method invocation the neighbor protocol below is still working. This method will replace the STOP, STOP_OK, CLEANUP and CLEANUP_OK events. The ProtocolStack guarantees that when this method is called all messages in the down queue will have been flushed

Overrides:

stop in class Discovery

destroy

public void destroy()

Description copied from class: Protocol

This method is called on a Channel.close(). Does some cleanup; after the call the VM will terminate

Overrides:

destroy in class Protocol

handleConnect

public void handleConnect()

Overrides:

handleConnect in class Discovery

print

public java.lang.String print()

printStubs

public java.lang.String printStubs()

printReconnectList

public java.lang.String printReconnectList()

handleDisconnect

public void handleDisconnect()

Overrides:

handleDisconnect in class Discovery

findMembers

public void findMembers(java.util.List<Address> members,
                        boolean initial_discovery,
                        Responses responses)

Description copied from class: Discovery

Fetches information (e.g. physical address, logical name) for the given member addresses. Needs to add responses to the Responses object. If Discovery.async_discovery is true, this method will be called in a separate thread, otherwise the caller's thread will be used.

Specified by:

findMembers in class Discovery

Parameters:

members - A list of logical addresses (typically UUIDs). If null, then information for all members is fetched

initial_discovery - Set to true if this is for the initial membership discovery. Some protocols (e.g. file based ones) may return only the information for the coordinator(s).

responses - The list to which responses should be added

members

public void members(java.util.List<PingData> mbrs)

Specified by:

members in interface RouterStub.MembersNotification

addInitialHost

public void addInitialHost(java.lang.String hostname,
                           int port)

removeInitialHost

public boolean removeInitialHost(java.lang.String hostname,
                                 int port)