DrReceiverConfiguration (GridGain 8.9.15)

java.lang.Object
- org.gridgain.grid.configuration.DrReceiverConfiguration

public class DrReceiverConfiguration
extends Object

Data center replication receiver hub configuration.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DFLT_DIRECT_BUF` Default value of direct buffer allocation.
`static long`	`DFLT_FLUSH_FREQ` Default flush frequency DR data loader.
`static long`	`DFLT_IDLE_TIMEOUT` Default server socket idle timeout.
`static int`	`DFLT_LOCAL_PORT` Default server port.
`static int`	`DFLT_MSG_QUEUE_LIMIT` Default message queue limit per connection (for incoming and outgoing .
`static int`	`DFLT_PARALLEL_LOAD_OPS` Default per node parallel operations for DR data loader.
`static int`	`DFLT_PER_NODE_BUF_SIZE` Default per node buffer buffer size for DR data loader.
`static int`	`DFLT_SELECTOR_CNT` Default quantity of NIO threads responsible for sender hub connections processing.
`static boolean`	`DFLT_TCP_NODELAY` Default TCP_NODELAY flag value for server sockets.
`static boolean`	`DFLT_USE_IGNITE_SSL_CTX_FACTORY` Default value of whether to use Ignite SSL context factory.
`static int`	`DFLT_WORKER_THREAD_CNT` Default number of threads responsible for sender hub requests processing.
`static long`	`DFLT_WRITE_TIMEOUT` Default server socket write timeout.

Constructor Summary

Constructors
Constructor and Description

DrReceiverConfiguration()
Default constructor.

DrReceiverConfiguration(DrReceiverConfiguration cfg)
Copying constructor.

Constructors
Constructor and Description
`DrReceiverConfiguration()` Default constructor.
`DrReceiverConfiguration(DrReceiverConfiguration cfg)` Copying constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getFlushFrequency()` Gets data flush frequency.
`long`	`getIdleTimeout()` Gets idle timeout for receiver hub's TCP server connection.
`String`	`getLocalInboundHost()` Gets local host name receiver hub TCP server is bound to.
`int`	`getLocalInboundPort()` Gets local port receiver hub TCP server is bound to.
`int`	`getMessageQueueLimit()` Gets message queue limit for incoming and outgoing messages in receiver hub's TCP server.
`int`	`getPerNodeBufferSize()` Gets per-node data buffer size.
`int`	`getPerNodeParallelLoadOperations()` Gets per-node parallel load operations.
`int`	`getSelectorCount()` Gets amount of selector threads in receiver hub's TCP server.
`int`	`getSocketReceiveBufferSize()` Gets socket receive buffer size in bytes.
`int`	`getSocketSendBufferSize()` Gets socket send buffer size in bytes.
`javax.cache.configuration.Factory<SSLContext>`	`getSslContextFactory()` Gets SSL context factory.
`int`	`getWorkerThreads()` Gets amount of threads responsible for sender hub batches processing.
`long`	`getWriteTimeout()` Gets write timeout for receiver hub's TCP server connection.
`boolean`	`isDirectBuffer()` Gets direct buffer flag in receiver hub's TCP server.
`boolean`	`isLazyBinaryMetadataRegistration()` Gets metadata registration mode flag: - `true` metadata is registered on the received cluster only when data that is replicated; - `false` all metadata received from the master cluster are registered.
`boolean`	`isTcpNodelay()` Gets TCP_NODELAY flag in receiver hub's TCP server.
`boolean`	`isUseIgniteSslContextFactory()` Gets whether to use Ignite SSL context factory configured through `IgniteConfiguration.getSslContextFactory()` if `getSslContextFactory()` is not set.
`DrReceiverConfiguration`	`setDirectBuffer(boolean directBuf)` Sets direct buffer flag in receiver hub's TCP server.
`DrReceiverConfiguration`	`setFlushFrequency(long flushFreq)` Sets data flush frequency.
`DrReceiverConfiguration`	`setIdleTimeout(long idleTimeout)` Sets idle timeout for receiver hub's TCP server connection.
`void`	`setLazyBinaryMetadataRegistration(boolean lazyBinaryMetadataRegistration)` Sets register metadata mode: - `true` metadata is registered on the received cluster only when data that is replicated; - `false` all metadata received from the master cluster are registered.
`DrReceiverConfiguration`	`setLocalInboundHost(String locInboundHost)` Sets local host name receiver hub TCP server is bound to.
`DrReceiverConfiguration`	`setLocalInboundPort(int locInboundPort)` Sets local port receiver hub TCP server is bound to.
`DrReceiverConfiguration`	`setMessageQueueLimit(int msgQueueLimit)` Sets message queue limit for incoming and outgoing messages in receiver hub's TCP server.
`DrReceiverConfiguration`	`setPerNodeBufferSize(int perNodeBufSize)` Sets per-node data buffer size.
`DrReceiverConfiguration`	`setPerNodeParallelLoadOperations(int perNodeParallelLoadOps)` Sets per-node parallel load operations.
`DrReceiverConfiguration`	`setSelectorCount(int selectorCnt)` Sets amount of selector threads in receiver hub's TCP server.
`DrReceiverConfiguration`	`setSocketReceiveBufferSize(int sockRcvBufSize)` Sets socket receive buffer size in bytes.
`DrReceiverConfiguration`	`setSocketSendBufferSize(int sockSndBufSize)` Sets socket send buffer size in bytes.
`DrReceiverConfiguration`	`setSslContextFactory(javax.cache.configuration.Factory<SSLContext> sslCtxFactory)` Sets SSL context factory.
`DrReceiverConfiguration`	`setTcpNodelay(boolean tcpNodelay)` Sets TCP_NODELAY flag in receiver hub's TCP server.
`DrReceiverConfiguration`	`setUseIgniteSslContextFactory(boolean useIgniteSslCtxFactory)` Sets whether to use Ignite SSL context factory.
`DrReceiverConfiguration`	`setWorkerThreads(int workerCnt)` Sets amount of threads responsible for sender hub batches processing.
`DrReceiverConfiguration`	`setWriteTimeout(long writeTimeout)` Sets write timeout for receiver hub's TCP server connection.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DFLT_LOCAL_PORT
```
public static final int DFLT_LOCAL_PORT
```
    Default server port.
    
    See Also:
    
    Constant Field Values
  - DFLT_SELECTOR_CNT
