/* -*- C++ -*- */
/**
 *  @file   ECG_Reconnect_ConsumerEC_Control.h
 *
 *  ECG_Reconnect_ConsumerEC_Control.h,v 1.4 2004/09/05 16:22:44 ossama Exp
 *
 *  @author Johnny Willemsen (jwillemsen@remedy.nl)
 *
 */

#ifndef TAO_ECG_RECONNECT_CONSUMEREC_CONTROL_H
#define TAO_ECG_RECONNECT_CONSUMEREC_CONTROL_H

#include /**/ "ace/pre.h"

#include "ECG_ConsumerEC_Control.h"

#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */

#include "tao/ORB.h"
#include "tao/PolicyC.h"

#include "ace/Event_Handler.h"

class TAO_ECG_Reconnect_ConsumerEC_Control;
class TAO_EC_Gateway_IIOP;

/**
 * @class TAO_ECG_Reconnect_ConsumerEC_Control_Adapter
 *
 * @brief Forwards timeout events to the Reconnect ConsumerControl
 *
 * The Reconnect ConsumerControl strategy uses the reactor to
 * periodically wakeup and verify the state of the consumers
 * registered with the Event Channel.
 */
class TAO_RTEvent_Export TAO_ECG_Reconnect_ConsumerEC_Control_Adapter
  : public ACE_Event_Handler
{
public:
  /// Constructor
  TAO_ECG_Reconnect_ConsumerEC_Control_Adapter (TAO_ECG_Reconnect_ConsumerEC_Control *adaptee);

  // = Documented in ACE_Event_Handler.
  virtual int handle_timeout (const ACE_Time_Value &tv,
                              const void *arg = 0);

private:
  /// The adapted object
  TAO_ECG_Reconnect_ConsumerEC_Control *adaptee_;
};

/**
 * @class TAO_ECG_Reconnect_ConsumerEC_Control
 *
 * @brief Consumer event channel control
 *
 * Defines the interface for the consumer event channel control strategy.
 * This strategy handles misbehaving or failing consumer event channels.
 *
 * This control tries to reconnect to the consumer ec incase of a connection
 * loss and then does a reconnect when the connection is back again. When also
 * a restart of the consumer ec must be handled correctly, then the consumer
 * ec must use a persistent IOR.
 */
class TAO_RTEvent_Export TAO_ECG_Reconnect_ConsumerEC_Control
  : public TAO_ECG_ConsumerEC_Control
{
public:
  /// Constructor.  It does not assume ownership of the @a event_channel
  /// parameter.
  TAO_ECG_Reconnect_ConsumerEC_Control (const ACE_Time_Value &rate,
                                        const ACE_Time_Value &timeout,
                                        TAO_EC_Gateway_IIOP* gateway,
                                        CORBA::ORB_ptr orb);

  /// Destructor.
  virtual ~TAO_ECG_Reconnect_ConsumerEC_Control (void);

  /// Receive the timeout from the adapter
  void handle_timeout (const ACE_Time_Value &tv,
                       const void* arg);

  // = Documented in TAO_EC_ConsumerControl
  virtual int activate (void);
  virtual int shutdown (void);
  virtual void event_channel_not_exist (TAO_EC_Gateway_IIOP *gateway
                                        ACE_ENV_ARG_DECL_NOT_USED);
  virtual void system_exception (TAO_EC_Gateway_IIOP *gateway,
                                 CORBA::SystemException &
                                 ACE_ENV_ARG_DECL_NOT_USED);

private:
  /// Check if the consumers still exists.  It is a helper method for
  /// handle_timeout() to isolate the exceptions.
  void query_eventchannel (ACE_ENV_SINGLE_ARG_DECL);

  /// Look if we can reconnect again.
  void try_reconnect (ACE_ENV_SINGLE_ARG_DECL);

  /// Reconnect to the consumer ec.
  void reconnect (ACE_ENV_SINGLE_ARG_DECL);

private:
  /// The polling rate
  ACE_Time_Value rate_;

  /// The polling timeout
  ACE_Time_Value timeout_;

  /// The Adapter for the reactor events
  TAO_ECG_Reconnect_ConsumerEC_Control_Adapter adapter_;

  /// The gateway
  TAO_EC_Gateway_IIOP* gateway_;

  /// The ORB
  CORBA::ORB_var orb_;

  /// To control the timeout policy in the thread
  CORBA::PolicyCurrent_var policy_current_;

  /// Precomputed policy list to the set timeout.
  CORBA::PolicyList policy_list_;

  /// The ORB reactor
  ACE_Reactor *reactor_;

  /// Do we have a connection to the consumer ec
  int is_consumer_ec_connected_;
};

#include /**/ "ace/post.h"

#endif /* TAO_ECG_RECONNECT_CONSUMEREC_CONTROL_H */
