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
|
// -*- C++ -*-
//=============================================================================
/**
* @file LB_ObjectGroupManager.h
*
* $Id$
*
* @author Ossama Othman <ossama@uci.edu>
*/
//=============================================================================
#ifndef TAO_LB_OBJECT_GROUPMANAGER_H
#define TAO_LB_OBJECT_GROUPMANAGER_H
#include "ace/pre.h"
#include "orbsvcs/PortableGroupC.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
#pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#include "LB_Location_Map.h"
/// Forward declarations.
class TAO_LB_ObjectGroup_Map;
class TAO_LB_PropertyManager;
/**
* @class TAO_LB_ObjectGroupManager
*
* @brief PortableGroup::ObjectGroupManager implementation.
*
* The ObjectGroupManager provides the interface necessary to
* facilitate application-controlled object group membership.
*/
class TAO_LB_ObjectGroupManager
: public virtual PortableGroup::ObjectGroupManager
{
public:
/// Constructor.
TAO_LB_ObjectGroupManager (TAO_LB_Location_Map &location_map,
TAO_LB_ObjectGroup_Map &object_group_map,
TAO_LB_PropertyManager &property_manager);
/**
* @name PortableGroup::ObjectGroupManager methods
*/
//@{
/// Create a member using the load balancer ObjectGroupManager, and
/// add the created object to the ObjectGroup.
virtual PortableGroup::ObjectGroup_ptr create_member (
PortableGroup::ObjectGroup_ptr object_group,
const PortableGroup::Location & the_location,
const char * type_id,
const PortableGroup::Criteria & the_criteria,
CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ())
ACE_THROW_SPEC ((CORBA::SystemException,
PortableGroup::ObjectGroupNotFound,
PortableGroup::MemberAlreadyPresent,
PortableGroup::NoFactory,
PortableGroup::ObjectNotCreated,
PortableGroup::InvalidCriteria,
PortableGroup::CannotMeetCriteria));
/// Add an existing object to the ObjectGroup.
virtual PortableGroup::ObjectGroup_ptr add_member (
PortableGroup::ObjectGroup_ptr object_group,
const PortableGroup::Location & the_location,
CORBA::Object_ptr member,
CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ())
ACE_THROW_SPEC ((CORBA::SystemException,
PortableGroup::ObjectGroupNotFound,
PortableGroup::MemberAlreadyPresent,
PortableGroup::ObjectNotAdded));
/**
* Remove an object at a specific location from the given
* ObjectGroup. Deletion of application created objects must be
* deleted by the application. Objects created by the
* infrastructure (load balancer) will be deleted by the
* infrastructure.
*/
virtual PortableGroup::ObjectGroup_ptr remove_member (
PortableGroup::ObjectGroup_ptr object_group,
const PortableGroup::Location & the_location,
CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ())
ACE_THROW_SPEC ((CORBA::SystemException,
PortableGroup::ObjectGroupNotFound,
PortableGroup::MemberNotFound));
/// Return the locations of the members in the given ObjectGroup.
virtual PortableGroup::Locations * locations_of_members (
PortableGroup::ObjectGroup_ptr object_group,
CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ())
ACE_THROW_SPEC ((CORBA::SystemException,
PortableGroup::ObjectGroupNotFound));
/// Return the ObjectGroupId for the given ObjectGroup.
/// @note Does this method make sense for load balanced objects?
virtual PortableGroup::ObjectGroupId get_object_group_id (
PortableGroup::ObjectGroup_ptr object_group,
CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ())
ACE_THROW_SPEC ((CORBA::SystemException,
PortableGroup::ObjectGroupNotFound));
/// @note Does this method make sense for load balanced objects?
virtual PortableGroup::ObjectGroup_ptr get_object_group_ref (
PortableGroup::ObjectGroup_ptr object_group,
CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ())
ACE_THROW_SPEC ((CORBA::SystemException,
PortableGroup::ObjectGroupNotFound));
/// Return the reference corresponding to the Replica of a given
/// ObjectGroup at the given location.
virtual CORBA::Object_ptr get_member_ref (
PortableGroup::ObjectGroup_ptr object_group,
const PortableGroup::Location & loc,
CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ())
ACE_THROW_SPEC ((CORBA::SystemException,
PortableGroup::ObjectGroupNotFound,
PortableGroup::MemberNotFound));
//@}
/**
* @name Helper methods used internally by the load balancer's
* GenericFactory.
*/
//@{
/// Create a member using the load balancer ObjectGroupManager, and
/// add the created object to the ObjectGroup.
PortableGroup::ObjectGroup_ptr create_member_i (
PortableGroup::ObjectGroup_ptr object_group,
const PortableGroup::Location & the_location,
const char * type_id,
const PortableGroup::Criteria & the_criteria,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException,
PortableGroup::MemberAlreadyPresent,
PortableGroup::NoFactory,
PortableGroup::ObjectNotCreated,
PortableGroup::InvalidCriteria,
PortableGroup::CannotMeetCriteria));
//@}
private:
/// Map that contains list of all replicas at a given location, in
/// addition to the load monitor at that location.
TAO_LB_Location_Map &location_map_;
/// Pointer to the ObjectGroup map.
TAO_LB_ObjectGroup_Map &object_group_map_;
/// Reference to the PropertyManager.
TAO_LB_PropertyManager &property_manager_;
};
#endif /* TAO_LB_OBJECT_GROUP_MANAGER_H */
|
