org.jgroups.protocols

Class SHARED_LOOPBACK

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.TP

org.jgroups.protocols.SHARED_LOOPBACK

All Implemented Interfaces:

DiagnosticsHandler.ProbeHandler

public class SHARED_LOOPBACK
extends TP

Loopback transport shared by all channels within the same VM. Property for testing is that no messages are lost. Allows us to test various protocols (with ProtocolTester) at maximum speed.

Author:

Bela Ban

Nested Class Summary

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

TP.BatchHandler, TP.ProtocolAdapter, TP.SingleMessageHandler, TP.SingleMessageHandlerWithClusterName

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	is_coord
protected boolean	is_server
protected PhysicalAddress	physical_addr
protected short	port
protected View	view

Fields inherited from class org.jgroups.protocols.TP

avg_batch_size, bind_addr, bind_interface_str, bind_port, BUNDLE_MSG, bundler, bundler_capacity, bundler_num_spins, bundler_type, bundler_wait_strategy, can_bind_to_mcast_addr, cluster_name, connect_count, connectLock, default_thread_factory, diag_handler, diagnostics_addr, diagnostics_bind_interfaces, diagnostics_passcode, diagnostics_port, diagnostics_ttl, discard_incompatible_packets, enable_batching, enable_bundling, enable_diagnostics, enable_unicast_bundling, external_addr, external_port, f, global_thread_factory, header, ignore_dont_bundle, internal_thread_factory, internal_thread_pool, internal_thread_pool_enabled, internal_thread_pool_keep_alive_time, internal_thread_pool_max_threads, internal_thread_pool_min_threads, internal_thread_pool_queue, internal_thread_pool_queue_enabled, internal_thread_pool_queue_max_size, internal_thread_pool_rejection_policy, last_discovery_request, LIST, local_addr, local_physical_addr, log_discard_msgs, log_discard_msgs_version, logical_addr_cache, logical_addr_cache_expiration, logical_addr_cache_max_size, logical_addr_cache_reaper_interval, loopback, loopback_copy, loopback_separate_thread, max_bundle_size, max_bundle_timeout, members, MIN_WAIT_BETWEEN_DISCOVERIES, MSG_OVERHEAD, MULTICAST, no_bundler_initial_buf_size, no_bundler_pool_size, num_batches_received, num_batches_sent, num_bytes_received, num_bytes_sent, num_incoming_msgs_received, num_internal_msgs_received, num_msgs_received, num_msgs_sent, num_oob_msgs_received, num_rejected_msgs, num_single_msgs_received, num_single_msgs_sent, num_single_msgs_sent_instead_of_batch, oob_thread_factory, oob_thread_pool, oob_thread_pool_enabled, oob_thread_pool_keep_alive_time, oob_thread_pool_max_threads, oob_thread_pool_min_threads, oob_thread_pool_queue, oob_thread_pool_queue_enabled, oob_thread_pool_queue_max_size, oob_thread_pool_rejection_policy, physical_addr_max_fetch_attempts, port_range, preregistered_probe_handlers, print_function, receive_interfaces, receive_on_all_interfaces, singleton_name, socket_factory, suppress_log_different_cluster, suppress_log_different_version, suppress_time_different_cluster_warnings, suppress_time_different_version_warnings, thread_naming_pattern, thread_pool, thread_pool_enabled, thread_pool_keep_alive_time, thread_pool_max_threads, thread_pool_min_threads, thread_pool_queue, thread_pool_queue_enabled, thread_pool_queue_max_size, thread_pool_rejection_policy, tick_time, time_service, time_service_interval, timer, timer_keep_alive_time, timer_max_threads, timer_min_threads, timer_queue_max_size, timer_rejection_policy, timer_thread_factory, timer_type, up_prots, wheel_size, who_has_cache, who_has_cache_timeout

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

Method Summary

