Package org.jgroups.protocols
Class TUNNEL
java.lang.Object
org.jgroups.stack.Protocol
org.jgroups.protocols.TP
org.jgroups.protocols.TUNNEL
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
-
Nested Class Summary
Nested classes/interfaces inherited from class org.jgroups.protocols.TP
TP.ProbeHandler, TP.ProtocolAdapter
-
Field Summary
Fields inherited from class org.jgroups.protocols.TP
bind_addr, channel_name, discard_incompatible_packets, global_thread_factory, local_addr, members, persistent_ports, persistent_ports_file, pm, pm_expiry_time, thread_naming_pattern, timer, timer_thread_factory, view
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetInfo()
getName()
long
int
handleDownEvent
(Event evt) void
init()
Called after instance has been created (null constructor) and before protocol is started.void
postUnmarshalling
(Message msg, Address dest, Address src, boolean multicast) void
postUnmarshallingList
(Message msg, Address dest, boolean multicast) void
sendToAllMembers
(byte[] data, int offset, int length) Send to all members in the group.void
sendToSingleMember
(Address dest, byte[] data, int offset, int length) Send to all members in the group.boolean
setProperties
(Properties props) Setup the Protocol instance acording to the configuration stringvoid
setReconnectInterval
(long reconnect_interval) void
setRouterHost
(String router_host) void
setRouterPort
(int router_port) void
start()
Creates the unicast and multicast sockets and starts the unicast and multicast receiver threadsvoid
stop()
This method is called on aChannel.disconnect()
.toString()
debug onlyMethods inherited from class org.jgroups.protocols.TP
createThreadPool, destroy, down, dumpStats, getBindAddress, getBindPort, getBindToAllInterfaces, getChannelName, getDefaultThreadPool, getDefaultThreadPoolThreadFactory, getIncomingKeepAliveTime, getIncomingMaxPoolSize, getIncomingMaxQueueSize, getIncomingMessages, getIncomingMinPoolSize, getIncomingPoolSize, getIncomingQueueSize, getLocalAddress, getMaxBundleSize, getMaxBundleTimeout, getNumBytesReceived, getNumBytesSent, getNumMessagesReceived, getNumMessagesSent, getOOBKeepAliveTime, getOOBMaxPoolSize, getOOBMaxQueueSize, getOOBMessages, getOOBMinPoolSize, getOOBPoolSize, getOOBQueueSize, getOOBThreadPool, getOOBThreadPoolThreadFactory, getReceiveInterfaces, getSendInterfaces, getSingletonName, getThreadFactory, getThreadNamingPattern, getTimer, getTimerThreadFactory, getUpProtocols, handleConfigEvent, handleConnect, handleDisconnect, isDefaulThreadPoolEnabled, isDiscardIncompatiblePackets, isEnable_unicast_bundling, isEnableBundling, isLoopback, isOOBThreadPoolEnabled, isReceiveOnAllInterfaces, isSendOnAllInterfaces, isUseIncomingPacketHandler, passToAllUpProtocols, receive, registerProbeHandler, resetStats, sendUpLocalAddressEvent, setBindAddress, setBindPort, setBindToAllInterfaces, setDefaultThreadPool, setDefaultThreadPoolThreadFactory, setDiscardIncompatiblePackets, setEnable_unicast_bundling, setEnableBundling, setIncomingKeepAliveTime, setIncomingMaxPoolSize, setIncomingMinPoolSize, setLoopback, setMaxBundleSize, setMaxBundleTimeout, setOOBKeepAliveTime, setOOBMaxPoolSize, setOOBMinPoolSize, setOOBThreadPool, setOOBThreadPoolThreadFactory, setThreadFactory, setThreadNames, setTimerThreadFactory, unregisterProbeHandler, unsetThreadNames, up
Methods inherited from class org.jgroups.stack.Protocol
downThreadEnabled, enableStats, getDownProtocol, getProperties, getProtocolStack, getTransport, getUpProtocol, printStats, providedDownServices, providedUpServices, requiredDownServices, requiredUpServices, setDownProtocol, setPropertiesInternal, setProtocolStack, setUpProtocol, statsEnabled, upThreadEnabled
-
Constructor Details
-
TUNNEL
public TUNNEL()
-
-
Method Details
-
toString
Description copied from class:TP
debug only -
getRouterHost
-
setRouterHost
-
getRouterPort
public int getRouterPort() -
setRouterPort
public void setRouterPort(int router_port) -
getReconnectInterval
public long getReconnectInterval() -
setReconnectInterval
public void setReconnectInterval(long reconnect_interval) -
getName
-
init
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. -
start
Description copied from class:TP
Creates the unicast and multicast sockets and starts the unicast and multicast receiver threads- Overrides:
start
in classTP
- Throws:
Exception
- Thrown if protocol cannot be started successfully. This will cause the ProtocolStack to fail, soChannel.connect(String)
will throw an exception
-
stop
public void stop()Description copied from class:Protocol
This method is called on aChannel.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 -
setProperties
Setup the Protocol instance acording to the configuration string- Overrides:
setProperties
in classTP
- Returns:
- true if no other properties are left. false if the properties still have data in them, ie , properties are left over and not handled by the protocol stack
-
handleDownEvent
- Overrides:
handleDownEvent
in classTP
-
sendToAllMembers
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:
sendToAllMembers
in classTP
- Parameters:
data
- The data to be sent. This is not a copy, so don't modify itoffset
-length
-- Throws:
Exception
-
sendToSingleMember
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:
sendToSingleMember
in classTP
- Parameters:
dest
- Must be a non-null unicast addressdata
- The data to be sent. This is not a copy, so don't modify itoffset
-length
-- Throws:
Exception
-
getInfo
-
postUnmarshalling
- Specified by:
postUnmarshalling
in classTP
-
postUnmarshallingList
- Specified by:
postUnmarshallingList
in classTP
-