doc/classes/MCollective/Connector.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::Connector</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::Connector</td>
  54         </tr>
  55         <tr class="top-aligned-row">
  56             <td><strong>In:</strong></td>
  57             <td>
  58                 <a href="../../files/lib/mcollective/connector_rb.html">
  59                 lib/mcollective/connector.rb
  60                 </a>
  61         <br />
  62                 <a href="../../files/lib/mcollective/connector/base_rb.html">
  63                 lib/mcollective/connector/base.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="Connector.html">Connector</a> plugins handle the communications
  82 with the middleware, you can provide your own to speak to something other
  83 than Stomp, your plugins must inherit from <a
  84 href="Connector/Base.html">MCollective::Connector::Base</a> and should
  85 provide the following methods:
  86 </p>
  87 <p>
  88 connect - Creates a connection to the middleware, no arguments should get
  89 its parameters from the config receive - Receive data from the middleware,
  90 should act like a blocking call only returning if/when data
  91 </p>
  92 <pre>
  93                 was received.  It should get data from all subscribed channels/topics.  Individual messages
  94                 should be returned as MCollective::Request objects with the payload provided
  95 </pre>
  96 <p>
  97 publish - Takes a target and msg, should send the message to the supplied
  98 target topic or destination subscribe - Adds a subscription to a specific
  99 message source unsubscribe - Removes a subscription to a specific message
 100 source disconnect - Disconnects from the middleware
 101 </p>
 102 <p>
 103 These methods are all that&#8216;s needed for a new connector protocol and
 104 should hopefully be simple enough to not have tied us to Stomp.
 105 </p>
 106
 107     </div>
 108
 109
 110    </div>
 111
 112
 113   </div>
 114
 115
 116     <!-- if includes -->
 117
 118     <div id="section">
 119
 120     <div id="class-list">
 121       <h3 class="section-bar">Classes and Modules</h3>
 122
 123       Class <a href="Connector/Base.html" class="link">MCollective::Connector::Base</a><br />
 124
 125     </div>
 126
 127
 128
 129
 130
 131
 132
 133     <!-- if method_list -->
 134
 135
 136   </div>
 137
 138
 139 <div id="validator-badges">
 140   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 141 </div>
 142
 143 </body>
 144 </html>