// -*- C++ -*-

//=============================================================================
/**
 *  @file    Servant_Impl_Base.h
 *
 *  $Id$
 *
 *  This file contains the non-template declaration of a base class for
 *  the template mixin for the generated servant class.
 *
 *  @author Jeff Parsons <j.parsons@vanderbilt.edu>
 */
//=============================================================================


#ifndef CIAO_SERVANT_IMPL_BASE_H
#define CIAO_SERVANT_IMPL_BASE_H

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

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

#include "ace/Active_Map_Manager_T.h"
#include "ace/Thread_Mutex.h"

#include "CCM_EventsC.h"
#include "CIAO_Server_Export.h"
#include "CCM_ContainerC.h"
#include "CCM_ObjectS.h"
#include "CCM_StandardConfiguratorC.h"
#include "Home_Servant_Impl_Base.h"
#include "Servant_Activator.h"

namespace CIAO
{
  class Session_Container;

  /**
   * @class Servant_Impl_Base
   *
   * @brief Non-template base class for Servant_Impl.
   *
   * Holds the non-template parts of its child class
   * Servant_Impl.
   */
  class CIAO_SERVER_Export Servant_Impl_Base
    : public virtual POA_Components::CCMObject
  {
  public:
    Servant_Impl_Base (Components::CCMHome_ptr home,
                       Home_Servant_Impl_Base *home_servant,
                       Session_Container * c);

    virtual ~Servant_Impl_Base (void);

    /// Operations for CCMObject interface.

    virtual ::Components::PrimaryKeyBase *
    get_primary_key ()
      ACE_THROW_SPEC ((CORBA::SystemException,
                       Components::NoKeyAvailable));

    virtual CORBA::IRObject_ptr
    get_component_def ()
      ACE_THROW_SPEC ((CORBA::SystemException));

    virtual Components::SessionComponent_ptr
    get_executor ()
      ACE_THROW_SPEC ((CORBA::SystemException)) = 0;

    virtual void
    configuration_complete ()
      ACE_THROW_SPEC ((CORBA::SystemException,
                       Components::InvalidConfiguration));

    virtual void
    remove ()
      ACE_THROW_SPEC ((CORBA::SystemException,
                       Components::RemoveFailure));

    virtual ::Components::ConnectionDescriptions *
    get_connections (const char *name)
      ACE_THROW_SPEC ((CORBA::SystemException,
                       Components::InvalidName));

    virtual ::Components::ComponentPortDescription *
    get_all_ports ()
      ACE_THROW_SPEC ((CORBA::SystemException));

    virtual CORBA::Object_ptr
    provide_facet (const char *name)
      ACE_THROW_SPEC ((CORBA::SystemException,
                       Components::InvalidName));

    virtual ::Components::FacetDescriptions *
    get_named_facets (const ::Components::NameList & names)
      ACE_THROW_SPEC ((CORBA::SystemException,
                       Components::InvalidName));

    virtual ::Components::FacetDescriptions *
    get_all_facets ()
      ACE_THROW_SPEC ((CORBA::SystemException));


    virtual ::Components::ConsumerDescriptions *
    get_all_consumers ()
      ACE_THROW_SPEC ((CORBA::SystemException));


    virtual ::Components::EventConsumerBase_ptr
    get_consumer (const char *sink_name)
      ACE_THROW_SPEC ((CORBA::SystemException,
                       Components::InvalidName));

    virtual ::Components::ConsumerDescriptions *
    get_named_consumers (const ::Components::NameList & names)
      ACE_THROW_SPEC ((CORBA::SystemException,
                       Components::InvalidName));

    virtual ::Components::EmitterDescriptions *
    get_named_emitters (const ::Components::NameList & names)
      ACE_THROW_SPEC ((CORBA::SystemException,
                       Components::InvalidName));

    virtual ::Components::ReceptacleDescriptions *
    get_named_receptacles (const ::Components::NameList & names)
      ACE_THROW_SPEC ((CORBA::SystemException,
                       Components::InvalidName));

    virtual ::Components::ReceptacleDescriptions *
    get_all_receptacles ()
      ACE_THROW_SPEC ((CORBA::SystemException));

    virtual ::Components::PublisherDescriptions *
    get_named_publishers (const ::Components::NameList & names)
      ACE_THROW_SPEC ((CORBA::SystemException,
                       Components::InvalidName));

    /// Operation to set attributes on the component.
    virtual void set_attributes (const Components::ConfigValues &descr) = 0;

    // Creates and returns the StandardConfigurator for the component.
    virtual ::Components::StandardConfigurator_ptr
    get_standard_configurator ()
      ACE_THROW_SPEC ((CORBA::SystemException));

    /// Override that returns the (passed-in) default POA of our member
    /// component's container, to ensure that we get registered
    /// to that POA when _this() is called.
    virtual PortableServer::POA_ptr _default_POA (
      );

  protected:
    void add_facet (const char *port_name,
                    ::CORBA::Object_ptr port_ref)
      ACE_THROW_SPEC (( ::CORBA::SystemException));

    CORBA::Object_ptr lookup_facet (const char *port_name);

    ::Components::FacetDescription *lookup_facet_description (
        const char *port_name
      );

    void add_receptacle (const char *receptacle_name,
                         CORBA::Object_ptr recept_ref,
                         ::Components::Cookie * cookie);

    void add_consumer (const char *port_name,
                       ::Components::EventConsumerBase_ptr port_ref)
      ACE_THROW_SPEC (( ::CORBA::SystemException));

    ::Components::EventConsumerBase_ptr lookup_consumer (
        const char *port_name
      );

    ::Components::ConsumerDescription *lookup_consumer_description (
        const char *port_name
      );

    /// Called from generated servant class to help with
    /// get_all_*() methods.

    template<typename T_var>
    static void describe_simplex_receptacle (
        const char *port_name,
        const char *port_type_repo_id,
        T_var &connection,
        ::Components::ReceptacleDescriptions_var &descriptions,
        CORBA::ULong slot
      );

    template<typename T_var>
    static void describe_multiplex_receptacle (
        const char *port_name,
        const char *port_type_repo_id,
        ACE_Active_Map_Manager<T_var> &objrefs,
        ::Components::ReceptacleDescriptions_var &descriptions,
        CORBA::ULong slot
      );

    template<typename T_var>
    static void describe_pub_event_source (
        const char *port_name,
        const char *port_type_repo_id,
        ACE_Active_Map_Manager<T_var> &consumers,
        ::Components::PublisherDescriptions_var &descriptions,
        CORBA::ULong slot
      );

    template<typename T_var>
    static void describe_emit_event_source (
        const char *port_name,
        const char *port_type_repo_id,
        T_var &consumer_ref,
        ::Components::EmitterDescriptions_var &descriptions,
        CORBA::ULong slot
      );

  protected:
    typedef ACE_Array_Map<ACE_CString,
                          ::Components::FacetDescription_var>
       FacetTable;

    typedef ACE_Array_Map<ACE_CString,
                          ::Components::ConsumerDescription_var>
       ConsumerTable;

    typedef ACE_Hash_Map_Manager_Ex<const char *,
                                    ::Components::ReceptacleDescription_var,
                                    ACE_Hash<const char *>,
                                    ACE_Equal_To<const char *>,
                                    ACE_Null_Mutex>
       ReceptacleTable;

    FacetTable facet_table_;
    ConsumerTable consumer_table_;
    ReceptacleTable receptacle_table_;
    Components::CCMHome_var home_;
    Home_Servant_Impl_Base *home_servant_;
    Session_Container * container_;
  private:
    /// Not allowed to be used
    Servant_Impl_Base (void);

  private:
    /// For internal locking of table reads and writes.
    TAO_SYNCH_MUTEX lock_;
  };
}

#if defined (ACE_TEMPLATES_REQUIRE_SOURCE)
#include "Servant_Impl_Utils_T.cpp"
#endif /* ACE_TEMPLATES_REQUIRE_SOURCE */

#if defined (ACE_TEMPLATES_REQUIRE_PRAGMA)
#pragma implementation ("Servant_Impl_Utils_T.cpp")
#endif /* ACE_TEMPLATES_REQUIRE_PRAGMA */

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

#endif /* CIAO_SERVANT_IMPL_T_H */