summaryrefslogtreecommitdiff
path: root/TAO/CIAO/tools/XML_Helpers/RTConfiguration.idl
blob: c2462580797aba8ed36df818fdc5d5d17757d535 (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
// $Id$

/**
 * @file RTConfiguration.idl
 *
 * @brief Define the data structure for configuraing RTComponentServer.
 *
 * Define the data structure for configuraing RTComponentServer.
 */

#include "RTCORBA/RTCORBA.pidl"

module CIAO
{
  module RTConfiguration
  {
    struct ThreadPool_Configuration
    {
      string name;
      unsigned long stacksize;
      unsigned long static_threads;
      unsigned long dynamic_threads;
      RTCORBA::Priority default_priority;
      boolean allow_request_buffering;
      unsigned long max_buffered_requests;
      unsigned long max_request_buffer_size;
    };

    struct ThreadPoolLanes_Configuration
    {
      string name;
      unsigned long stacksize;
      RTCORBA::ThreadpoolLanes lanes;
      boolean allow_borrowing;
      boolean allow_request_buffering;
      unsigned long max_buffered_requests;
      unsigned long max_request_buffer_size;
    };

    typedef sequence<ThreadPool_Configuration> ThreadPool_Configurations;
    typedef sequence<ThreadPoolLanes_Configuration> ThreadPoolLanes_Configurations;

    struct PriorityBands_Configuration
    {
      string name;

      RTCORBA::PriorityBands bands;
    };
    typedef sequence<PriorityBands_Configuration> PriorityBands_Configurations;

    /**
     * @brief RT-related resources global to a component server.
     *
     * These are Real-time related resources that are global within an
     * RT component server.  They can be shared by several containers.
     */
    struct RTORB_Resources_Info
    {
      ThreadPool_Configurations tp_configs;

      ThreadPoolLanes_Configurations tpl_configs;

      PriorityBands_Configurations pb_configs;
    };

    // ---------------------------------------------------------------
    // PolicySet

    struct Priority_Model_Config
    {
      RTCORBA::PriorityModel model;
      RTCORBA::Priority default_priority;
    };

    /**
     * @brief Containing the configuration information to create a RT
     * policy in this framework.
     *
     * @sa RTPolicy_Set_Manager
     *
     * Supported RTPolicy types are: (PolicyType, type of any)
     *  (RTCORBA::PRIORITY_MODEL_POLICY_TYPE,
     *   CIAO::RTConfiguration::Priority_Model_Config)
     *  (RTCORBA::THREAD_POOL_POLICY_TYPE, name string)
     *  (RTCORBA::PRIORITY_BANDED_CONNECTION_POLICY_TYPE, name string)
     *
     * (name referred in name string must have been defined previously
     * using appropriate *_Configuration types.)
     */
    struct Policy_Config
    {
      CORBA::PolicyType type;

      any configuration;
    };

    typedef sequence<Policy_Config> Policy_Configs;

    /**
     * @brief A Policy_Set contains a named collection of RTPolicies.
     *
     * An RTContainer associates with a policy set via its name.
     */
    struct Policy_Set
    {
      string name;

      Policy_Configs configs;
    };

    /**
     * An RTComponentServer can be associated with a Policy_Sets.
     * There should be no name clashes among Policy_Set's.
     */
    typedef sequence<Policy_Set> Policy_Sets;
  };
};