summaryrefslogtreecommitdiff
path: root/TAO/orbsvcs/orbsvcs/Naming/Hash_Naming_Context.h
blob: b37759e94cfd3f5edddcc5ddeb3d7a908878081e (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
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
/* -*- C++ -*- */
// $Id$
// ============================================================================
//
// = LIBRARY
//    cos
//
// = FILENAME
//   Hash_Naming_Context.h
//
// = AUTHOR
//    Marina Spivak <marina@cs.wustl.edu>
//
// ============================================================================

#ifndef TAO_HASH_NAMING_CONTEXT_H
#define TAO_HASH_NAMING_CONTEXT_H

#include "Naming_Context.h"

// This is to remove "inherits via dominance" warnings from MSVC.
#if defined (_MSC_VER)
# pragma warning (disable : 4250)
#endif /* _MSC_VER */

class TAO_ORBSVCS_Export TAO_Bindings_Map
{
  // = TITLE
  //    This abstract base class defines an interface for hash-based
  //    data structures used in implementations of NamingContext
  //    (i.e., TAO_Transient_Naming_Context and TAO_Persistent_Naming_Context)
  //
  // = DESCRIPTION
  //    Define an interface for several hash-based data structures, so
  //    that we can write some code that would work with any of them,
  //    i.e., TAO_Hash_Naming_Context.

public:

  virtual ~TAO_Bindings_Map (void);
  // Destructor.

  virtual size_t current_size (void) = 0;
  // Return current number of entries (name bindings) in the
  // underlying hash map.

  virtual int bind (const char *id,
                    const char *kind,
                    CORBA::Object_ptr obj,
                    CosNaming::BindingType type) = 0;
  // Add a binding with the specified parameters to the table.
  // Return 0 on success and -1 on failure, 1 if there already is a
  // binding with <id> and <kind>.

  virtual int rebind (const char *id,
                      const char *kind,
                      CORBA::Object_ptr obj,
                      CosNaming::BindingType type) = 0;
  // Overwrite a binding containing <id> and <kind> (or create a new
  // one if one doesn't exist) with the specified parameters.  Returns
  // -1 on failure.

  virtual int unbind (const char * id,
                      const char * kind) = 0;
  // Remove a binding containing <id> and <kind> from the table.
  // Return 0 on success and -1 on failure.

  virtual int find (const char * id,
                    const char * kind,
                    CORBA::Object_ptr & obj,
                    CosNaming::BindingType &type) = 0;
  // Find the binding containing <id> and <kind> in the table, and
  // pass binding's type and object back to the caller by reference.
  // Return 0 on success and -1 on failure.   Note: a 'duplicated' object
  // reference is assigned to <obj>, so the caller is responsible for
  // its deallocation.

};

class TAO_ORBSVCS_Export TAO_Hash_Naming_Context :public TAO_Naming_Context_Impl
{
  // = TITLE
  //     This class factors out common code for two 'ConcreteImplementors'
  //     in the Bridge pattern architecture of the CosNaming::NamingContext
  //     implementation.
  //
  // = DESCRIPTION
  //     This class contains 'algorithm' code that is common to two
  //     hash-table-based implementations of the NamingContext:
  //     TAO_Transient_Naming_Context and TAO_Persistent_Naming_Context.
  //     To help achieve this 'templatization', we use the abstract base
  //     class TAO_Bindings_Map, which provides a common interface to the data structures
  //     used in TAO_Persistent_Namng_Context and TAO_Transient_Naming_Context.
  //
public:
  // = Initialization and termination methods.
  TAO_Hash_Naming_Context (PortableServer::POA_ptr poa,
                           const char *poa_id);
  // Constructor.

  void interface (TAO_Naming_Context *i);
  // Set our <interface_> pointer.

  virtual ~TAO_Hash_Naming_Context (void);
  // Destructor.

  // = Accessors.

  TAO_Naming_Context *interface (void);
  // Get the pointer to our <interface>.

  int root (void);
  // Returns true if this Naming Context is a root Naming Context for
  // the server, and false otherwise.

  int destroyed (void);
  // Returns true if this context had <destroy> operation invoked on
  // it, and false otherwise.

  // = CosNaming::NamingContext idl interface methods.

  virtual void bind (const CosNaming::Name &n,
                     CORBA::Object_ptr obj,
                     CORBA::Environment &ACE_TRY_ENV);
  // Create a binding for name <n> and object <obj> in the naming
  // context.  Compound names are treated as follows: ctx->bind (<c1;
  // c2; c3; cn>, obj) = (ctx->resolve (<c1; c2; cn-1>))->bind (<cn>,
  // obj) if the there already exists a binding for the specified
  // name, <AlreadyBound> exception is thrown.  Naming contexts should
  // be bound using <bind_context> and <rebind_context> in order to
  // participate in name resolution later.

  virtual void rebind (const CosNaming::Name &n,
                       CORBA::Object_ptr obj,
                       CORBA::Environment &ACE_TRY_ENV);
  // This is similar to <bind> operation above, except for when the
  // binding for the specified name already exists in the specified
  // context.  In that case, the existing binding is replaced with the
  // new one.

  virtual void bind_context (const CosNaming::Name &n,
                             CosNaming::NamingContext_ptr nc,
                             CORBA::Environment &ACE_TRY_ENV);
  // This is the version of <bind> specifically for binding naming
  // contexts, so that they will participate in name resolution when
  // compound names are passed to be resolved.

   virtual void rebind_context (const CosNaming::Name &n,
                               CosNaming::NamingContext_ptr nc,
                               CORBA::Environment &ACE_TRY_ENV);
  // This is a version of <rebind> specifically for naming contexts,
  // so that they can participate in name resolution when compound
  // names are passed.

  virtual CORBA::Object_ptr resolve (const CosNaming::Name &n,
                                     CORBA::Environment &ACE_TRY_ENV);
  // Return object reference that is bound to the name.  Compound name
  // resolve is defined as follows: ctx->resolve (<c1; c2; cn>) =
  // ctx->resolve (<c1; c2 cn-1>)->resolve (<cn>) The naming service
  // does not return the type of the object.  Clients are responsible
  // for "narrowing" the object to the appropriate type.

  virtual void unbind (const CosNaming::Name &n,
                       CORBA::Environment &ACE_TRY_ENV);
  // Remove the name binding from the context.  When compound names
  // are used, unbind is defined as follows: ctx->unbind (<c1; c2;
  // cn>) = (ctx->resolve (<c1; c2; cn-1>))->unbind (<cn>)

  virtual CosNaming::NamingContext_ptr bind_new_context (const CosNaming::Name &n,
                                                         CORBA::Environment &ACE_TRY_ENV);
  // This operation creates a new context and binds it to the name
  // supplied as an argument.  The newly-created context is
  // implemented by the same server as the context in which it was
  // bound (the name argument excluding the last component).

  virtual void destroy (CORBA::Environment &ACE_TRY_ENV);
  // Delete the naming context.  The user should take care to <unbind> any
  // bindings in which the given context is bound to some names, to
  // avoid dangling references when invoking <destroy> operation.
  // NOTE: <destory> is a no-op on the root context.
  // NOTE: after <destroy> is invoked on a Naming Context, all
  // BindingIterators associated with that Naming Context are also destroyed.

  virtual PortableServer::POA_ptr _default_POA (void);
  // Returns the Default POA of this Servant object

protected:
  // = Helper method used by other methods.

  CosNaming::NamingContext_ptr get_context (const CosNaming::Name &name,
                                            CORBA::Environment &_env);
  // <get_context> is used by methods that need to resolve a compound
  // name before performing the actual operation (e.g., bind,
  // unbind, etc.)  <get_context> takes a full name (including the
  // last component that doesn't need to be resolved), and returns a
  // pointer to the target context.

  TAO_Bindings_Map *context_;
  // Pointer to the data structure used to store this Naming Context's
  // bindings.  <context_> is initialized with a concrete data
  // structure by subclasses, which know which data structure to use.

  TAO_Naming_Context *interface_;
  // Pointer to the <interface> object for which we serve as a
  // <concrete implementation>, i.e., the object that delegates to us
  // all client CosNaming::NamingContext CORBA calls.
  // We need this pointer for reference counting.

  ACE_SYNCH_RECURSIVE_MUTEX lock_;
  // Lock used to serialize access to the underlying data structure.

  int destroyed_;
  // Flag indicating whether this Naming Context is no longer valid.
  // This flag is necessary because immediate destruction
  // might not be possible if there are pending requests on this servant
  // in the POA.

  PortableServer::POA_var poa_;
  // POA we are registered with.

  ACE_CString poa_id_;
  // ID with which we are registered with <poa_>.
  // Note, if <poa_id_> is equivalent to TAO_ROOT_NAMING_CONTEXT, then this Naming Context
  // is the root Naming Context for the server, i.e., it is un<destroy>able.
};

#endif /* TAO_HASH_NAMING_CONTEXT_H */