/usr/include/ace/Service_Config.h is in libace-dev 6.2.8+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 | // -*- C++ -*-
//====================================================================
/**
* @file Service_Config.h
*
* $Id: Service_Config.h 96605 2013-01-02 19:33:30Z tgirard $
*
* @author Douglas C. Schmidt <schmidt@cs.wustl.edu>
*/
//====================================================================
#ifndef ACE_SERVICE_CONFIG_H
#define ACE_SERVICE_CONFIG_H
#include /**/ "ace/pre.h"
#include /**/ "ace/config-all.h"
#include "ace/Default_Constants.h"
#include "ace/Intrusive_Auto_Ptr.h"
#include "ace/Service_Gestalt.h"
#include "ace/Synch_Traits.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#include "ace/OS_NS_signal.h"
ACE_BEGIN_VERSIONED_NAMESPACE_DECL
// Forward decl.
class ACE_Service_Object;
class ACE_Service_Type;
class ACE_Service_Type_Impl;
class ACE_Service_Repository;
class ACE_Sig_Adapter;
class ACE_Allocator;
class ACE_Reactor;
class ACE_Thread_Manager;
class ACE_DLL;
#if (ACE_USES_CLASSIC_SVC_CONF == 1)
#define ACE_STATIC_SERVICE_DIRECTIVE(ident, parameters) \
ACE_TEXT ("static ") \
ACE_TEXT (ident) \
ACE_TEXT (" \"") \
ACE_TEXT (parameters) \
ACE_TEXT ("\"")
#define ACE_DYNAMIC_SERVICE_DIRECTIVE(ident, libpathname, objectclass, parameters) \
ACE_TEXT ("dynamic ") \
ACE_TEXT (ident) \
ACE_TEXT (" Service_Object * ") \
ACE_TEXT (libpathname) \
ACE_TEXT (":") \
ACE_TEXT (objectclass) \
ACE_TEXT ("() \"") \
ACE_TEXT (parameters) \
ACE_TEXT ("\"")
#if defined (ACE_VERSIONED_SO) && (ACE_VERSIONED_SO == 2)
#define ACE_DYNAMIC_VERSIONED_SERVICE_DIRECTIVE(ident, libpathname, version, objectclass, parameters) \
ACE_TEXT ("dynamic ") \
ACE_TEXT (ident) \
ACE_TEXT (" Service_Object * ") \
ACE_DLL_PREFIX \
ACE_TEXT (libpathname) \
ACE_TEXT ("-") \
ACE_TEXT (version) \
ACE_DLL_SUFFIX \
ACE_TEXT (":") \
ACE_TEXT (objectclass) \
ACE_TEXT ("() \"") \
ACE_TEXT (parameters) \
ACE_TEXT ("\"")
#else
#define ACE_DYNAMIC_VERSIONED_SERVICE_DIRECTIVE(ident, libpathname, version, objectclass, parameters) \
ACE_TEXT ("dynamic ") \
ACE_TEXT (ident) \
ACE_TEXT (" Service_Object * ") \
ACE_TEXT (libpathname) \
ACE_TEXT (":") \
ACE_TEXT (objectclass) \
ACE_TEXT ("() \"") \
ACE_TEXT (parameters) \
ACE_TEXT ("\"")
#endif /* ACE_VERSIONED_SO */
#define ACE_REMOVE_SERVICE_DIRECTIVE(ident) \
ACE_TEXT ("remove ") \
ACE_TEXT (ident)
class ACE_Svc_Conf_Param;
#else
#define ACE_STATIC_SERVICE_DIRECTIVE(ident, parameters) \
ACE_TEXT ("<ACE_Svc_Conf><static id=\"") \
ACE_TEXT (ident) \
ACE_TEXT ("\" params=\"") \
ACE_TEXT (parameters) \
ACE_TEXT ("\"/></ACE_Svc_Conf>")
#define ACE_DYNAMIC_SERVICE_DIRECTIVE(ident, libpathname, objectclass, parameters) \
ACE_TEXT ("<ACE_Svc_Conf><dynamic id=\"") \
ACE_TEXT (ident) \
ACE_TEXT ("\" type=\"Service_Object\">") \
ACE_TEXT ("<initializer path=\"") \
ACE_TEXT (libpathname) \
ACE_TEXT ("\" init=\"") \
ACE_TEXT (objectclass) \
ACE_TEXT ("\"") \
ACE_TEXT (" params=\"") \
ACE_TEXT (parameters) \
ACE_TEXT ("\"/></dynamic></ACE_Svc_Conf>")
#if defined (ACE_VERSIONED_SO) && (ACE_VERSIONED_SO == 2)
#define ACE_DYNAMIC_VERSIONED_SERVICE_DIRECTIVE(ident, libpathname, version, objectclass, parameters) \
ACE_TEXT ("<ACE_Svc_Conf><dynamic id=\"") \
ACE_TEXT (ident) \
ACE_TEXT ("\" type=\"Service_Object\">") \
ACE_TEXT ("<initializer path=\"") \
ACE_DLL_PREFIX \
ACE_TEXT (libpathname) \
ACE_TEXT ("-") \
ACE_TEXT (version) \
ACE_DLL_SUFFIX \
ACE_TEXT ("\" init=\"") \
ACE_TEXT (objectclass) \
ACE_TEXT ("\"") \
ACE_TEXT (" params=\"") \
ACE_TEXT (parameters) \
ACE_TEXT ("\"/></dynamic></ACE_Svc_Conf>")
#else
#define ACE_DYNAMIC_VERSIONED_SERVICE_DIRECTIVE(ident, libpathname, version, objectclass, parameters) \
ACE_TEXT ("<ACE_Svc_Conf><dynamic id=\"") \
ACE_TEXT (ident) \
ACE_TEXT ("\" type=\"Service_Object\">") \
ACE_TEXT ("<initializer path=\"") \
ACE_TEXT (libpathname) \
ACE_TEXT ("\" init=\"") \
ACE_TEXT (objectclass) \
ACE_TEXT ("\"") \
ACE_TEXT (" params=\"") \
ACE_TEXT (parameters) \
ACE_TEXT ("\"/></dynamic></ACE_Svc_Conf>")
#endif
#define ACE_REMOVE_SERVICE_DIRECTIVE(ident) \
ACE_TEXT ("<ACE_Svc_Conf><remove id=\"") \
ACE_TEXT (ident) \
ACE_TEXT ("\"></remove></ACE_Svc_Conf>")
class ACE_XML_Svc_Conf;
#endif /* ACE_USES_CLASSIC_SVC_CONF == 1 */
ACE_END_VERSIONED_NAMESPACE_DECL
extern "C"
{
typedef ACE_Service_Object *(*ACE_SERVICE_ALLOCATOR) (ACE_Service_Object_Exterminator *);
}
ACE_BEGIN_VERSIONED_NAMESPACE_DECL
/**
* @class ACE_Static_Svc_Descriptor
*
* @brief Holds the information necessary to describe a statically linked
* Svc.
*/
class ACE_Static_Svc_Descriptor
{
public:
/// Name of the service.
const ACE_TCHAR *name_;
/// Type of service.
int type_;
/// Factory function that allocates the service.
ACE_SERVICE_ALLOCATOR alloc_;
/// Bitmask flags indicating how the framework should delete memory.
u_int flags_;
/// Flag indicating whether the service starts out active.
int active_;
/// Dump the state of an object.
void dump (void) const;
/// Declare the dynamic allocation hooks.
ACE_ALLOC_HOOK_DECLARE;
public:
/// Compare two service descriptors for equality.
bool operator== (ACE_Static_Svc_Descriptor &) const;
/// Compare two service descriptors for inequality.
bool operator!= (ACE_Static_Svc_Descriptor &) const;
};
/**
* @class ACE_Threading_Helper
*
* @brief Encapsulates responsibility for allocating, destroying and
* manipulating the value, associated with a thread-specific
* key. Relates to the ability of the created thread to inherit the
* parent thread's gestalt. Designed to be used as an instance member
* of @c ACE_Service_Config.
*
* Partial specialization over ACE_SYNCH_MUTEX is used to implement
* specific behavior in both multi- and single-threaded builds.
*/
template <typename LOCK>
class ACE_Threading_Helper
{
};
/*
* Specialization for a multi threaded program
*/
template<>
class ACE_Export ACE_Threading_Helper<ACE_Thread_Mutex>
{
public:
ACE_Threading_Helper (void);
~ACE_Threading_Helper (void);
void set (void*);
void* get (void);
private:
/// Key for the thread-specific data, which is a simple pointer to
/// the thread's (currently-) global configuration context.
ACE_thread_key_t key_;
};
/*
* Specialization for a single threaded program
*/
template<>
class ACE_Export ACE_Threading_Helper<ACE_Null_Mutex>
{
public:
ACE_Threading_Helper (void);
~ACE_Threading_Helper (void);
void set (void*);
void* get (void);
};
#define ACE_Component_Config ACE_Service_Config
/**
* @class ACE_Service_Config
*
* @brief Supplies common server operations for dynamic and static
* configuration of service.
*
* The ACE_Service_Config uses the Monostate pattern. Therefore,
* you can only have one of these instantiated per-process. It
* represents the process-wide collection of services, which is
* typicaly shared among all other configurable entities. The only
* ACE_Service_Config instance is registered with and owned by the
* ACE_Object_Manager.
*
* By contrast, the ACE_Service_Gestalt represents the collection
* of services, pertaining to a configurable entity. Typicaly, a
* "configurable entity" is an instance, which owns an instance of
* ACE_Service_Gestalt in order to ensure full controll over the
* services it needs.
*
* Another facet of ACE_Service_Config is that for a given thread,
* it provides access to its current, process-global
* ACE_Service_Gestalt instance through its curent() method.
*
* @note The signal_handler_ static member is allocated by the
* ACE_Object_Manager. The ACE_Service_Config constructor
* uses signal_handler_. Therefore, if the program has any
* static ACE_Service_Config objects, there might be
* initialization order problems. They can be minimized, but
* not eliminated, by _not_ #defining
* ACE_HAS_NONSTATIC_OBJECT_MANAGER.
*/
class ACE_Export ACE_Service_Config
{
/// The Instance, or the global (default) configuration context.
/// The monostate would forward the calls to that instance. The TSS
/// will point here
ACE_Intrusive_Auto_Ptr<ACE_Service_Gestalt> instance_;
/// A helper instance to manage thread-specific key creation.
/// Dependent on the syncronization mutex ACE uses, the corresponding
/// partial template instantiation will perform the right services
/// that have to do with managing thread-specific storage. Note that,
/// for single-threaded builds they would do (next to) nothing.
ACE_Threading_Helper<ACE_SYNCH_MUTEX> threadkey_;
public:
// = Initialization and termination methods.
/**
* Initialize the Service Repository. Note that initialising @a
* signum to a negative number will prevent a signal handler being
* registered when the repository is opened.
*/
ACE_Service_Config (bool ignore_static_svcs = true,
size_t size = ACE_DEFAULT_SERVICE_REPOSITORY_SIZE,
int signum = SIGHUP);
/**
* Performs an open without parsing command-line arguments. The
* @a logger_key indicates where to write the logging output, which
* is typically either a STREAM pipe or a socket address.
*/
ACE_Service_Config (const ACE_TCHAR program_name[],
const ACE_TCHAR *logger_key = ACE_DEFAULT_LOGGER_KEY);
/// Perform user-specified close activities and remove dynamic
/// memory.
virtual ~ACE_Service_Config (void);
private:
/**
* Performs an open without parsing command-line arguments.
* Implements whats different in the opening sequence
* for this class, as opposed to the base class.
*
* The @a logger_key indicates where to write the logging output, which
* is typically either a STREAM pipe or a socket address. If
* @a ignore_default_svc_conf_file is non-0 then the "svc.conf" file
* will be ignored. If @a ignore_debug_flag is non-0 then the
* application is responsible for setting the
* @c ACE_Log_Msg::priority_mask() appropriately. Returns number of
* errors that occurred on failure and 0 otherwise.
*/
virtual int open_i (const ACE_TCHAR program_name[],
const ACE_TCHAR *logger_key,
bool ignore_static_svcs,
bool ignore_default_svc_conf_file,
bool ignore_debug_flag);
/**
* Implements whats different in the command line parameter processing
* for this class, as opposed to the base class.
*/
virtual int parse_args_i (int argc, ACE_TCHAR *argv[]);
/// = Static interfaces
public:
/**
* Returns the process-wide global singleton instance. It would
* have been created and will be managed by the Object Manager.
*/
static ACE_Service_Config* singleton (void);
/**
* Mutator for the currently active configuration context instance
* (gestalt). Intended for use by helper classes like @see
* ACE_Service_Config_Guard. Stack-based instances can be used to
* temporarily change which gestalt is seen as global by static
* initializers (especially those in DLLs loaded at run-time).
*/
static void current (ACE_Service_Gestalt*);
/**
* Accessor for the "current" service gestalt
*/
static ACE_Service_Gestalt* current (void);
/**
* This is what the static service initializators are hard-wired to
* use, so in order to avoid interface changes this method merely
* forwards to @c ACE_Service_Config::current. This enables us to
* enforce which Service Gestalt is used for services registering
* through static initializers. Especially important for DLL-based
* dynamic services, which can contain their own static services and
* static initializers.
*
* @deprecated Use current() instead.
*/
static ACE_Service_Gestalt* instance (void);
/**
* Returns a process-wide global singleton instance in contrast with
* current (), which may return a different instance at different
* times, dependent on the context. Modifying this method's return
* value is strongly discouraged as it will circumvent the mechanism
* for dynamically loading services. If you must, use with extreme
* caution!
*/
static ACE_Service_Gestalt* global (void);
/**
* Performs an open without parsing command-line arguments. The
* @a logger_key indicates where to write the logging output, which
* is typically either a STREAM pipe or a socket address. If
* @a ignore_static_svcs is true then static services are not loaded,
* otherwise, they are loaded. If @a ignore_default_svc_conf_file is
* non-0 then the <svc.conf> configuration file will be ignored.
* Returns zero upon success, -1 if the file is not found or cannot
* be opened (errno is set accordingly), otherwise returns the
* number of errors encountered loading the services in the
* specified svc.conf configuration file. If @a ignore_debug_flag is
* non-0 then the application is responsible for setting the
* @c ACE_Log_Msg::priority_mask appropriately.
*/
static int open (const ACE_TCHAR program_name[],
const ACE_TCHAR *logger_key = ACE_DEFAULT_LOGGER_KEY,
bool ignore_static_svcs = true,
bool ignore_default_svc_conf_file = false,
bool ignore_debug_flag = false);
/**
* This is the primary entry point into the ACE_Service_Config (the
* constructor just handles simple initializations). It parses
* arguments passed in from @a argc and @a argv parameters. The
* arguments that are valid in a call to this method include:
*
* - '-b' Option to indicate that we should be a daemon. Note that when
* this option is used, the process will be daemonized before the
* service configuration file(s) are read. During daemonization,
* (on POSIX systems) the current directory will be changed to "/"
* so the caller should either fully specify the file names, or
* execute a @c chroot() to the appropriate directory.
* @sa ACE::daemonize().
* - '-d' Turn on debugging mode
* - '-f' Specifies a configuration file name other than the default
* svc.conf. Can be specified multiple times to use multiple files.
* If any configuration file is provided with this option then
* the default svc.conf will be ignored.
* - '-k' Specifies the rendezvous point to use for the ACE distributed
* logger.
* - '-y' Explicitly enables the use of static services. This flag
* overrides the @a ignore_static_svcs parameter value.
* - '-n' Explicitly disables the use of static services. This flag
* overrides the @a ignore_static_svcs parameter value.
* - '-p' Specifies a pathname which is used to store the process id.
* - '-s' Specifies a signal number other than SIGHUP to trigger reprocessing
* of the configuration file(s). Ignored for platforms that do not
* have POSIX signals, such as Windows.
* - '-S' Specifies a service directive string. Enclose the string in quotes
* and escape any embedded quotes with a backslash. This option
* specifies service directives without the need for a configuration
* file. Can be specified multiple times.
*
* Note: Options '-f' and '-S' complement each other. Directives from files
* and from '-S' option are processed together in the following order. First,
* all files are processed in the order they are specified in @a argv
* parameter. Second, all directive strings are executed in the order the
* directives appear in @a argv parameter.
*
* @param argc The number of commandline arguments.
* @param argv The array with commandline arguments
* @param logger_key Indicates where to write the logging output,
* which is typically either a STREAM pipe or a
* socket address.
* @param ignore_static_svcs If true then static services are not loaded,
* otherwise, they are loaded.
* @param ignore_default_svc_conf_file If non-0 then the @c svc.conf
* configuration file will be ignored.
* @param ignore_debug_flag If true then the application is responsible
* for setting the @c ACE_Log_Msg::priority_mask
* appropriately.
*
* @retval -1 The configuration file is not found or cannot
* be opened (errno is set accordingly).
* @retval 0 Success.
* @retval >0 The number of errors encountered while processing
* the service configuration file(s).
*/
static int open (int argc,
ACE_TCHAR *argv[],
const ACE_TCHAR *logger_key = ACE_DEFAULT_LOGGER_KEY,
bool ignore_static_svcs = true,
bool ignore_default_svc_conf_file = false,
bool ignore_debug_flag = false);
/// Tidy up and perform last rites when ACE_Service_Config is shut
/// down. This method calls close_svcs(). Returns 0.
static int close (void);
/// Perform user-specified close hooks and possibly delete all of the
/// configured services in the <Service_Repository>.
static int fini_svcs (void);
/// True if reconfiguration occurred.
static int reconfig_occurred (void);
/// Indicate that reconfiguration occurred.
static void reconfig_occurred (int);
/// Perform the reconfiguration process.
static void reconfigure (void);
// = The following methods are static in order to enforce Singleton
// semantics for the Reactor, Service_Repository, Thread_Manager,
// and Acceptor/Connector Strategy factory. Other portions of the
// system may need to access them at some point or another...
// = This is not strictly needed, anymore since the service configurator
// has been refactored to allow multiple service configuration
// instances (called gestalts). The interfaces, however were retained in for
// the sake of maintaining source-code compatibility.
// = Accessors and mutators for process-wide Singletons.
/// Returns a pointer to the list of statically linked services.
///
/// @deprecated - Same as instance(), but still useful in legacy code,
/// (notably, one that can not be easily modified) which uses the following
/// idiom for registering static services:
///
/// ACE_Service_Config::static_svcs ()->insert (...);
static ACE_Service_Gestalt* static_svcs (void);
/// Insert a static service descriptor for processing on open_i(). The
/// corresponding ACE_STATIC_SVC_* macros were chaged to use this method
/// instead of obtaining a ptr to a container. See the note on static_svcs().
/// Added to prevent exposing the internal storage representation of the
/// services repository and provide a better way of debugging service
/// loading and registration problems.
static int insert (ACE_Static_Svc_Descriptor *svc);
// = Utility methods.
/// Dynamically link the shared object file and retrieve a pointer to
/// the designated shared object in this file.
static int initialize (const ACE_Service_Type *,
const ACE_TCHAR *parameters);
/// Initialize and activate a statically @a svc_name service.
static int initialize (const ACE_TCHAR *svc_name,
const ACE_TCHAR *parameters);
/// Resume a @a svc_name that was previously suspended or has not yet
/// been resumed (e.g., a static service).
static int resume (const ACE_TCHAR svc_name[]);
/**
* Suspend @a svc_name. Note that this will not unlink the service
* from the daemon if it was dynamically linked, it will mark it as
* being suspended in the Service Repository and call the <suspend>
* member function on the appropriate ACE_Service_Object. A
* service can be resumed later on by calling the <RESUME> member
* function...
*/
static int suspend (const ACE_TCHAR svc_name[]);
/// Totally remove @a svc_name from the daemon by removing it
/// from the ACE_Reactor, and unlinking it if necessary.
static int remove (const ACE_TCHAR svc_name[]);
#if defined (ACE_HAS_WINCE) && defined (ACE_USES_WCHAR)
// We must provide these function to bridge the Svc_Conf parser
// with ACE.
static int initialize (const ACE_Service_Type *, ACE_ANTI_TCHAR []);
static int initialize (const char svc_name[], ACE_ANTI_TCHAR parameters[]);
static int resume (const ACE_ANTI_TCHAR svc_name[]);
static int suspend (const ACE_ANTI_TCHAR svc_name[]);
static int remove (const ACE_ANTI_TCHAR svc_name[]);
#endif /* ACE_HAS_WINCE */
/// Dump the state of an object.
void dump (void) const;
/// Set the signal_handler;for internal use by ACE_Object_Manager only.
static ACE_INLINE void signal_handler (ACE_Sig_Adapter *);
/// Declare the dynamic allocation hooks.
ACE_ALLOC_HOOK_DECLARE;
/// Process a file containing a list of service configuration
/// directives.
static int process_file (const ACE_TCHAR file[]);
/// Process one service configuration @a directive, which is passed as
/// a string. Returns the number of errors that occurred.
static int process_directive (const ACE_TCHAR directive[]);
/**
* Process one static service definition. Load a new static service
* into the ACE_Service_Repository.
*
* @param ssd Service descriptor, see the document of
* ACE_Static_Svc_Descriptor for more details.
*
* @param force_replace If set the new service descriptor replaces
* any previous instance in the ACE_Service_Repository.
*
* @return Returns -1 if the service cannot be 'loaded'.
*/
static int process_directive (const ACE_Static_Svc_Descriptor &ssd,
bool force_replace = false);
/**
* Process (or re-process) service configuration requests that are
* provided in the svc.conf file(s). Returns the number of errors
* that occurred.
*/
static int process_directives (void);
/// Handles signals to trigger reconfigurations.
static void handle_signal (int sig, siginfo_t *, ucontext_t *);
/**
* Handle the command-line options intended for the
* ACE_Service_Config. Note that @c argv[0] is assumed to be the
* program name.
* The arguments that are valid in a call to this method are
* - '-b' Option to indicate that we should be a daemon
* - '-d' Turn on debugging mode
* - '-f' Option to read in the list of svc.conf file names
* - '-k' Option to read a wide string where in the logger output can
* be written
* - '-y' Turn on the flag for a repository of statically
* linked services
* - '-n' Need not have a repository of statically linked services
* - '-S' Option to read in the list of services on the command-line
* Please observe the difference between options '-f' that looks
* for a list of files and here a list of services.
*/
static int parse_args (int, ACE_TCHAR *argv[]);
#if (ACE_USES_CLASSIC_SVC_CONF == 0)
static ACE_Service_Type *create_service_type (const ACE_TCHAR *n,
ACE_Service_Type_Impl *o,
ACE_DLL &dll,
int active);
#endif /* ACE_USES_CLASSIC_SVC_CONF == 0 */
static ACE_Service_Type_Impl *
create_service_type_impl (const ACE_TCHAR *name,
int type,
void *symbol,
u_int flags,
ACE_Service_Object_Exterminator gobbler);
/// @deprecated
/// Process service configuration requests that were provided on the
/// command-line. Returns the number of errors that occurred.
static int process_commandline_directives (void);
/// Become a daemon.
static int start_daemon (void);
// @deprecated
// Add the default statically-linked services to the
// ACE_Service_Repository.
static int load_static_svcs (void);
protected:
#if (ACE_USES_CLASSIC_SVC_CONF == 1)
/// @deprecated
/// This is the implementation function that process_directives()
/// and process_directive() both call. Returns the number of errors
/// that occurred.
static int process_directives_i (ACE_Svc_Conf_Param *param);
#endif /* ACE_USES_CLASSIC_SVC_CONF == 1 */
// = Process-wide state.
private:
/// Have we called ACE_Service_Config::open() yet?
bool is_opened_;
#if defined (ACE_MT_SAFE) && (ACE_MT_SAFE != 0)
/// Synchronization variable for open, etc.
mutable ACE_SYNCH_MUTEX lock_;
#endif /* ACE_MT_SAFE */
/// True if reconfiguration occurred.
static sig_atomic_t reconfig_occurred_;
// = Set by command-line options.
/// Shall we become a daemon process?
static bool be_a_daemon_;
/// Pathname of file to write process id.
static ACE_TCHAR *pid_file_name_;
/// Number of the signal used to trigger reconfiguration.
static int signum_;
/// Handles the reconfiguration signals.
static ACE_Sig_Adapter *signal_handler_;
/// Pointer to the Singleton (ACE_Cleanup) Gestalt instance.
/// There is thread-specific global instance pointer, which is used to
/// temporarily change which Gestalt instance is used for static service
/// registrations.
///
/// A specific use case is a thread, which loads a _dynamic_ service from
/// a DLL. If the said DLL also contains additional _static_ services,
/// those *must* be registered with the same configuration repository as
/// the dynamic service. Otherwise, the DLL's static services would be
/// registered with the global Gestalt and may outlive the DLL that
/// contains their code and perhaps the memory in which they are in.
/// This is a problem because if the DLL gets unloaded (as it will, if
/// it was loaded in an instance of Gestalt), the DLL's memory will be
/// deallocated, but the global service repository will still "think"
/// it must finalize the (DLL's) static services - with disastrous
/// consequences, occurring in the post-main code (at_exit()).
/// This class needs the intimate access to be able to swap the
/// current TSS pointer for the global Gestalt.
friend class ACE_Service_Config_Guard;
/// The helper needs intimate access (when building with no threads)
friend class ACE_Threading_Helper <ACE_Thread_Mutex>;
friend class ACE_Threading_Helper <ACE_Null_Mutex>;
};
/**
* @class ACE_Service_Config_Guard
*
* @brief A guard class, designed to be instantiated on the stack.
*
* Instantiating it with a specific configuration ensures any references to
* ACE_Service_Config::instance(), even when occuring in static constructors,
* will allways access the designated configuration instance.
* This comes very handy when a dynamic service also registers any static
* services of its own and their static factories.
*/
class ACE_Export ACE_Service_Config_Guard
{
public:
ACE_Service_Config_Guard (ACE_Service_Gestalt* psg);
~ACE_Service_Config_Guard (void);
private:
// Private AND not implemented to disable copying
ACE_Service_Config_Guard(const ACE_Service_Config_Guard&);
ACE_Service_Config_Guard& operator= (const ACE_Service_Config_Guard&);
private:
ACE_Intrusive_Auto_Ptr<ACE_Service_Gestalt> saved_;
};
ACE_END_VERSIONED_NAMESPACE_DECL
#if defined (__ACE_INLINE__)
#include "ace/Service_Config.inl"
#endif /* __ACE_INLINE__ */
#include /**/ "ace/post.h"
#endif /* ACE_SERVICE_CONFIG_H */
|