Update version according to OSCI-856
[packages/precise/mcollective.git] / doc / classes / MCollective / Registration.html
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html 
3      PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <head>
8   <title>Module: MCollective::Registration</title>
9   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10   <meta http-equiv="Content-Script-Type" content="text/javascript" />
11   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
12   <script type="text/javascript">
13   // <![CDATA[
14
15   function popupCode( url ) {
16     window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17   }
18
19   function toggleCode( id ) {
20     if ( document.getElementById )
21       elem = document.getElementById( id );
22     else if ( document.all )
23       elem = eval( "document.all." + id );
24     else
25       return false;
26
27     elemStyle = elem.style;
28     
29     if ( elemStyle.display != "block" ) {
30       elemStyle.display = "block"
31     } else {
32       elemStyle.display = "none"
33     }
34
35     return true;
36   }
37   
38   // Make codeblocks hidden by default
39   document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40   
41   // ]]>
42   </script>
43
44 </head>
45 <body>
46
47
48
49     <div id="classHeader">
50         <table class="header-table">
51         <tr class="top-aligned-row">
52           <td><strong>Module</strong></td>
53           <td class="class-name-in-header">MCollective::Registration</td>
54         </tr>
55         <tr class="top-aligned-row">
56             <td><strong>In:</strong></td>
57             <td>
58                 <a href="../../files/lib/mcollective/registration/base_rb.html">
59                 lib/mcollective/registration/base.rb
60                 </a>
61         <br />
62                 <a href="../../files/lib/mcollective/registration_rb.html">
63                 lib/mcollective/registration.rb
64                 </a>
65         <br />
66             </td>
67         </tr>
68
69         </table>
70     </div>
71   <!-- banner header -->
72
73   <div id="bodyContent">
74
75
76
77   <div id="contextContent">
78
79     <div id="description">
80       <p>
81 <a href="Registration.html">Registration</a> is implimented using a module
82 structure and installations can configure which module they want to use.
83 </p>
84 <p>
85 We provide a simple one that just sends back the list of current known
86 agents in MCollective::Registration::Agentlist, you can create your own:
87 </p>
88 <p>
89 Create a module in plugins/mcollective/registration/&lt;yourplugin&gt;.rb
90 </p>
91 <p>
92 You can inherit from <a
93 href="Registration/Base.html">MCollective::Registration::Base</a> in which
94 case you just need to supply a <em>body</em> method, whatever this method
95 returns will be send to the middleware connection for an agent called
96 <em>registration</em>
97 </p>
98
99     </div>
100
101
102    </div>
103
104
105   </div>
106
107
108     <!-- if includes -->
109
110     <div id="section">
111
112     <div id="class-list">
113       <h3 class="section-bar">Classes and Modules</h3>
114
115       Class <a href="Registration/Base.html" class="link">MCollective::Registration::Base</a><br />
116
117     </div>
118
119
120
121
122       
123
124
125     <!-- if method_list -->
126
127
128   </div>
129
130
131 <div id="validator-badges">
132   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
133 </div>
134
135 </body>
136 </html>