org.jgroups.protocols

Class TUNNEL

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.TP

org.jgroups.protocols.TUNNEL

All Implemented Interfaces:

DiagnosticsHandler.ProbeHandler, RouterStub.StubReceiver

public class TUNNEL
extends TP
implements RouterStub.StubReceiver

Replacement for UDP. Instead of sending packets via UDP, a TCP connection is opened to a Router (using the RouterStub client-side stub), the IP address/port of which was given using channel properties router_host and router_port. All outgoing traffic is sent via this TCP socket to the Router which distributes it to all connected TUNNELs in this group. Incoming traffic received from Router will simply be passed up the stack.

A TUNNEL layer can be used to penetrate a firewall, most firewalls allow creating TCP connections to the outside world, however, they do not permit outside hosts to initiate a TCP connection to a host inside the firewall. Therefore, the connection created by the inside host is reused by Router to send traffic from an outside host to a host inside the firewall.

Author:

Bela Ban, Vladimir Blagojevic

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TUNNEL.TUNNELPolicy

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 java.util.List<java.net.InetSocketAddress>	gossip_router_hosts
protected long	reconnect_interval
protected java.net.DatagramSocket	sock
protected RouterStubManager	stubManager
protected boolean	tcp_nodelay
protected TUNNEL.TUNNELPolicy	tunnel_policy
protected boolean	use_nio

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, view, 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
TUNNEL()

Method Summary

Modifier and Type	Method and Description
void	destroy() This method is called on a Channel.close().
java.lang.String	getInfo()
protected PhysicalAddress	getPhysicalAddress()
long	getReconnectInterval()
RouterStubManager	getStubManager()
java.lang.Object	handleDownEvent(Event evt)
void	init() Called after instance has been created (null constructor) and before protocol is started.
java.lang.String	print()
java.lang.String	printReconnectList()
java.lang.String	printStubs()
void	receive(GossipData data)
protected void	send(Message msg, Address dest) Serializes and sends a message.
void	sendMulticast(AsciiString cluster_name, byte[] data, int offset, int length) Send to all members in the group.
void	sendUnicast(PhysicalAddress dest, byte[] data, int offset, int length) Send a unicast to 1 member.
void	setGossipRouterHosts(java.lang.String hosts)
void	setReconnectInterval(long reconnect_interval)
void	setTUNNELPolicy(TUNNEL.TUNNELPolicy policy)
boolean	supportsMulticasting() We can simply send a message with dest == null and the GossipRouter will take care of routing it to all members in the cluster
java.lang.String	toString()

Methods inherited from class org.jgroups.protocols.TP

_send, addPhysicalAddressToCache, assertPositive, bundler, bundlerNumSpins, bundlerNumSpins, bundlerWaitStrategy, bundlerWaitStrategy, clearDifferentClusterCache, clearDifferentVersionCache, clearLogicalAddressCache, createBundler, createThreadPool, disableDiagnostics, doSend, down, 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, 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, sendToMembers, sendToSingleMember, 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, stop, 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

reconnect_interval

protected long reconnect_interval

tcp_nodelay

protected boolean tcp_nodelay

use_nio

protected boolean use_nio

gossip_router_hosts

protected final java.util.List<java.net.InetSocketAddress> gossip_router_hosts

tunnel_policy

protected TUNNEL.TUNNELPolicy tunnel_policy

sock

protected java.net.DatagramSocket sock

stubManager

protected volatile RouterStubManager stubManager

Constructor Detail

TUNNEL

public TUNNEL()

Method Detail

supportsMulticasting

public boolean supportsMulticasting()

We can simply send a message with dest == null and the GossipRouter will take care of routing it to all members in the cluster

Specified by:

supportsMulticasting in class TP

setGossipRouterHosts

public void setGossipRouterHosts(java.lang.String hosts)
                          throws java.net.UnknownHostException

Throws:

java.net.UnknownHostException

print

public java.lang.String print()

printStubs

public java.lang.String printStubs()

printReconnectList

public java.lang.String printReconnectList()

getStubManager

public RouterStubManager getStubManager()

toString

public java.lang.String toString()

Overrides:

toString in class TP

getReconnectInterval

public long getReconnectInterval()

setReconnectInterval

public void setReconnectInterval(long reconnect_interval)

setTUNNELPolicy

public void setTUNNELPolicy(TUNNEL.TUNNELPolicy policy)

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

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

handleDownEvent

public java.lang.Object handleDownEvent(Event evt)

Overrides:

handleDownEvent in class TP

receive

public void receive(GossipData data)

Specified by:

receive in interface RouterStub.StubReceiver

send

protected void send(Message msg,
                    Address dest)
             throws java.lang.Exception

Description copied from class: TP

Serializes and sends a message. This method is not reentrant

Overrides:

send in class TP

Throws:

java.lang.Exception

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

getInfo

public java.lang.String getInfo()

Specified by:

getInfo in class TP

getPhysicalAddress

protected PhysicalAddress getPhysicalAddress()

Specified by:

getPhysicalAddress in class TP