org.jgroups.protocols

Class TCPPING

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.Discovery

org.jgroups.protocols.TCPPING

public class TCPPING
extends Discovery

The TCPPING protocol defines a static cluster membership. The cluster members are retrieved by directly contacting the members listed in initial_hosts, sending point-to-point discovery requests.

The TCPPING protocol defines a static configuration, which requires that you to know in advance where to find all of the members of your cluster.

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 BoundedList<PhysicalAddress>	dynamic_hosts https://jira.jboss.org/jira/browse/JGRP-989
protected int	max_dynamic_hosts

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
TCPPING()

Method Summary

Modifier and Type	Method and Description
void	clearDynamicHostList()
void	discoveryRequestReceived(Address sender, java.lang.String logical_name, PhysicalAddress physical_addr)
java.lang.Object	down(Event evt) An event is to be sent down the stack.
void	findMembers(java.util.List<Address> members, boolean initial_discovery, Responses responses) Fetches information (e.g.
java.lang.String	getDynamicHostList()
java.util.List<PhysicalAddress>	getInitialHosts() Returns the list of initial hosts as configured by the user via XML.
java.lang.String	getInitialHostsList()
int	getPortRange()
void	init() Called after instance has been created (null constructor) and before protocol is started.
boolean	isDynamic()
void	setInitialHosts(java.util.List<PhysicalAddress> initial_hosts)
void	setPortRange(int port_range)

Methods inherited from class org.jgroups.protocols.Discovery

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

Methods inherited from class org.jgroups.stack.Protocol

accept, afterCreationHook, destroy, 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

max_dynamic_hosts

protected int max_dynamic_hosts

dynamic_hosts

protected BoundedList<PhysicalAddress> dynamic_hosts

https://jira.jboss.org/jira/browse/JGRP-989

Constructor Detail

TCPPING

public TCPPING()

Method Detail

isDynamic

public boolean isDynamic()

Specified by:

isDynamic in class Discovery

getInitialHosts

public java.util.List<PhysicalAddress> getInitialHosts()

Returns the list of initial hosts as configured by the user via XML. Note that the returned list is mutable, so careful with changes !

Returns:

List

list of initial hosts. This variable is only set after the channel has been created and set Properties() has been called

setInitialHosts

public void setInitialHosts(java.util.List<PhysicalAddress> initial_hosts)

getPortRange

public int getPortRange()

setPortRange

public void setPortRange(int port_range)

getDynamicHostList

public java.lang.String getDynamicHostList()

clearDynamicHostList

public void clearDynamicHostList()

getInitialHostsList

public java.lang.String getInitialHostsList()

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

down

public java.lang.Object down(Event evt)

Description copied from class: Protocol

An event is to be sent down the stack. The layer may want to examine its type and perform some action on it, depending on the event's type. If the event is a message MSG, then the layer may need to add a header to it (or do nothing at all) before sending it down the stack using down_prot.down(). In case of a GET_ADDRESS event (which tries to retrieve the stack's address from one of the bottom layers), the layer may need to send a new response event back up the stack using up_prot.up().

Overrides:

down in class Discovery

discoveryRequestReceived

public void discoveryRequestReceived(Address sender,
                                     java.lang.String logical_name,
                                     PhysicalAddress physical_addr)

Overrides:

discoveryRequestReceived 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