TAO/tao/TAO_Internal.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    TAO_Internal.h
   6  *
   7  *  Structures and methods completely internal to TAO.
   8  *
   9  *  @author Chris Cleeland
  10  */
  11 //=============================================================================
  12
  13 #ifndef TAO_INTERNAL_H
  14 #define TAO_INTERNAL_H
  15
  16 #include /**/ "ace/pre.h"
  17
  18 #include /**/ "tao/TAO_Export.h"
  19 #include "tao/orbconf.h"
  20
  21 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  22 # pragma once
  23 #endif /* ACE_LACKS_PRAGMA_ONCE */
  24
  25 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  26 /// Forward declaration
  27 class ACE_Service_Gestalt;
  28 template <class X> class ACE_Intrusive_Auto_Ptr;
  29 ACE_END_VERSIONED_NAMESPACE_DECL
  30
  31 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  32
  33 namespace TAO
  34 {
  35   /**
  36    * @namespace ORB
  37    *
  38    * @brief This @c namespace encapsulates some behaviors and
  39    *        global data structures used by TAO.
  40    *        Only default_svc_conf_entries() is exported because it is
  41    *        documented as a way for applications to setup default svc.conf
  42    *        settings. The other operations are internal and
  43    *        application should NEVER use them which is why they are not
  44    *        exported.
  45    */
  46   namespace ORB
  47   {
  48     /**
  49      * If never done it before, extract ACE Service Configurator arguments from the given
  50      * argument vector, and initialize the _global_ configuration gestalt.
  51      * @retval 0 means OK,
  52      * @retval -1 spells major trouble
  53      */
  54     int open_global_services (int argc, ACE_TCHAR** argv);
  55
  56     /**
  57      * Extract ACE Service Configurator arguments from the given
  58      * argument vector, and initialize the ACE Service Configurator.
  59      *
  60      * @note This method should be called before the ORB Core is
  61      *       initialized, and before any ORBInitializers are invoked.
  62      */
  63     int open_services (ACE_Intrusive_Auto_Ptr<ACE_Service_Gestalt> cfg, int& argc, ACE_TCHAR** argv);
  64
  65     /**
  66      * The complement to @c open_services(), this will perform
  67      * appropriate ACE Service Configurator closure operations.  It
  68      * should be called as many times as @c open_services(), and will
  69      * only actually close things down on the last call.  It is fully
  70      * thread-safe.
  71      *
  72      * @retval 0 if successful
  73      * @retval -1 failure with @c errno set
  74      */
  75     int close_services (ACE_Intrusive_Auto_Ptr<ACE_Service_Gestalt> pcfg);
  76
  77     /**
  78      * Set default @c `svc.conf' content, only non-null values are set.
  79      * This function must be called before first ORB initialization.
  80      * @arg rf_args Resource factory settings
  81      * @arg ssf_args Server strategy factory settings
  82      * @arg csf_args Client strategy factory settings
  83      */
  84     TAO_Export void default_svc_conf_entries (char const * rf_args,
  85                                               char const * ssf_args,
  86                                               char const * csf_args);
  87   }
  88 }
  89
  90 TAO_END_VERSIONED_NAMESPACE_DECL
  91
  92 #include /**/ "ace/post.h"
  93
  94 #endif  /* TAO_INTERNAL_H */