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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>Net::SSH::Multi::ServerList</title>
<meta content='text/html; charset=US-ASCII' http-equiv='Content-Type'>
<link href='../../../../css/style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
//<![CDATA[
function popupCode(url) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode(id) {
var code = document.getElementById(id)
code.style.display = code.style.display != 'block' ? 'block' : 'none'
return true
}
// Make codeblocks hidden by default
document.writeln('<' + 'style type="text/css">.method .source pre { display: none }<\/style>')
//]]>
</script>
</head>
<body class='page'>
<div class='class' id='wrapper'>
<div class='header'>
<h1 class='name'>
<span class='type'>class</span>
Net::SSH::Multi::ServerList
</h1>
<ol class='paths'>
<li>
<a target="docwin" href="../../../../files/lib/net/ssh/multi/server_list_rb.html">lib/net/ssh/multi/server_list.rb</a>
</li>
</ol>
<div class='parent'>
Parent:
<strong><a target="docwin" href="../Multi.html">Multi</a></strong>
</div>
</div>
<div id='content'>
<div id='text'>
<div id='description'>
<p>Encapsulates a list of server objects, both dynamic (<a
href="DynamicServer.html">Net::SSH::Multi::DynamicServer</a>) and static
(<a href="Server.html">Net::SSH::Multi::Server</a>). It attempts to make it
transparent whether a dynamic server set has been evaluated or not. Note
that a <a href="ServerList.html">ServerList</a> is NOT an Array, though it
is Enumerable.</p>
</div>
<div id='method-list'>
<h2>Methods</h2>
<h3>Public Class</h3>
<ol>
<li><a target="docwin" href="#method-c-new">new</a></li>
</ol>
<h3>Public Instance</h3>
<ol>
<li><a target="docwin" href="#method-i-add">add</a></li>
<li><a target="docwin" href="#method-i-concat">concat</a></li>
<li><a target="docwin" href="#method-i-each">each</a></li>
<li><a target="docwin" href="#method-i-flatten">flatten</a></li>
<li><a target="docwin" href="#method-i-select">select</a></li>
</ol>
</div>
<div id='context'>
<div id='includes'>
<h2>Included modules</h2>
<ol>
<li>Enumerable</li>
</ol>
</div>
</div>
<div id='section'>
<div id='aliases-list'>
<h2>Public Instance Aliases</h2>
<div class='name-list'>
<table summary='Public Instance Aliases'>
<tr class='top-aligned-row context-row'>
<td class='context-item-name'>to_ary</td>
<td>-></td>
<td class='context-item-value'><a target="docwin" href="#method-i-flatten">flatten</a></td>
</tr>
</table>
</div>
</div>
<div id='methods'>
<h2>Public Class methods</h2>
<div class='method public-class' id='method-method-c-new'>
<a name='method-c-new'></a>
<div class='synopsis'>
<span class='name'>new</span>
<span class='arguments'>(list=[])</span>
</div>
<div class='description'>
<p>Create a new <a href="ServerList.html">ServerList</a> that wraps the given
server list. Duplicate entries will be discarded.</p>
</div>
<div class='source'>
<a class='source-toggle' href='#' onclick="toggleCode('method-c-new-source'); return false">
[show source]
</a>
<pre id='method-c-new-source'><span class="ruby-comment"># File lib/net/ssh/multi/server_list.rb, line 15</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">list</span>=[])
 <span class="ruby-ivar">@list</span> = <span class="ruby-identifier">list</span>.<span class="ruby-identifier">uniq</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<h2>Public Instance methods</h2>
<div class='method public-instance' id='method-method-i-add'>
<a name='method-i-add'></a>
<div class='synopsis'>
<span class='name'>add</span>
<span class='arguments'>(server)</span>
</div>
<div class='description'>
<p>Adds the given server to the list, and returns the argument. If an
identical server definition already exists in the collection, the argument
is <em>not</em> added, and the existing server record is returned instead.</p>
</div>
<div class='source'>
<a class='source-toggle' href='#' onclick="toggleCode('method-i-add-source'); return false">
[show source]
</a>
<pre id='method-i-add-source'><span class="ruby-comment"># File lib/net/ssh/multi/server_list.rb, line 23</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">add</span>(<span class="ruby-identifier">server</span>)
 <span class="ruby-identifier">index</span> = <span class="ruby-ivar">@list</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">server</span>)
 <span class="ruby-keyword">if</span> <span class="ruby-identifier">index</span>
 <span class="ruby-identifier">server</span> = <span class="ruby-ivar">@list</span>[<span class="ruby-identifier">index</span>]
 <span class="ruby-keyword">else</span>
 <span class="ruby-ivar">@list</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">server</span>)
 <span class="ruby-keyword">end</span>
 <span class="ruby-identifier">server</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class='method public-instance' id='method-method-i-concat'>
