GemFire 7.0.1

com.gemstone.gemfire.cache.asyncqueue
Interface AsyncEventQueueFactory


public interface AsyncEventQueueFactory

Factory to create the AsyncEventQueue.

Since:
7.0

Method Summary
 AsyncEventQueue create(String id, AsyncEventListener listener)
          Creates the AsyncEventQueue.
 AsyncEventQueueFactory setBatchConflationEnabled(boolean isConflation)
          Sets whether to enable batch conflation for AsyncEventQueue
 AsyncEventQueueFactory setBatchSize(int size)
          Sets the batch size for an AsyncEventQueue's queue.
 AsyncEventQueueFactory setBatchTimeInterval(int interval)
          Sets the batch time interval for a AsyncEventQueue.
 AsyncEventQueueFactory setDiskStoreName(String name)
          Sets the disk store name for overflow or persistence.
 AsyncEventQueueFactory setDiskSynchronous(boolean isSynchronous)
          Sets whether or not the writing to the disk is synchronous.
 AsyncEventQueueFactory setDispatcherThreads(int numThreads)
          Sets the number of dispatcher thread
 AsyncEventQueueFactory setMaximumQueueMemory(int memory)
          Sets the maximum amount of memory (in MB) for an AsyncEventQueue's queue.
 AsyncEventQueueFactory setOrderPolicy(Gateway.OrderPolicy policy)
          Sets the order policy for multiple dispatchers
 AsyncEventQueueFactory setParallel(boolean isParallel)
          Indicates whether all VMs need to distribute events to remote site.
 AsyncEventQueueFactory setPersistent(boolean isPersistent)
          Sets whether the AsyncEventQueue is persistent or not.
 

Method Detail

setDiskStoreName

AsyncEventQueueFactory setDiskStoreName(String name)
Sets the disk store name for overflow or persistence.

Parameters:
name -

setMaximumQueueMemory

AsyncEventQueueFactory setMaximumQueueMemory(int memory)
Sets the maximum amount of memory (in MB) for an AsyncEventQueue's queue.

Parameters:
memory - The maximum amount of memory (in MB) for an AsyncEventQueue's queue

setDiskSynchronous

AsyncEventQueueFactory setDiskSynchronous(boolean isSynchronous)
Sets whether or not the writing to the disk is synchronous.

Parameters:
isSynchronous - boolean if true indicates synchronous writes

setBatchSize

AsyncEventQueueFactory setBatchSize(int size)
Sets the batch size for an AsyncEventQueue's queue.

Parameters:
size - The size of batches sent to its AsyncEventListener

setBatchTimeInterval

AsyncEventQueueFactory setBatchTimeInterval(int interval)
Sets the batch time interval for a AsyncEventQueue.

Parameters:
interval - The maximum time interval that can elapse before a partial batch is sent from a AsyncEventQueue.

setPersistent

AsyncEventQueueFactory setPersistent(boolean isPersistent)
Sets whether the AsyncEventQueue is persistent or not.

Parameters:
isPersistent - Whether to enable persistence for an AsyncEventQueue.

setParallel

AsyncEventQueueFactory setParallel(boolean isParallel)
Indicates whether all VMs need to distribute events to remote site. In this case only the events originating in a particular VM will be in dispatched in order.

Parameters:
isParallel - boolean to indicate whether distribution policy is parallel

setBatchConflationEnabled

AsyncEventQueueFactory setBatchConflationEnabled(boolean isConflation)
Sets whether to enable batch conflation for AsyncEventQueue

Parameters:
isConflation - Whether or not to enable batch conflation for batches sent from a AsyncEventQueue

setDispatcherThreads

AsyncEventQueueFactory setDispatcherThreads(int numThreads)
Sets the number of dispatcher thread

Parameters:
numThreads -

setOrderPolicy

AsyncEventQueueFactory setOrderPolicy(Gateway.OrderPolicy policy)
Sets the order policy for multiple dispatchers

Parameters:
policy -

create

AsyncEventQueue create(String id,
                       AsyncEventListener listener)
Creates the AsyncEventQueue. It accepts Id of AsyncEventQueue and instance of AsyncEventListener. Multiple queues can be created using Same listener instance. So, the instance of AsyncEventListener should be thread safe in that case. The AsyncEventListener will start receiving events when the AsyncEventQueue is created.

Parameters:
id - Id of AsyncEventQueue
listener - AsyncEventListener to be added to the regions that are configured to use this queue.

GemFire 7.0.1

Copyright © 1997-2013 VMware, Inc. All rights reserved.