```
public static final int DFLT_SELECTOR_CNT
```
    Default quantity of NIO threads responsible for sender hub connections processing.
  - DFLT_WORKER_THREAD_CNT
```
public static final int DFLT_WORKER_THREAD_CNT
```
    Default number of threads responsible for sender hub requests processing.
  - DFLT_MSG_QUEUE_LIMIT
```
public static final int DFLT_MSG_QUEUE_LIMIT
```
    Default message queue limit per connection (for incoming and outgoing .
    
    See Also:
    
    Constant Field Values
  - DFLT_TCP_NODELAY
```
public static final boolean DFLT_TCP_NODELAY
```
    Default TCP_NODELAY flag value for server sockets.
    
    See Also:
    
    Constant Field Values
  - DFLT_DIRECT_BUF
```
public static final boolean DFLT_DIRECT_BUF
```
    Default value of direct buffer allocation.
    
    See Also:
    
    Constant Field Values
  - DFLT_IDLE_TIMEOUT
```
public static final long DFLT_IDLE_TIMEOUT
```
    Default server socket idle timeout.
    
    See Also:
    
    Constant Field Values
  - DFLT_WRITE_TIMEOUT
```
public static final long DFLT_WRITE_TIMEOUT
```
    Default server socket write timeout.
    
    See Also:
    
    Constant Field Values
  - DFLT_FLUSH_FREQ
```
public static final long DFLT_FLUSH_FREQ
```
    Default flush frequency DR data loader.
    
    See Also:
    
    Constant Field Values
  - DFLT_PER_NODE_BUF_SIZE
```
public static final int DFLT_PER_NODE_BUF_SIZE
```
    Default per node buffer buffer size for DR data loader.
    
    See Also:
    
    Constant Field Values
  - DFLT_PARALLEL_LOAD_OPS
```
public static final int DFLT_PARALLEL_LOAD_OPS
```
    Default per node parallel operations for DR data loader.
    
    See Also:
    
    Constant Field Values
  - DFLT_USE_IGNITE_SSL_CTX_FACTORY
```
public static final boolean DFLT_USE_IGNITE_SSL_CTX_FACTORY
```
    Default value of whether to use Ignite SSL context factory.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DrReceiverConfiguration
```
public DrReceiverConfiguration()
```
    Default constructor.
  - DrReceiverConfiguration
```
public DrReceiverConfiguration(DrReceiverConfiguration cfg)
```
    Copying constructor.
    
    Parameters:
    
    cfg - Configuration to copy.
- Method Detail
  - getLocalInboundHost
```
public String getLocalInboundHost()
```
    Gets local host name receiver hub TCP server is bound to.
    If not set, IgniteConfiguration.getLocalHost() will be used.
    Defaults to null.
    
    Returns:
    
    Local host name receiver hub TCP server is bound to.
  - setLocalInboundHost
```
public DrReceiverConfiguration setLocalInboundHost(String locInboundHost)
```
    Sets local host name receiver hub TCP server is bound to. See getLocalInboundHost() for more information.
    
    Parameters:
    
    locInboundHost - Local host name receiver hub TCP server is bound to.
    
    Returns:
    
    this for chaining.
  - getLocalInboundPort
```
public int getLocalInboundPort()
```
    Gets local port receiver hub TCP server is bound to.
    Defaults to DFLT_LOCAL_PORT.
    
    Returns:
    
    Local port receiver hub TCP server is bound to.
  - setLocalInboundPort
```
public DrReceiverConfiguration setLocalInboundPort(int locInboundPort)
```
    Sets local port receiver hub TCP server is bound to. See getLocalInboundPort() for more information.
    
    Parameters:
    
    locInboundPort - Local port receiver hub TCP server is bound to.
    
    Returns:
    
    this for chaining.
  - getSelectorCount
```
public int getSelectorCount()
```
    Gets amount of selector threads in receiver hub's TCP server.
    Defaults to DFLT_SELECTOR_CNT.
    
    Returns:
    
    Amount of selector threads in receiver hub's TCP server.
  - setSelectorCount
```
public DrReceiverConfiguration setSelectorCount(int selectorCnt)
```
    Sets amount of selector threads in receiver hub's TCP server. See getSelectorCount() for more information.
    
    Parameters:
    
    selectorCnt - Amount of selector threads in receiver hub's TCP server.
    
    Returns:
    
    this for chaining.
  - getWorkerThreads
```
public int getWorkerThreads()
```
    Gets amount of threads responsible for sender hub batches processing.
    Defaults to DFLT_WORKER_THREAD_CNT.
    
    Returns:
    
    Amount of threads responsible for sender hub batches processing.
  - setWorkerThreads
```
public DrReceiverConfiguration setWorkerThreads(int workerCnt)
```
    Sets amount of threads responsible for sender hub batches processing. See getWorkerThreads() for more information.
    
    Parameters:
    
    workerCnt - Amount of threads responsible for sender hub batches processing.
    
    Returns:
    
    this for chaining.
  - getMessageQueueLimit
```
public int getMessageQueueLimit()
```
    Gets message queue limit for incoming and outgoing messages in receiver hub's TCP server.
    Defaults to DFLT_MSG_QUEUE_LIMIT.
    
    Returns:
    
    Message queue limit for incoming and outgoing messages in receiver hub's TCP server.
  - setMessageQueueLimit
```
public DrReceiverConfiguration setMessageQueueLimit(int msgQueueLimit)
```
    Sets message queue limit for incoming and outgoing messages in receiver hub's TCP server. See getMessageQueueLimit() for more information.
    
    Parameters:
    
    msgQueueLimit - Message queue limit for incoming and outgoing messages in receiver hub's TCP server.
    
    Returns:
    
    this for chaining.
  - isTcpNodelay
```
public boolean isTcpNodelay()
```
    Gets TCP_NODELAY flag in receiver hub's TCP server.
    Defaults to DFLT_TCP_NODELAY.
    
    Returns:
    
    TCP_NODELAY flag in receiver hub's TCP server.
  - setTcpNodelay
```
public DrReceiverConfiguration setTcpNodelay(boolean tcpNodelay)
```
    Sets TCP_NODELAY flag in receiver hub's TCP server. See isTcpNodelay() for more information.
    
    Parameters:
    
    tcpNodelay - TCP_NODELAY flag in receiver hub's TCP server.
    
    Returns:
    
    this for chaining.
  - isDirectBuffer
```
public boolean isDirectBuffer()
```
    Gets direct buffer flag in receiver hub's TCP server.
    Defaults to DFLT_DIRECT_BUF.
    
    Returns:
    
    Direct buffer flag in receiver hub's TCP server.
  - setDirectBuffer
```
public DrReceiverConfiguration setDirectBuffer(boolean directBuf)
```
    Sets direct buffer flag in receiver hub's TCP server. See isDirectBuffer() for more information.
    
    Parameters:
    
    directBuf - Direct buffer flag in receiver hub's TCP server.
    
    Returns:
    
    this for chaining.
  - getIdleTimeout
```
public long getIdleTimeout()
```
    Gets idle timeout for receiver hub's TCP server connection.
    Defaults to DFLT_IDLE_TIMEOUT.
    
    Returns:
    
    Idle timeout for receiver hub's TCP server connection.
  - setIdleTimeout
```
public DrReceiverConfiguration setIdleTimeout(long idleTimeout)
```
    Sets idle timeout for receiver hub's TCP server connection. See getWriteTimeout() for more information.
    
    Parameters:
    
    idleTimeout - Idle timeout for receiver hub's TCP server connection.
    
    Returns:
    
    this for chaining.
  - getWriteTimeout
```
public long getWriteTimeout()
```
    Gets write timeout for receiver hub's TCP server connection.
    Defaults to DFLT_WRITE_TIMEOUT.
    
    Returns:
    
    Write timeout for receiver hub's TCP server connection.
  - setWriteTimeout
```
public DrReceiverConfiguration setWriteTimeout(long writeTimeout)
```
    Sets write timeout for receiver hub's TCP server connection. See getWriteTimeout() for more information.
    
    Parameters:
    
    writeTimeout - Write timeout for receiver hub's TCP server connection.
    
    Returns:
    
    this for chaining.
  - getFlushFrequency
```
public long getFlushFrequency()
```
    Gets data flush frequency. Defines how often receiver hub flushes batches received from sender hubs to receiver caches.
    Defaults to DFLT_FLUSH_FREQ.
    
    Returns:
    
    Data flush frequency.
  - setFlushFrequency
```
public DrReceiverConfiguration setFlushFrequency(long flushFreq)
```
    Sets data flush frequency. See getFlushFrequency() for more information.
    
    Parameters:
    
    flushFreq - Data flush frequency.
    
    Returns:
    
    this for chaining.
  - getPerNodeBufferSize
```
public int getPerNodeBufferSize()
```
    Gets per-node data buffer size. When amount of cache entries enqueued for particular receiver cache data node exceeds this limit, pending data will be flushed to that data node.
    Defaults to DFLT_PER_NODE_BUF_SIZE.
    
    Returns:
    
    Per-node data buffer size.
  - setPerNodeBufferSize
```
public DrReceiverConfiguration setPerNodeBufferSize(int perNodeBufSize)
```
    Sets per-node data buffer size. See getPerNodeBufferSize() for more information.
    
    Parameters:
    
    perNodeBufSize - Per-node data buffer size.
    
    Returns:
    
    this for chaining.
  - getPerNodeParallelLoadOperations
```
public int getPerNodeParallelLoadOperations()
```
    Gets per-node parallel load operations. Defines how many data flush operations can be performed on a single receiver cache data node simultaneously.
    Defaults DFLT_PARALLEL_LOAD_OPS.
    
    Returns:
    
    Per-node parallel load operations
  - setPerNodeParallelLoadOperations
```
public DrReceiverConfiguration setPerNodeParallelLoadOperations(int perNodeParallelLoadOps)
```
    Sets per-node parallel load operations. See getPerNodeParallelLoadOperations() for more information.
    
    Parameters:
    
    perNodeParallelLoadOps - Per-node parallel load operations
    
    Returns:
    
    this for chaining.
  - getSslContextFactory
```
public javax.cache.configuration.Factory<SSLContext> getSslContextFactory()
```
    Gets SSL context factory. If present replication will be performed through secure SSL channel created with this factory. If not present isUseIgniteSslContextFactory() flag will be evaluated. If set to true and IgniteConfiguration.getSslContextFactory() exists, then Ignite SSL context factory will be used to establish secure connection.
    
    Returns:
    
    SSL context factory.
  - setSslContextFactory
```
public DrReceiverConfiguration setSslContextFactory(javax.cache.configuration.Factory<SSLContext> sslCtxFactory)
```
    Sets SSL context factory. See getSslContextFactory() for more information.
    
    Parameters:
    
    sslCtxFactory - SSL context factory. Passing null will clear previously set SSL context factory.
    
    Returns:
    
    this for chaining.
  - isUseIgniteSslContextFactory
```
public boolean isUseIgniteSslContextFactory()
```
    Gets whether to use Ignite SSL context factory configured through IgniteConfiguration.getSslContextFactory() if getSslContextFactory() is not set.
    
    Returns:
    
    True if Ignite SSL context factory can be used.
  - setUseIgniteSslContextFactory
```
public DrReceiverConfiguration setUseIgniteSslContextFactory(boolean useIgniteSslCtxFactory)
```
    Sets whether to use Ignite SSL context factory. See isUseIgniteSslContextFactory() for more information.
    
    Parameters:
    
    useIgniteSslCtxFactory - Whether to use Ignite SSL context factory
    
    Returns:
    
    this for chaining.
  - getSocketSendBufferSize
```
public int getSocketSendBufferSize()
```
    Gets socket send buffer size in bytes. Will be applied to all remote connections.
    Defaults to 0, what means that OS default value will be used.
    
    Returns:
    
    Socket send buffer size in bytes.
  - setSocketSendBufferSize
```
public DrReceiverConfiguration setSocketSendBufferSize(int sockSndBufSize)
```
    Sets socket send buffer size in bytes. See getSocketSendBufferSize() for more information.
    
    Parameters:
    
    sockSndBufSize - Socket send buffer size in bytes.
    
    Returns:
    
    this for chaining.
  - getSocketReceiveBufferSize
```
public int getSocketReceiveBufferSize()
```
    Gets socket receive buffer size in bytes. Will be applied to all remote connections.
    Defaults to 0, what means that OS default value will be used.
    
    Returns:
    
    Socket receive buffer size in bytes.
  - setSocketReceiveBufferSize
```
public DrReceiverConfiguration setSocketReceiveBufferSize(int sockRcvBufSize)
```
    Sets socket receive buffer size in bytes. See getSocketReceiveBufferSize() for more information.
    
    Parameters:
    
    sockRcvBufSize - Socket receive buffer size in bytes.
    
    Returns:
    
    this for chaining.
  - isLazyBinaryMetadataRegistration
```
public boolean isLazyBinaryMetadataRegistration()
```
    Gets metadata registration mode flag: - true metadata is registered on the received cluster only when data that is replicated; - false all metadata received from the master cluster are registered.
    
    Returns:
    
    metadata registration mode flag.
  - setLazyBinaryMetadataRegistration
```
public void setLazyBinaryMetadataRegistration(boolean lazyBinaryMetadataRegistration)
```
    Sets register metadata mode: - true metadata is registered on the received cluster only when data that is replicated; - false all metadata received from the master cluster are registered.
    
    Parameters:
    
    lazyBinaryMetadataRegistration - metadata registration mode flag.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DrReceiverConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DFLT_LOCAL_PORT

DFLT_SELECTOR_CNT

DFLT_WORKER_THREAD_CNT

DFLT_MSG_QUEUE_LIMIT

DFLT_TCP_NODELAY

DFLT_DIRECT_BUF

DFLT_IDLE_TIMEOUT

DFLT_WRITE_TIMEOUT

DFLT_FLUSH_FREQ

DFLT_PER_NODE_BUF_SIZE

DFLT_PARALLEL_LOAD_OPS

DFLT_USE_IGNITE_SSL_CTX_FACTORY

Constructor Detail

DrReceiverConfiguration

DrReceiverConfiguration

Method Detail

getLocalInboundHost

setLocalInboundHost

getLocalInboundPort

setLocalInboundPort

getSelectorCount

setSelectorCount

getWorkerThreads

setWorkerThreads

getMessageQueueLimit

setMessageQueueLimit

isTcpNodelay

setTcpNodelay

isDirectBuffer

setDirectBuffer

getIdleTimeout

setIdleTimeout

getWriteTimeout

setWriteTimeout

getFlushFrequency

setFlushFrequency

getPerNodeBufferSize

setPerNodeBufferSize

getPerNodeParallelLoadOperations

setPerNodeParallelLoadOperations

getSslContextFactory

setSslContextFactory

isUseIgniteSslContextFactory

setUseIgniteSslContextFactory

getSocketSendBufferSize

setSocketSendBufferSize

getSocketReceiveBufferSize

setSocketReceiveBufferSize

isLazyBinaryMetadataRegistration

setLazyBinaryMetadataRegistration

toString