geode-client-native/src/cppcache/impl/SuspendedTxExpiryHandler.hpp

/*=========================================================================
 * Copyright (c) 2010-2014 Pivotal Software, Inc. All Rights Reserved.
 * This product is protected by U.S. and international copyright
 * and intellectual property laws. Pivotal products are covered by
 * one or more patents listed at http://www.pivotal.io/patents.
 *=========================================================================
 */
#ifndef _GEMFIRE_SUSPENDEDTXEXPIRYTASK_H__
#define _GEMFIRE_SUSPENDEDTXEXPIRYTASK_H__

#include "../gfcpp_globals.hpp"
#include "../Cache.hpp"
#include "CacheTransactionManagerImpl.hpp"

/**
 * @file
 */

namespace gemfire {
class CacheTransactionManagerImpl;
/**
 * @class SuspendedTxExpiryHandler
 *
 * The task object which contains the handler which gets triggered
 * when a suspended transaction expires.
 *
 */
class CPPCACHE_EXPORT SuspendedTxExpiryHandler : public ACE_Event_Handler {

 public:

   /**
    * Constructor
    */
   SuspendedTxExpiryHandler(CacheTransactionManagerImpl* cacheTxMgr, 
                            TransactionIdPtr txid,
                            uint32_t duration);

   /** This task object will be registered with the Timer Queue.
    *  When the timer expires the handle_timeout is invoked.
    */
   int handle_timeout( const ACE_Time_Value &current_time, const void * arg);
   /**
    * This is called when the task object needs to be cleaned up..
    */
   int handle_close( ACE_HANDLE handle, ACE_Reactor_Mask close_mask );

 private:

   // Duration after which the task should be reset in case of
   // modification.
   uint32_t m_duration;
   CacheTransactionManagerImpl* m_cacheTxMgr;
   TransactionIdPtr m_txid;   
};
} //namespace gemfire
#endif //ifndef _GEMFIRE_ENTRYEXPIRYTASK_H__