<a name='method-i-concat'></a>
<div class='synopsis'>
<span class='name'>concat</span>
<span class='arguments'>(servers)</span>
</div>
<div class='description'>
<p>Adds an array (or otherwise Enumerable list) of servers to this list, by
calling <a href="ServerList.html#method-i-add">add</a> for each argument.
Returns <tt>self</tt>.</p>
</div>
<div class='source'>
<a class='source-toggle' href='#' onclick="toggleCode('method-i-concat-source'); return false">
[show source]
</a>
<pre id='method-i-concat-source'><span class="ruby-comment"># File lib/net/ssh/multi/server_list.rb, line 35</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">concat</span>(<span class="ruby-identifier">servers</span>)
 <span class="ruby-identifier">servers</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">server</span><span class="ruby-operator">|</span> <span class="ruby-identifier">add</span>(<span class="ruby-identifier">server</span>) }
 <span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class='method public-instance' id='method-method-i-each'>
<a name='method-i-each'></a>
<div class='synopsis'>
<span class='name'>each</span>
<span class='arguments'>()</span>
</div>
<div class='description'>
<p>Iterates over each distinct server record in the collection. This will
correctly iterate over server records instantiated by a <a
href="DynamicServer.html">DynamicServer</a> as well, but only if the
dynamic server has been "evaluated" (see <a
href="DynamicServer.html#method-i-evaluate-21">Net::SSH::Multi::DynamicServer#evaluate!</a>).</p>
</div>
<div class='source'>
<a class='source-toggle' href='#' onclick="toggleCode('method-i-each-source'); return false">
[show source]
</a>
<pre id='method-i-each-source'><span class="ruby-comment"># File lib/net/ssh/multi/server_list.rb, line 44</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">each</span>
 <span class="ruby-ivar">@list</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">server</span><span class="ruby-operator">|</span>
 <span class="ruby-keyword">case</span> <span class="ruby-identifier">server</span>
 <span class="ruby-keyword">when</span> <span class="ruby-constant">Server</span> <span class="ruby-keyword">then</span> <span class="ruby-keyword">yield</span> <span class="ruby-identifier">server</span>
 <span class="ruby-keyword">when</span> <span class="ruby-constant">DynamicServer</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">server</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">item</span><span class="ruby-operator">|</span> <span class="ruby-keyword">yield</span> <span class="ruby-identifier">item</span> }
 <span class="ruby-keyword">else</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"server list contains non-server: #{server.class}"</span>
 <span class="ruby-keyword">end</span>
 <span class="ruby-keyword">end</span>
 <span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class='method public-instance' id='method-method-i-flatten'>
<a name='method-i-flatten'></a>
<div class='synopsis'>
<span class='name'>flatten</span>
<span class='arguments'>()</span>
</div>
<div class='description'>
<p>Returns an array of all servers in the list, with dynamic server records
expanded. The result is an array of distinct server records (duplicates are
removed from the result).</p>
</div>
<div class='source'>
<a class='source-toggle' href='#' onclick="toggleCode('method-i-flatten-source'); return false">
[show source]
</a>
<pre id='method-i-flatten-source'><span class="ruby-comment"># File lib/net/ssh/multi/server_list.rb, line 65</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">flatten</span>
 <span class="ruby-identifier">result</span> = <span class="ruby-ivar">@list</span>.<span class="ruby-identifier">inject</span>([]) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">aggregator</span>, <span class="ruby-identifier">server</span><span class="ruby-operator">|</span>
 <span class="ruby-keyword">case</span> <span class="ruby-identifier">server</span>
 <span class="ruby-keyword">when</span> <span class="ruby-constant">Server</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">aggregator</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">server</span>)
 <span class="ruby-keyword">when</span> <span class="ruby-constant">DynamicServer</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">aggregator</span>.<span class="ruby-identifier">concat</span>(<span class="ruby-identifier">server</span>)
 <span class="ruby-keyword">else</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"server list contains non-server: #{server.class}"</span>
 <span class="ruby-keyword">end</span>
 <span class="ruby-keyword">end</span>

 <span class="ruby-identifier">result</span>.<span class="ruby-identifier">uniq</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class='method public-instance' id='method-method-i-select'>
<a name='method-i-select'></a>
<div class='synopsis'>
<span class='name'>select</span>
<span class='arguments'>()</span>
</div>
<div class='description'>
<p>Works exactly as Enumerable#select, but returns the result as a new <a
href="ServerList.html">ServerList</a> instance.</p>
</div>
<div class='source'>
<a class='source-toggle' href='#' onclick="toggleCode('method-i-select-source'); return false">
[show source]
</a>
<pre id='method-i-select-source'><span class="ruby-comment"># File lib/net/ssh/multi/server_list.rb, line 57</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">select</span>
 <span class="ruby-identifier">subset</span> = <span class="ruby-ivar">@list</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-keyword">yield</span> <span class="ruby-identifier">i</span> }
 <span class="ruby-constant">ServerList</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">subset</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</div>
</div>
</div>
<div id='footer-push'></div>
</div>
<div id='footer'>
<a target="docwin" href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
</div>
</body>
</html>
|
