summaryrefslogtreecommitdiff
path: root/ace/Service_Types.h
blob: 459419091bfc76cb9525166822413c9721cc76a8 (plain)
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
/* -*- C++ -*- */
// $Id$

// ============================================================================
//
// = LIBRARY
//    ace
//
// = FILENAME
//    Service_Types.h
//
// = AUTHOR
//    Doug Schmidt
//
// ============================================================================

#ifndef ACE_SERVICE_TYPE_H
#define ACE_SERVICE_TYPE_H

#include "ace/Service_Object.h"

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

#include "ace/Synch.h"

class ACE_Export ACE_Service_Type_Impl
{
  // = TITLE
  //     The abstract base class of the hierarchy that defines the
  //     contents of the <ACE_Service_Repository>.  The subclasses of
  //     this class allow the configuration of <ACE_Service_Objects>,
  //     <ACE_Modules>, and <ACE_Streams>.
  //
  // = DESCRIPTION
  //     This class provides the root of the implementation hierarchy
  //     of the "Bridge" pattern.  It maintains a pointer to the
  //     appropriate type of service implementation, i.e.,
  //     <ACE_Service_Object>, <ACE_Module>, or <ACE_Stream>.
public:
  // = Initialization and termination methods.
  ACE_Service_Type_Impl (void *object,
                         const ASYS_TCHAR *s_name,
                         u_int flags = 0,
                         ACE_Service_Object_Exterminator gobbler = 0);
  virtual ~ACE_Service_Type_Impl (void);

  // = Pure virtual interface (must be defined by the subclass).
  virtual int suspend (void) const = 0;
  virtual int resume (void) const = 0;
  virtual int init (int argc, ASYS_TCHAR *argv[]) const = 0;
  virtual int fini (void) const;
  virtual int info (ASYS_TCHAR **str, size_t len) const = 0;

  void *object (void) const;
  // The pointer to the service.

  const ASYS_TCHAR *name (void) const;
  // Get the name of the service.

  void name (const ASYS_TCHAR *);
  // Set the name of the service.

  void dump (void) const;
  // Dump the state of an object.

  ACE_ALLOC_HOOK_DECLARE;
  // Declare the dynamic allocation hooks.

protected:
  const ASYS_TCHAR *name_;
  // Name of the service.

  void *obj_;
  // Pointer to object that implements the service.  This actually
  // points to an <ACE_Service_Object>, <ACE_Module>, or <ACE_Stream>.

  ACE_Service_Object_Exterminator gobbler_;
  // Destroy function to deallocate obj_.

  u_int flags_;
  // Flags that control serivce behavior (particularly deletion).
};

class ACE_Export ACE_Service_Object_Type : public ACE_Service_Type_Impl
{
  // = TITLE
  //     Define the methods for handling the configuration of
  //     <ACE_Service_Objects>.
public:
  // = Initialization method.
  ACE_Service_Object_Type (void *so,
                           const ASYS_TCHAR *name,
                           u_int flags = 0,
                           ACE_Service_Object_Exterminator gobbler = 0);

  ~ACE_Service_Object_Type (void);

  // = Implement the hooks for <ACE_Service_Objects>.
  virtual int suspend (void) const;
  virtual int resume (void) const;
  virtual int init (int argc, ASYS_TCHAR *argv[]) const;
  virtual int fini (void) const;
  virtual int info (ASYS_TCHAR **str, size_t len) const;
};

class ACE_Export ACE_Module_Type : public ACE_Service_Type_Impl
{
  // = TITLE
  //     Define the methods for handling the configuration of
  //     <ACE_Modules>.
public:
  // = Initialization method.
  ACE_Module_Type (void *m, // Really an <ACE_Module> *.
                   const ASYS_TCHAR *identifier,
                   u_int flags = 0);

  ~ACE_Module_Type (void);

  // = Implement the hooks for <ACE_Modules>.
  virtual int suspend (void) const;
  virtual int resume (void) const;
  virtual int init (int argc, ASYS_TCHAR *argv[]) const;
  virtual int fini (void) const;
  virtual int info (ASYS_TCHAR **str, size_t len) const;

  // Get/set the link pointer.
  ACE_Module_Type *link (void) const;
  void link (ACE_Module_Type *);

  void dump (void) const;
  // Dump the state of an object.

  ACE_ALLOC_HOOK_DECLARE;
  // Declare the dynamic allocation hooks.

private:
  ACE_Module_Type *link_;
  // Pointer to the next <ACE_Module_Type> in an <ACE_Stream_Type>.
};

class ACE_Export ACE_Stream_Type : public ACE_Service_Type_Impl
{
  // = TITLE
  //     Define the methods for handling the configuration of
  //     <ACE_Streams>.
public:
  // = Initialization method.
  ACE_Stream_Type (void *s, // Really an <ACE_Stream> *.
                   const ASYS_TCHAR *identifier,
                   u_int flags = 0);

  ~ACE_Stream_Type (void);

  // = Implement the hooks for <ACE_Streams>.
  virtual int suspend (void) const;
  virtual int resume (void) const;
  virtual int init (int argc, ASYS_TCHAR *argv[]) const;
  virtual int fini (void) const;
  virtual int info (ASYS_TCHAR **str, size_t len) const;

  int push (ACE_Module_Type *new_module);
  // Add a new <ACE_Module> to the top of the <ACE_Stream>.

  int remove (ACE_Module_Type *module);
  // Search for <module> and remove it from the <ACE_Stream>.

  ACE_Module_Type *find (const ASYS_TCHAR *mod_name) const;
  // Locate the <ACE_Module> with <mod_name>.

  void dump (void) const;
  // Dump the state of an object.

  ACE_ALLOC_HOOK_DECLARE;
  // Declare the dynamic allocation hooks.

private:
  ACE_Module_Type *head_;
  // Pointer to the head of the <ACE_Module> list.
};

#if defined (__ACE_INLINE__)
#include "ace/Service_Types.i"
#endif /* __ACE_INLINE__ */

#endif /* _SERVICE_TYPE_H */