Class SHARED_LOOPBACK

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.TP

org.jgroups.protocols.SHARED_LOOPBACK

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.

Version:

$Id: SHARED_LOOPBACK.java,v 1.4.2.1 2008/05/22 13:23:06 belaban Exp $

Author:

Bela Ban

Nested Class Summary

Nested classes/interfaces inherited from class TP

TP.ProbeHandler, TP.ProtocolAdapter

Field Summary

Fields inherited from class 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

Fields inherited from class Protocol

down_prot, log, props, stack, stats, up_prot

Constructor Summary

Constructors

Constructor	Description
SHARED_LOOPBACK()

Method Summary

Modifier and Type	Method	Description
Object	down(Event evt)	Caller by the layer above this layer.
String	getInfo()
String	getName()
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.
void	start()	Creates the unicast and multicast sockets and starts the unicast and multicast receiver threads
void	stop()	This method is called on a Channel.disconnect().
String	toString()	debug only

Methods inherited from class TP

createThreadPool, destroy, 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, handleDownEvent, 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, setProperties, setThreadFactory, setThreadNames, setTimerThreadFactory, unregisterProbeHandler, unsetThreadNames, up

Methods inherited from class Protocol

downThreadEnabled, enableStats, getDownProtocol, getProperties, getProtocolStack, getTransport, getUpProtocol, printStats, providedDownServices, providedUpServices, requiredDownServices, requiredUpServices, setDownProtocol, setPropertiesInternal, setProtocolStack, setUpProtocol, statsEnabled, upThreadEnabled

Methods inherited from class Object

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

Constructor Details

SHARED_LOOPBACK

public SHARED_LOOPBACK()

Method Details

toString

public String toString()

Description copied from class: TP

debug only

Overrides:

toString in class TP

sendToAllMembers

public void sendToAllMembers(byte[] data,
 int offset,
 int length)
                      throws 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:

sendToAllMembers in class TP

Parameters:

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

offset -

length -

Throws:

Exception

sendToSingleMember

public void sendToSingleMember(Address dest,
 byte[] data,
 int offset,
 int length)
                        throws 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:

sendToSingleMember 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

offset -

length -

Throws:

Exception

getInfo

public String getInfo()

Specified by:

getInfo in class TP

postUnmarshalling

public void postUnmarshalling(Message msg,
 Address dest,
 Address src,
 boolean multicast)

Specified by:

postUnmarshalling in class TP

postUnmarshallingList

public void postUnmarshallingList(Message msg,
 Address dest,
 boolean multicast)

Specified by:

postUnmarshallingList in class TP

getName

public String getName()

Specified by:

getName in class Protocol

init

public void init()
          throws 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:

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 Exception

Description copied from class: TP

Creates the unicast and multicast sockets and starts the unicast and multicast receiver threads

Overrides:

start in class TP

Throws:

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 TP

down

public 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