1 <?xml version="1.0" encoding="iso-8859-1"?>
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
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">
15 function popupCode( url ) {
16 window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
19 function toggleCode( id ) {
20 if ( document.getElementById )
21 elem = document.getElementById( id );
22 else if ( document.all )
23 elem = eval( "document.all." + id );
27 elemStyle = elem.style;
29 if ( elemStyle.display != "block" ) {
30 elemStyle.display = "block"
32 elemStyle.display = "none"
38 // Make codeblocks hidden by default
39 document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
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>
55 <tr class="top-aligned-row">
56 <td><strong>In:</strong></td>
58 <a href="../../files/lib/mcollective/connector_rb.html">
59 lib/mcollective/connector.rb
62 <a href="../../files/lib/mcollective/connector/base_rb.html">
63 lib/mcollective/connector/base.rb
71 <!-- banner header -->
73 <div id="bodyContent">
77 <div id="contextContent">
79 <div id="description">
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:
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
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
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
103 These methods are all that‘s needed for a new connector protocol and
104 should hopefully be simple enough to not have tied us to Stomp.
120 <div id="class-list">
121 <h3 class="section-bar">Classes and Modules</h3>
123 Class <a href="Connector/Base.html" class="link">MCollective::Connector::Base</a><br />
133 <!-- if method_list -->
139 <div id="validator-badges">
140 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>