summaryrefslogtreecommitdiff
path: root/TAO/orbsvcs/orbsvcs/LoadBalancing.idl
blob: 8cecbb03874f105966d124f09079c9c8fc03b64d (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
// -*- IDL -*-

//=============================================================================
/**
 *  @file    LoadBalancing.idl
 *
 *  $Id$
 *
 *  The "LoadBalancing" IDL module in this file is based heavily on
 *  the "FT" module defined in the OMG CORBA Fault Tolerance
 *  specification.
 *
 *  @author Ossama Othman <ossama@uci.edu>
 */
//=============================================================================


#ifndef TAO_LOADBALANCING_IDL
#define TAO_LOADBALANCING_IDL

#include "tao/PortableInterceptor.pidl"
#include "CosNaming.idl"
#include "orb.idl"

#pragma prefix "tao.lb"

/**
 * @class LoadBalancing
 *
 * @brief This module defines the interfaces and data types used in
 * TAO's Load Balancing service.
 * @par
 * TAO's Load Balancer manages distribution of requests to replicas of
 * a given Object in an effort to ensure that the  applications/hosts
 * pointed to by the Object reference are as equally loaded as
 * possible, i.e. load balanced.
 * @par
 * The definition of 'load' is application specific, for example, some
 * applications may choose to load balance access to multiple
 * dedicated lines, or separate network interfaces, as well as more
 * traditional load balancing metrics, such as CPU or power load.
 */
module LoadBalancing
{
  /// Types used for obtaining and/or reporting loads
  typedef unsigned long LoadId;
  struct Load {
    LoadId identifier;
    float value;
  };
  typedef sequence<Load> LoadList;

  /// Specification of Common Types and Exceptions for ReplicationManager
  interface GenericFactory;
  interface LoadNotifier;
  interface LoadMonitor;

  typedef unsigned short MonitoringStyle;
  const MonitoringStyle PULL = 0;
  const MonitoringStyle PUSH = 1;
  //  const MonitoringStyle NOT_MONITORED = 2;

  typedef unsigned short MonitoringGranularity;
  const MonitoringGranularity MEMB = 0;
  const MonitoringGranularity LOC = 1;
  const MonitoringGranularity LOC_AND_TYPE = 2;

  typedef unsigned short ClientBinding;
  const ClientBinding PER_SESSION = 0;
  const ClientBinding PER_REQUEST = 1;
  const ClientBinding ON_DEMAND = 2;

  typedef unsigned short BalancingPolicy;
  const BalancingPolicy NON_ADAPTIVE = 0;
  const BalancingPolicy ADAPTIVE = 1;

  exception MonitorAlreadyPresent {};
  exception LocationNotFound {};

  /// Specification of ReplicationManager Interface
  interface ReplicationManager :
    PortableGroup::PropertyManager,
    PortableGroup::ObjectGroupManager,
    PortableGroup::GenericFactory {

    void register_load_notifier (in LoadNotifier load_notifier);

    LoadNotifier get_load_notifier ()
      raises (InterfaceNotFound);

    void register_load_monitor (in LoadMonitor load_monitor,
                                in Location the_location)
      raises (MonitorAlreadyPresent);

    LoadMonitor get_load_monitor (in Location the_location)
      raises (LocationNotFound);

    void remove_load_monitor (in Location the_location)
      raises (LocationNotFound);
  };

  /// It's not clear this interface is needed for the Load Balancer.
  interface LoadNotifier
  {
  };

  /// Interface that all load monitors must implement.
  interface LoadMonitor
  {
    /// Return the current load at the location the load monitor
    /// resides.
    readonly attribute LoadList current_load;

    /// Force redirection of requests for targets with the given
    /// RepositoryId to the target pointed to by the given object
    /// reference.
    void register_redirect (in string type_id,
                            in Object redirect_to);

    /// Remove the redirect for targets of the given RepositoryId.
    void remove_redirect (in string type_id);
  };

};

#pragma prefix ""

#endif /* TAO_LOADBALANCING_IDL */