org.jgroups.protocols

Class BasicTCP

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.TP

org.jgroups.protocols.BasicTCP

All Implemented Interfaces:

Receiver, DiagnosticsHandler.ProbeHandler

Direct Known Subclasses:

TCP, TCP_NIO, TCP_NIO2

public abstract class BasicTCP
extends TP
implements Receiver

Shared base class for TCP protocols

Author:

Scott Marlow, 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 java.net.InetAddress	client_bind_addr
protected int	client_bind_port
protected long	conn_expire_time
protected boolean	defer_client_bind_addr
protected int	linger
protected int	peer_addr_read_timeout
protected long	reaper_interval
protected int	recv_buf_size
protected int	send_buf_size
protected int	send_queue_size Deprecated.
protected int	sock_conn_timeout
protected boolean	tcp_nodelay
protected boolean	use_send_queues Deprecated.

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

Modifier	Constructor and Description
protected	BasicTCP()

Method Summary

Modifier and Type	Method and Description
long	getConnExpireTime()
java.lang.String	getInfo()
long	getReaperInterval()
protected java.lang.Object	handleDownEvent(Event evt)
void	init() Called after instance has been created (null constructor) and before protocol is started.
abstract java.lang.String	printConnections()
void	receive(Address sender, byte[] data, int offset, int length) BaseServer.Receiver interface
void	receive(Address sender, java.nio.ByteBuffer buf) Delivers a message from a given sender to the application
abstract void	retainAll(java.util.Collection<Address> members)
abstract void	send(Address dest, byte[] data, int offset, int length)
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	setConnExpireTime(long time)
void	setReaperInterval(long interval)
boolean	supportsMulticasting() Whether or not hardware multicasting is supported

Methods inherited from class org.jgroups.protocols.TP

_send, addPhysicalAddressToCache, assertPositive, bundler, bundlerNumSpins, bundlerNumSpins, bundlerWaitStrategy, bundlerWaitStrategy, clearDifferentClusterCache, clearDifferentVersionCache, clearLogicalAddressCache, createBundler, createThreadPool, destroy, 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, getPhysicalAddress, 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, registerLocalAddress, registerProbeHandler, removeAndDispatchNonBundledMessages, removeLogicalAddressFromCache, resetStats, send, 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, toString, 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

reaper_interval

protected long reaper_interval

conn_expire_time

protected long conn_expire_time

use_send_queues

@Deprecated
protected boolean use_send_queues

Deprecated.

send_queue_size

@Deprecated
protected int send_queue_size

Deprecated.

recv_buf_size

protected int recv_buf_size

send_buf_size

protected int send_buf_size

sock_conn_timeout

protected int sock_conn_timeout

peer_addr_read_timeout

protected int peer_addr_read_timeout

tcp_nodelay

protected boolean tcp_nodelay

linger

protected int linger

client_bind_addr

protected java.net.InetAddress client_bind_addr

client_bind_port

protected int client_bind_port

defer_client_bind_addr

protected boolean defer_client_bind_addr

Constructor Detail

BasicTCP

protected BasicTCP()

Method Detail

supportsMulticasting

public boolean supportsMulticasting()

Description copied from class: TP

Whether or not hardware multicasting is supported

Specified by:

supportsMulticasting in class TP

getReaperInterval

public long getReaperInterval()

setReaperInterval

public void setReaperInterval(long interval)

getConnExpireTime

public long getConnExpireTime()

setConnExpireTime

public void setConnExpireTime(long time)

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

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

printConnections

public abstract java.lang.String printConnections()

send

public abstract void send(Address dest,
                          byte[] data,
                          int offset,
                          int length)
                   throws java.lang.Exception

Throws:

java.lang.Exception

retainAll

public abstract void retainAll(java.util.Collection<Address> members)

receive

public void receive(Address sender,
                    byte[] data,
                    int offset,
                    int length)

BaseServer.Receiver interface

Specified by:

receive in interface Receiver

Overrides:

receive in class TP

Parameters:

sender - The sender of the message

data - The buffer. An application typically de-serializes data from the buffer into objects used by the application. Note that when receive() returns, it is not safe to use the buffer any longer; if an application needs to use a buffer after this callback returns, it must make a copy.

offset - The offset at which the received data starts

length - The length of the received data

receive

public void receive(Address sender,
                    java.nio.ByteBuffer buf)

Description copied from interface: Receiver

Delivers a message from a given sender to the application

Specified by:

receive in interface Receiver

Parameters:

sender - The sender of the message

buf - The buffer. An application typically de-serializes data from the buffer into objects used by the application. Note that when receive() returns, it is not safe to use the buffer any longer; if an application needs to use a buffer after this callback returns, it must make a copy.

Note that buf could be a direct ByteBuffer.

handleDownEvent

protected java.lang.Object handleDownEvent(Event evt)

Overrides:

handleDownEvent in class TP