Modifier and Type	Method and Description
void	destroy() This method is called on a Channel.close().
java.lang.Object	down(Event evt) Caller by the layer above this layer.
static java.lang.String	dumpRoutingTable()
static java.util.List<PingData>	getDiscoveryResponsesFor(java.lang.String cluster_name)
java.lang.String	getInfo()
protected PhysicalAddress	getPhysicalAddress()
View	getView()
void	init() Called after instance has been created (null constructor) and before protocol is started.
boolean	isCoord()
boolean	isServer()
protected static void	register(AsciiString channel_name, Address local_addr, SHARED_LOOPBACK shared_loopback)
void	sendMulticast(AsciiString cluster_name, byte[] data, int offset, int length) Send to all members in the group.
protected void	sendToSingleMember(Address dest, byte[] buf, int offset, int length)
void	sendUnicast(PhysicalAddress dest, byte[] data, int offset, int length) Send a unicast to 1 member.
void	stop() This method is called on a Channel.disconnect().
boolean	supportsMulticasting() Whether or not hardware multicasting is supported
java.lang.String	toString()
protected static void	unregister(AsciiString channel_name, Address local_addr)

Methods inherited from class org.jgroups.protocols.TP

_send, addPhysicalAddressToCache, assertPositive, bundler, bundlerNumSpins, bundlerNumSpins, bundlerWaitStrategy, bundlerWaitStrategy, clearDifferentClusterCache, clearDifferentVersionCache, clearLogicalAddressCache, createBundler, createThreadPool, disableDiagnostics, doSend, dumpTimerTasks, enableDiagnostics, evictLogicalAddressCache, evictLogicalAddressCache, fetchLocalAddresses, fetchPhysicalAddrs, fetchResponsesFromDiscoveryProtocol, getAllPhysicalAddressesFromCache, getAvgBatchSize, getBindAddress, getBindPort, getBundler, getBundlerBufferSize, getBundlerCapacity, getBundlerClass, getClusterName, getClusterName, getClusterNameAscii, getDefaultThreadPool, getDefaultThreadPoolThreadFactory, getDifferentClusterMessages, getDifferentVersionMessages, getInternalMaxQueueSize, getInternalMessages, getInternalPoolSize, getInternalPoolSizeActive, getInternalQueueSize, getInternalThreadPool, getInternalThreadPoolThreadFactory, getLocalAddress, getLocalPhysicalAddress, getLogDiscardMessages, getLogDiscardMessagesVersion, getMaxBundleSize, getMaxBundleTimeout, getNumBytesReceived, getNumBytesSent, getNumMessagesReceived, getNumMessagesSent, getNumThreads, getNumTimerTasks, getOOBMaxQueueSize, getOOBMessages, getOOBPoolSize, getOOBPoolSizeActive, getOOBQueueSize, getOOBThreadPool, getOOBThreadPoolKeepAliveTime, getOOBThreadPoolMaxThreads, getOOBThreadPoolMinThreads, getOOBThreadPoolThreadFactory, getPhysicalAddressFromCache, getPortRange, getReceiveInterfaces, getRegularMaxQueueSize, getRegularMessages, getRegularPoolSize, getRegularPoolSizeActive, getRegularQueueSize, getSingletonName, getSocketFactory, getThreadFactory, getThreadNamingPattern, getThreadPoolKeepAliveTime, getThreadPoolMaxThreads, getThreadPoolMinThreads, getTimer, getTimerClass, getTimerKeepAliveTime, getTimerMaxThreads, getTimerMinThreads, getTimerQueueSize, getTimerThreadFactory, getTimerThreads, getTimeService, getUpProtocols, handleConnect, handleDisconnect, handleDownEvent, handleMessageBatch, handleProbe, handleSingleMessage, incrBatchesSent, incrBatchesSent, incrSingleMsgsInsteadOfBatches, isDefaulThreadPoolEnabled, isDiagnosticsHandlerRunning, isDiscardIncompatiblePackets, isEnableBundling, isEnableUnicastBundling, isLogicalAddressCacheReaperRunning, isLoopback, isMulticastCapable, isOOBThreadPoolEnabled, isReceiveOnAllInterfaces, isSingleton, localAddress, loggerType, loopback, passBatchUp, passMessageUp, passToAllUpProtocols, pickThreadPool, printLogicalAddressCache, printWhoHasCache, readMessage, readMessageBatch, readMessageList, receive, registerLocalAddress, registerProbeHandler, removeAndDispatchNonBundledMessages, removeLogicalAddressFromCache, resetStats, send, sendToMembers, setBindAddress, setBindPort, setBindToAllInterfaces, setBundler, setDefaultThreadPool, setDefaultThreadPoolThreadFactory, setDiagnosticsHandler, setDiscardIncompatiblePackets, setEnableBundling, setEnableUnicastBundling, setInAllThreadFactories, setInternalThreadPool, setInternalThreadPoolThreadFactory, setLogDiscardMessages, setLogDiscardMessagesVersion, setLoopback, setMaxBundleSize, setMaxBundleTimeout, setOOBRejectionPolicy, setOOBThreadPool, setOOBThreadPoolKeepAliveTime, setOOBThreadPoolMaxThreads, setOOBThreadPoolMinThreads, setOOBThreadPoolQueueEnabled, setOOBThreadPoolThreadFactory, setPingData, setPortRange, setRegularRejectionPolicy, setSocketFactory, setSourceAddress, setThreadFactory, setThreadNames, setThreadPoolKeepAliveTime, setThreadPoolMaxThreads, setThreadPoolMinThreads, setThreadPoolQueueEnabled, setTimer, setTimerKeepAliveTime, setTimerMaxThreads, setTimerMinThreads, setTimerThreadFactory, setTimeService, shutdownThreadPool, start, startDiagnostics, stopDiagnostics, supportedKeys, unregisterProbeHandler, unsetThreadNames, up, versionMatch, view, writeMessage, writeMessageList, writeMessageListHeader

