public interface ClusterDependencies
Cluster
.Modifier and Type | Field and Description |
---|---|
static int |
EDITION_DATA_CLIENT
Data Client edition (DC).
|
static int |
EDITION_ENTERPRISE
Enterprise edition (EE).
|
static int |
EDITION_GRID
Grid Edition (GE).
|
static int |
EDITION_REAL_TIME_CLIENT
Real time client edition (RTC).
|
static int |
EDITION_STANDARD
Standard edition (SE).
|
static int |
LICENSE_MODE_DEVELOPMENT
Development license.
|
static int |
LICENSE_MODE_EVALUATION
Evaluation license.
|
static int |
LICENSE_MODE_PRODUCTION
Production license.
|
static int |
SHUTDOWN_FORCE
Forcefully shutdown all running services before exiting the JVM.
|
static int |
SHUTDOWN_GRACEFUL
Gracefully shutdown all running services before exiting the JVM.
|
static int |
SHUTDOWN_NONE
Perform no local shutdown logic before exiting the JVM.
|
Modifier and Type | Method and Description |
---|---|
Map<String,AddressProviderFactory> |
getAddressProviderMap()
Obtain the address provider map.
|
Filter |
getAuthorizedHostFilter()
Obtain the filter that is used by the cluster to determine whether to accept a new Cluster member.
|
ParameterizedBuilderRegistry |
getBuilderRegistry()
The registry for all builders associated with the cluster.
|
ActionPolicyBuilder |
getClusterActionPolicyBuilder()
Obtain the action policy builder used by the cluster to control cluster membership actions.
|
int |
getClusterAnnounceTimeoutMillis()
Obtain the maximum amount of time that the cluster service will announce itself without receiving a response before deciding that a cluster does not exist and a new cluster should be formed.
|
int |
getClusterHeartbeatDelayMillis()
Obtain the amount of time between heartbeat messages.
|
int |
getClusterTimestampMaxVarianceMillis()
Obtain the maximum variance between sending and receiving broadcast messages when trying to determine the difference between a new cluster Member's wall time and the cluster time.
|
int |
getEdition()
Obtain the Coherence product edition.
|
List<String> |
getFilterList()
Obtain the list of all filters for the cluster.
|
Map<String,WrapperStreamFactory> |
getFilterMap()
Obtain the map of filter name to WrapperStreamFactory.
|
InetAddress |
getGroupAddress()
Obtain the multicast group address to listen/publish on.
|
int |
getGroupBufferSize()
Obtain the preferred size for the multicast datagram socket input buffer (SO_RCVBUF).
|
InetAddress |
getGroupInterface()
Obtain the IP address of the interface (e.g. the NIC) that the MulticastSocket will open a socket on.
|
int |
getGroupListenerPriority()
Obtain the priority of the PacketListener daemon thread.
|
int |
getGroupPort()
Obtain the multicast port number that the cluster will listen/publish on.
|
int |
getGroupTimeToLive()
Obtain the multicast time-to-live setting for the cluster.
|
long |
getGuardTimeoutMillis()
Obtain the default Guard timeout.
|
int |
getIpMonitorAttempts()
Obtain the number of connection attempts that the IpMonitor will use in determining if IP connectivity exists to other hosts.
|
int |
getIpMonitorPriority()
Obtain the priority of the IpMonitor daemon thread.
|
long |
getIpMonitorTimeoutMillis()
Obtain the timeout that the IpMonitor will use in determining if IP connectivity exists to other hosts.
|
InetAddress |
getLocalAddress()
Obtain the unicast IP address that the cluster member will listen/publish on or null for default.
|
int |
getLocalBufferSize()
Obtain the preferred size for the unicast socket input buffer (SO_RCVBUF).
|
InetAddress |
getLocalDiscoveryAddress()
Return the InetAddress on which this member will listen for discovery requests.
|
int |
getLocalListenerPriority()
Obtain the priority of the "local" PacketListener daemon thread.
|
int |
getLocalPort()
Obtain the unicast port number that the member will listen on.
|
int |
getLocalPortAutoAdjust()
Return the maximum unicast port that can be auto-adjusted to.
|
int |
getLostPacketThreshold()
Obtain the number of sequential packets which may be lost before declaring a member paused, and starting to trickle packets.
|
MemberIdentity |
getMemberIdentity()
Obtain the member identity.
|
int |
getMode()
Obtain the Mode for the "license type", i.e. evaluation, development or production use.
|
int |
getOutstandingPacketMaximum()
Obtain the maximum allowable flow-control rate measured in packets.
|
int |
getOutstandingPacketMinimum()
Obtain the minimum allowable flow-control rate measured in packets.
|
double |
getPacketBundlingAggression()
Obtain the aggression factor to use in deferring a packet once it has reached the average bundle size.
|
long |
getPacketBundlingThresholdNanos()
Obtain the maximum amount of time to defer a packet while waiting for additional packets to bundle.
|
int |
getPacketMaxLength()
Obtain the maximum size, in bytes, of the network packets that will be sent and received on the local and group sockets.
|
int |
getPacketPreferredLength()
Obtain the preferred size, in bytes, of the network packets that will be sent and received on the local sockets.
|
int |
getPublisherAckDelayMillis()
Obtain the amount of time that the Publisher may delay sending an ACK packet.
|
int |
getPublisherCloggedCount()
Obtain the maximum number of packets in the send and re-send queues that the Publisher will tolerate before determining that it is clogged and must slow down client requests (requests from local non-system threads).
|
int |
getPublisherCloggedDelayMillis()
Obtain the amount of time that the Publisher will pause a client thread that is trying to send a message when the Publisher is clogged.
|
int |
getPublisherGroupThreshold()
Obtain the group threshold which is used to determine whether a packet will be sent via unicast or multicast.
|
int |
getPublisherNackDelayMillis()
Obtain the amount of time that the Publisher will delay sending a NACK packet.
|
int |
getPublisherPriority()
Obtain the priority of the PacketPublisher daemon thread.
|
int |
getPublisherResendDelayMillis()
Obtain the minimum amount of time before a packet is resent across the network if it has not been acknowledged.
|
int |
getPublisherResendTimeoutMillis()
Obtain the maximum amount of time that the publisher will be resending a packet before the packet recipient is considered departed.
|
int |
getPublisherSocketBufferSize()
Obtain the preferred size of the unicast socket output buffer (SO_SNDBUF).
|
int |
getReceiverPriority()
Obtain the priority of the PacketReceiver daemon thread.
|
String |
getReliableTransport()
Obtain the name of the default reliable transport used by this node.
|
Map<String,SerializerFactory> |
getSerializerMap()
Obtain the Serializer map.
|
ServiceFailurePolicyBuilder |
getServiceFailurePolicyBuilder()
Obtain the service failure policy builder.
|
Map<String,List<String>> |
getServiceFilterMap()
Obtain a map of service name to filter list.
|
Map<String,String> |
getServiceMap()
Obtain the service map.
|
int |
getShutdownHookOption()
Obtain the value of the ShutdownHook setting.
|
Map<String,SnapshotArchiverFactory> |
getSnapshotArchiverMap()
Obtain the snapshot archiver map.
|
SocketProviderFactory |
getSocketProviderFactory()
Obtain the SocketProviderFactory associated with the cluster.
|
int |
getSpeakerPriority()
Obtain the priority of the PacketSpeaker daemon thread.
|
int |
getSpeakerVolumeMinimum()
Obtain the minimum number of packets which must be ready to be sent in order for the speaker to be utilized.
|
int |
getTcpBacklog()
Obtain the listener backlog for TCMP's TCP listener.
|
SocketOptions |
getTcpDatagramSocketOptions()
Obtain the SocketOptions to apply when TCMP runs on a TcpDatagramSocket.
|
SocketOptions |
getTcpRingSocketOptions()
Obtain the TcpRing SocketOptions.
|
SocketProviderBuilder |
getUnicastSocketProviderBuilder()
Obtain the cluster's unicast
SocketProviderBuilder . |
XmlElement |
getUnicastSocketProviderXml()
Deprecated.
|
AddressProvider |
getWellKnownAddresses()
Obtain the AddressProvider that provides the well known addresses (WKA) represented by InetSocketAddress objects.
|
boolean |
isFlowControlEnabled()
Determine whether the TCMP flow control is enabled.
|
boolean |
isIpMonitorEnabled()
Determine whether the IpMonitor is enabled.
|
boolean |
isLocalPortAutoAdjust()
Determine whether the unicast listener local port(s) will be automatically selected if the specified port cannot be bound to (e.g. it is already in use.)
|
boolean |
isReceiverNackEnabled()
Determine whether the PacketReceiver will use negative acknowledgments (NACK packet requests) to pro-actively respond to known missing packets.
|
boolean |
isSpeakerEnabled()
Determine whether the packet speaker is enabled.
|
boolean |
isTcmpEnabled()
Determine whether the TCMP is enabled.
|
boolean |
isTcpRingEnabled()
Determine whether the TcpRing is enabled.
|
static final int SHUTDOWN_NONE
static final int SHUTDOWN_FORCE
static final int SHUTDOWN_GRACEFUL
static final int EDITION_DATA_CLIENT
static final int EDITION_REAL_TIME_CLIENT
static final int EDITION_STANDARD
static final int EDITION_ENTERPRISE
static final int EDITION_GRID
static final int LICENSE_MODE_EVALUATION
static final int LICENSE_MODE_DEVELOPMENT
static final int LICENSE_MODE_PRODUCTION
Filter getAuthorizedHostFilter()
Filter.evaluate(T)
method will be passed the java.net.InetAddress of the potential member. Implementations should return "true" to allow the new member to join the cluster.ActionPolicyBuilder getClusterActionPolicyBuilder()
int getClusterAnnounceTimeoutMillis()
int getClusterHeartbeatDelayMillis()
int getClusterTimestampMaxVarianceMillis()
The smaller the variance, the more certain one can be that the cluster time will be closer between multiple systems running in the cluster; however, the process of joining the cluster will be extended until an exchange of Messages can occur within the specified variance.
Normally, a value as small as 20 milliseconds is sufficient, but with heavily loaded clusters and multiple network hops it is possible that a larger value would be necessary.
int getEdition()
The valid value are:
List<String> getFilterList()
Map<String,List<String>> getServiceFilterMap()
Map<String,WrapperStreamFactory> getFilterMap()
InetAddress getLocalDiscoveryAddress()
InetAddress getGroupAddress()
int getGroupBufferSize()
A negative value indicates that this value specifies the number of packets, rather than number of bytes for the buffer.
InetAddress getGroupInterface()
int getGroupListenerPriority()
int getGroupPort()
int getGroupTimeToLive()
The TTL sets the IP time-to-live for DatagramPackets sent to a MulticastGroup, which specifies how many "hops" that the packet will be forwarded on the network before it expires. The ttl must be in the range 0 <= ttl <= 255.
long getGuardTimeoutMillis()
int getIpMonitorAttempts()
int getIpMonitorPriority()
long getIpMonitorTimeoutMillis()
int getLocalBufferSize()
A negative value indicates that this value specifies the number of packets, rather then number bytes for the buffer.
int getLocalListenerPriority()
InetAddress getLocalAddress()
int getLocalPort()
int getLostPacketThreshold()
MemberIdentity getMemberIdentity()
int getMode()
The valid values are:
int getOutstandingPacketMaximum()
int getOutstandingPacketMinimum()
double getPacketBundlingAggression()
long getPacketBundlingThresholdNanos()
int getPacketMaxLength()
int getPacketPreferredLength()
This value should be greater or equal to 256. If set to zero the value will be automatically computed based upon the MTU of the network interface associated with the local address
.
int getPublisherAckDelayMillis()
int getPublisherSocketBufferSize()
A negative value indicates that this value specifies the number of packets, rather than the number bytes for the buffer. A value of zero results in a value being automatically calculated.
int getPublisherCloggedCount()
int getPublisherCloggedDelayMillis()
int getPublisherGroupThreshold()
This is a percentage value and is in the range of 1% to 100%. In a cluster of "n" nodes, a particular node sending a packet to a set of others (not counting self) destination nodes of size "d" (in the range of 0 to n-1), the packet will be sent multicast if and only if the following holds true:
int getPublisherNackDelayMillis()
int getPublisherPriority()
int getPublisherResendDelayMillis()
This value is also used for other situations in which packets need to be resent, such as cluster announcements.
int getPublisherResendTimeoutMillis()
int getReceiverPriority()
String getReliableTransport()
ServiceFailurePolicyBuilder getServiceFailurePolicyBuilder()
int getShutdownHookOption()
The valid values are the SHUTDOWN_* constants.
SocketProviderFactory getSocketProviderFactory()
Map<String,String> getServiceMap()
Map<String,SerializerFactory> getSerializerMap()
Map<String,SnapshotArchiverFactory> getSnapshotArchiverMap()
Map<String,AddressProviderFactory> getAddressProviderMap()
ParameterizedBuilderRegistry getBuilderRegistry()
ParameterizedBuilderRegistry.getBuilder(Class, String)
or just by the class it builds if there are no named builders.
Currently, only SerializerFactory
, ParameterizedBuilder
< PersistenceEnvironment
> and ParameterizedBuilder
< StorageAccessAuthorizer
> are registered by the implementation.
All registered Builders implementing Disposable
will be disposed.
ParameterizedBuilderRegistry
@Deprecated XmlElement getUnicastSocketProviderXml()
SocketProviderBuilder getUnicastSocketProviderBuilder()
SocketProviderBuilder
.int getSpeakerPriority()
int getSpeakerVolumeMinimum()
If this value is negative, the actual value will be based on the socket's send buffer size.
boolean isSpeakerEnabled()
int getTcpBacklog()
SocketOptions getTcpDatagramSocketOptions()
SocketOptions getTcpRingSocketOptions()
AddressProvider getWellKnownAddresses()
boolean isFlowControlEnabled()
boolean isIpMonitorEnabled()
boolean isLocalPortAutoAdjust()
int getLocalPortAutoAdjust()
boolean isReceiverNackEnabled()
boolean isTcmpEnabled()
boolean isTcpRingEnabled()