org.apache.geode.cache.wan.GatewaySender Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of geode-core Show documentation
Show all versions of geode-core Show documentation
Apache Geode provides a database-like consistency model, reliable transaction processing and a shared-nothing architecture to maintain very low latency performance with high concurrency processing
/*
* Licensed to the Apache Software Foundation (ASF) under one or more contributor license
* agreements. See the NOTICE file distributed with this work for additional information regarding
* copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the License. You may obtain a
* copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package org.apache.geode.cache.wan;
import org.apache.geode.distributed.internal.DistributionConfig;
import java.util.List;
/**
*
*
* @since GemFire 7.0
*/
public interface GatewaySender {
/**
* The default value (false) for manually starting a GatewaySender.
*/
public static final boolean DEFAULT_MANUAL_START = false;
/**
* The default value ( true) for writing to disk synchronously in case of persistence.
*/
public static final boolean DEFAULT_DISK_SYNCHRONOUS = true;
/**
* The default buffer size for socket buffers from a sending GatewaySender to its receiving
* GatewayReceiver.
*/
public static final int DEFAULT_SOCKET_BUFFER_SIZE = 524288;
/**
* The default amount of time in milliseconds that a socket read between a sending
* Gateway and its receiving Gateway will block.
*/
public static final int DEFAULT_SOCKET_READ_TIMEOUT = Integer
.getInteger(
DistributionConfig.GEMFIRE_PREFIX + "cache.gatewaySender.default-socket-read-timeout", 0)
.intValue();
/**
* The default minimum socket read timeout.
*/
public static final int MINIMUM_SOCKET_READ_TIMEOUT = 30000;
/**
* Size of the oplog file used for the persistent queue in bytes
*/
static public final int QUEUE_OPLOG_SIZE =
Integer.getInteger(DistributionConfig.GEMFIRE_PREFIX + "cache.gatewaySender.queueOpLogSize",
1024 * 1024 * 100).intValue();
/**
* The default value (false)of whether to persist queue data to disk or not.
*/
public static final boolean DEFAULT_PERSISTENCE_ENABLED = false;
/**
* The default batch conflation
*/
public static final boolean DEFAULT_BATCH_CONFLATION = false;
/**
* The default batch size
*/
public static final int DEFAULT_BATCH_SIZE = 100;
/**
* The default batch time interval in milliseconds
*/
public static final int DEFAULT_BATCH_TIME_INTERVAL = 1000;
/**
* The default alert threshold in milliseconds
*/
public static final int DEFAULT_ALERT_THRESHOLD = 0;
public static final int DEFAULT_PARALLELISM_REPLICATED_REGION =
Integer.getInteger(DistributionConfig.GEMFIRE_PREFIX
+ "cache.gatewaySender.defaultParallelismForReplicatedRegion", 113).intValue();
public static final int DEFAULT_DISTRIBUTED_SYSTEM_ID = -1;
public static final int DEFAULT_DISPATCHER_THREADS = 5;
public static final boolean DEFAULT_FORWARD_EXPIRATION_DESTROY = false;
public static final OrderPolicy DEFAULT_ORDER_POLICY = OrderPolicy.KEY;
/**
* The default maximum amount of memory (MB) to allow in the queue before overflowing entries to
* disk
*/
public static final int DEFAULT_MAXIMUM_QUEUE_MEMORY = 100;
/**
* Time, in seconds, that we allow before a GatewaySender is considered dead and should be
* aborted
*/
public static final long GATEWAY_SENDER_TIMEOUT = Integer
.getInteger(DistributionConfig.GEMFIRE_PREFIX + "GATEWAY_SENDER_TIMEOUT", 30).intValue();
/**
* The obsolete socket read timeout java system property. Since customers have been given this
* property, it is used to log a warning.
*/
public static final String GATEWAY_CONNECTION_READ_TIMEOUT_PROPERTY =
DistributionConfig.GEMFIRE_PREFIX + "GatewaySender.GATEWAY_CONNECTION_READ_TIMEOUT";
public static final int GATEWAY_CONNECTION_IDLE_TIMEOUT = Integer
.getInteger(
DistributionConfig.GEMFIRE_PREFIX + "GatewaySender.GATEWAY_CONNECTION_IDLE_TIMEOUT", -1)
.intValue();
/**
* If the System property is set, use it. Otherwise, set default to 'true'.
*/
public static final boolean REMOVE_FROM_QUEUE_ON_EXCEPTION = (System.getProperty(
DistributionConfig.GEMFIRE_PREFIX + "GatewaySender.REMOVE_FROM_QUEUE_ON_EXCEPTION") != null)
? Boolean.getBoolean(
DistributionConfig.GEMFIRE_PREFIX + "GatewaySender.REMOVE_FROM_QUEUE_ON_EXCEPTION")
: true;
public static final boolean EARLY_ACK =
Boolean.getBoolean(DistributionConfig.GEMFIRE_PREFIX + "GatewaySender.EARLY_ACK");
public static final boolean DEFAULT_IS_PARALLEL = false;
public static final boolean DEFAULT_IS_FOR_INTERNAL_USE = false;
/**
* Retry a connection from sender to receiver after specified time interval (in milliseconds) in
* case receiver is not up and running. Default is set to 1000 milliseconds i.e. 1 second.
*/
public static final int CONNECTION_RETRY_INTERVAL = Integer
.getInteger(DistributionConfig.GEMFIRE_PREFIX + "gateway-connection-retry-interval", 1000)
.intValue();
/**
* The order policy. This enum is applicable only when concurrency-level is > 1.
*
* @since GemFire 6.5.1
*/
public enum OrderPolicy {
/**
* Indicates that events will be parallelized based on the event's originating member and thread
*/
THREAD,
/**
* Indicates that events will be parallelized based on the event's key
*/
KEY,
/**
* Indicates that events will be parallelized based on the event's: - partition (using the
* PartitionResolver) in the case of a partitioned region event - key in the case of a
* replicated region event
*/
PARTITION
}
/**
* Starts this GatewaySender. Once the GatewaySender is running, its configuration cannot be
* changed.
*/
public void start();
/**
* Stops this GatewaySender. The scope of this operation is the VM on which it is invoked. In case
* the GatewaySender is parallel, the GatewaySender will be stopped on individual node where this
* API is called. If the GatewaySender is not parallel, then the GatewaySender will stop on this
* VM and the secondary GatewaySender will become primary and start dispatching events.
*
* The GatewaySender will wait for GatewaySender.MAXIMUM_SHUTDOWN_WAIT_TIME seconds before
* stopping itself. If the system property is set to -1 then it will wait until all the events are
* dispatched from the queue.
*
* @see GatewaySender#isParallel()
*/
public void stop();
/**
* Pauses the dispatching of the events from the underlying queue. It should be kept in mind that
* the events will still be getting queued into the queue. The scope of this operation is the VM
* on which it is invoked. In case the GatewaySender is parallel, the GatewaySender will be paused
* on individual node where this API is called and the GatewaySender on other VM's can still
* dispatch events. In case the GatewaySender is not parallel, and the running GatewaySender on
* which this API is invoked is not primary then PRIMARY GatewaySender will still continue
* dispatching events.
*
* The batch of events that are in the process of being dispatched are dispatched irrespective of
* the state of pause operation. We can expect maximum of one batch of events being received at
* the GatewayReceiver even after the GatewaySenders were paused.
*
* @see GatewaySender#isParallel()
* @see GatewaySender#getBatchSize()
* @see GatewaySender#resume()
*/
public void pause();
/**
* Resumes this paused GatewaySender.
*/
public void resume();
/**
* Rebalances this GatewaySender.
*/
public void rebalance();
/**
* Returns whether or not this GatewaySender is running.
*/
public boolean isRunning();
/**
* Returns whether or not this GatewaySender is paused.
*
*/
public boolean isPaused();
/**
* Adds the provided GatewayEventFilter to this GatewaySender.
*
* @param filter
*/
public void addGatewayEventFilter(GatewayEventFilter filter);
/**
* Removes the provided GatewayEventFilter from this GatewaySender.
*
* @param filter
*/
public void removeGatewayEventFilter(GatewayEventFilter filter);
/**
* Returns this GatewaySender's GatewayEventSubstitutionFilter.
*
* @return this GatewaySender's GatewayEventSubstitutionFilter
*/
public GatewayEventSubstitutionFilter getGatewayEventSubstitutionFilter();
/**
* Returns the id of this GatewaySender.
*
* @return the id of this GatewaySender.
*/
public String getId();
/**
* Returns the id of the remote GatewayReceiver's DistributedSystem.
*
* @return the id of the remote GatewayReceiver's DistributedSystem.
*/
public int getRemoteDSId();
/**
* Returns the configured buffer size of the socket connection between this GatewaySender and its
* receiving GatewayReceiver. The default is 32768 bytes.
*
* @return the configured buffer size of the socket connection between this GatewaySender and its
* receiving GatewayReceiver
*/
public int getSocketBufferSize();
/**
* Returns the amount of time in milliseconds that a socket read between a sending GatewaySender
* and its receiving GatewayReceiver will block. The default value is 0 which is
* interpreted as infinite timeout.
*
* @return the amount of time in milliseconds that a socket read between a sending GatewaySender
* and its receiving GatewayReceiver will block
*/
public int getSocketReadTimeout();
/**
* Gets the disk store name for overflow or persistence.
*
* @return disk store name
*/
public String getDiskStoreName();
/**
* Returns the maximum amount of memory (in MB) for a GatewaySender's queue. The default is 100.
*
* @return maximum amount of memory (in MB) for a GatewaySender's queue
*/
public int getMaximumQueueMemory();
/**
* Returns the batch size for this GatewaySender. Default batchSize is 100.
*
* @return the batch size for this GatewaySender.
*/
public int getBatchSize();
/**
* Returns the batch time interval for this GatewaySender. Default value of batchTimeInterval is
* 1000.
*
* @return the batch time interval for this GatewaySender
*/
public int getBatchTimeInterval();
/**
* Answers whether to enable batch conflation for a GatewaySender 's queue. The default value is
* false.
*
* @return whether to enable batch conflation for batches sent from a GatewaySender to its
* corresponding GatewayReceiver.
*/
public boolean isBatchConflationEnabled();
/**
* Returns true if persistence is enabled for this GatewaySender, otherwise returns false. Default
* is false if not set explicitly.
*
* @return true if persistence is enabled for this GatewaySender
*/
public boolean isPersistenceEnabled();
/**
* Returns the alert threshold in milliseconds for entries in a GatewaySender's queue. Default
* value is 0.
*
* @return the alert threshold for entries in a GatewaySender's queue
*
*/
public int getAlertThreshold();
/**
* Returns the list of GatewayEventFilter added to this GatewaySender.
*
* @return the list of GatewayEventFilter added to this GatewaySender.
*/
public List getGatewayEventFilters();
/**
* Returns the list of GatewayTransportFilter added to this GatewaySender.
*
* @return the list of GatewayTransportFilter added to this GatewaySender.
*/
public List getGatewayTransportFilters();
/**
* Returns isDiskSynchronous boolean property for this GatewaySender. Default value is true.
*
* @return isDiskSynchronous boolean property for this GatewaySender
*
*/
public boolean isDiskSynchronous();
/**
* Returns the manual start boolean property for this GatewaySender. Default is false i.e. the
* GatewaySender will automatically start once created.
*
* @return the manual start boolean property for this GatewaySender
*
*/
public boolean isManualStart();
/**
* Returns isParallel boolean property for this GatewaySender.
*
* @return isParallel boolean property for this GatewaySender
*
*/
public boolean isParallel();
/**
* Returns the number of dispatcher threads working for this GatewaySender. Default
* number of dispatcher threads is 5.
*
* @return the number of dispatcher threads working for this GatewaySender
*/
public int getDispatcherThreads();
/**
* Returns the order policy followed while dispatching the events to remote ds. Order policy is
* set only when dispatcher threads are > 1. Default value of order policy is KEY.
*
* @return the order policy followed while dispatching the events to remote ds.
*/
public OrderPolicy getOrderPolicy();
public int getMaxParallelismForReplicatedRegion();
/**
* Destroys the GatewaySender.
*
* In case of ParallelGatewaySender, the destroy operation does distributed destroy of the Queue
* Region. In case of SerialGatewaySender, the Queue Region is destroyed locally.
*
* @since Geode 1.1
*
*/
void destroy();
}