Methods inherited from class org.jgroups.stack.Protocol

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

Methods inherited from class java.lang.Object

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

Field Detail

port

protected short port

physical_addr

protected PhysicalAddress physical_addr

view

protected volatile View view

is_server

protected volatile boolean is_server

is_coord

protected volatile boolean is_coord

Constructor Detail

SHARED_LOOPBACK

public SHARED_LOOPBACK()

Method Detail

supportsMulticasting

public boolean supportsMulticasting()

Description copied from class: TP

Whether or not hardware multicasting is supported

Specified by:

supportsMulticasting in class TP

getView

public View getView()

isServer

public boolean isServer()

isCoord

public boolean isCoord()

toString

public java.lang.String toString()

Overrides:

toString in class TP

dumpRoutingTable

public static java.lang.String dumpRoutingTable()

sendMulticast

public void sendMulticast(AsciiString cluster_name,
                          byte[] data,
                          int offset,
                          int length)
                   throws java.lang.Exception

Description copied from class: TP

Send to all members in the group. UDP would use an IP multicast message, whereas TCP would send N messages, one for each member

Specified by:

sendMulticast in class TP

Parameters:

cluster_name - The name of the cluster. Null if not a shared transport

data - The data to be sent. This is not a copy, so don't modify it

Throws:

java.lang.Exception

sendUnicast

public void sendUnicast(PhysicalAddress dest,
                        byte[] data,
                        int offset,
                        int length)
                 throws java.lang.Exception

Description copied from class: TP

Send a unicast to 1 member. Note that the destination address is a *physical*, not a logical address

Specified by:

sendUnicast in class TP

Parameters:

dest - Must be a non-null unicast address

data - The data to be sent. This is not a copy, so don't modify it

Throws:

java.lang.Exception

sendToSingleMember

protected void sendToSingleMember(Address dest,
                                  byte[] buf,
                                  int offset,
                                  int length)
                           throws java.lang.Exception

Overrides:

sendToSingleMember in class TP

Throws:

java.lang.Exception

getDiscoveryResponsesFor

public static java.util.List<PingData> getDiscoveryResponsesFor(java.lang.String cluster_name)

getInfo

public java.lang.String getInfo()

Specified by:

getInfo in class TP

getPhysicalAddress

protected PhysicalAddress getPhysicalAddress()

Specified by:

getPhysicalAddress in class TP

down

public java.lang.Object down(Event evt)

Description copied from class: TP

Caller by the layer above this layer. Usually we just put this Message into the send queue and let one or more worker threads handle it. A worker thread then removes the Message from the send queue, performs a conversion and adds the modified Message to the send queue of the layer below it, by calling down()).

Overrides:

down in class TP

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 TP

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

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 TP

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 TP

register

protected static void register(AsciiString channel_name,
                               Address local_addr,
                               SHARED_LOOPBACK shared_loopback)

unregister

protected static void unregister(AsciiString channel_name,
                                 Address local_addr)