com.gemstone.gemfire.cache.wan.GatewayEventFilter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation

SnappyData store based off Pivotal GemFireXD

The newest version!

/*
 * Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
 *
 * Licensed 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. See accompanying
 * LICENSE file.
 */
package com.gemstone.gemfire.cache.wan;

import com.gemstone.gemfire.cache.CacheCallback;

/**
 * Callback for users to filter out events before dispatching to remote
 * distributed system
 * 
 * @author Suranjan Kumar
 * @author Yogesh Mahajan
 * 
 * @since 7.0
 */
public interface GatewayEventFilter extends CacheCallback {

  /**
   * It will be invoked before enqueuing event into GatewaySender's queue. 

   * This callback is synchronous with the thread which is enqueuing the event
   * into GatewaySender's queue.
   * 
   * @param event
   * @return true if event should be enqueued otherwise return false.
   */
  public boolean beforeEnqueue(GatewayQueueEvent event);

  /**
   * It will be invoked before dispatching event to remote GatewayReceiver 

   * This callback is asynchronous with the thread which is enqueuing the event
   * into GatewaySender's queue.

   * This callback will always be called from the thread which is dispatching
   * events to remote distributed systems
   * 
   * @param event
   * @return true if event should be dispatched otherwise return false.
   */
  public boolean beforeTransmit(GatewayQueueEvent event);

  /**
   * It will be invoked once GatewaySender receives an ack from remote
   * GatewayReceiver 

   * This callback will always be called from the thread which is dispatching
   * events to remote distributed systems
   * 
   * @param event
   */
  public void afterAcknowledgement(GatewayQueueEvent event);

}