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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Net::SSH::Prompt - net-ssh 4.0.0.rc2</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../";
</script>
<script src="../../js/jquery.js"></script>
<script src="../../js/darkfish.js"></script>
<link href="../../css/fonts.css" rel="stylesheet">
<link href="../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../table_of_contents.html#pages">Pages</a>
<a href="../../table_of_contents.html#classes">Classes</a>
<a href="../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link">Object
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-default">::default</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-start">#start</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Net::SSH::Prompt">
<h1 id="class-Net::SSH::Prompt" class="class">
class Net::SSH::Prompt
</h1>
<section class="description">
<p>Default prompt implementation, called for asking password from user. It
will never be instantiated directly, but will instead be created for you
automatically.</p>
<p>A custom prompt objects can implement caching, or different UI. The prompt
object should implemnted a start method, which should return something
implementing ask and success. <a href="../SSH.html">Net::SSH</a> uses it
like:</p>
<pre class="ruby"><span class="ruby-identifier">prompter</span> = <span class="ruby-identifier">options</span>[:<span class="ruby-identifier">password_prompt</span>].<span class="ruby-identifier">start</span>({<span class="ruby-identifier">type</span>:<span class="ruby-string">'password'</span>})
<span class="ruby-keyword">while</span> <span class="ruby-operator">!</span><span class="ruby-identifier">ok</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">max_retries</span> <span class="ruby-operator"><</span> <span class="ruby-value">3</span>
<span class="ruby-identifier">user</span> = <span class="ruby-identifier">prompter</span>.<span class="ruby-identifier">ask</span>(<span class="ruby-string">"user: "</span>, {}, <span class="ruby-keyword">true</span>)
<span class="ruby-identifier">password</span> = <span class="ruby-identifier">prompter</span>.<span class="ruby-identifier">ask</span>(<span class="ruby-string">"password: "</span>, {}, <span class="ruby-keyword">false</span>)
<span class="ruby-identifier">ok</span> = <span class="ruby-identifier">send</span>(<span class="ruby-identifier">user</span>, <span class="ruby-identifier">password</span>)
<span class="ruby-identifier">prompter</span>.<span class="ruby-identifier">sucess</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">ok</span>
<span class="ruby-keyword">end</span>
</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-default" class="method-detail ">
<div class="method-heading">
<span class="method-name">default</span><span
class="method-args">(options = {})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>factory</p>
<div class="method-source-code" id="default-source">
<pre><span class="ruby-comment"># File lib/net/ssh/prompt.rb, line 23</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">default</span>(<span class="ruby-identifier">options</span> = {})
<span class="ruby-ivar">@default</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(options = {})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/net/ssh/prompt.rb, line 27</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">options</span> = {}); <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-start" class="method-detail ">
<div class="method-heading">
<span class="method-name">start</span><span
class="method-args">(info)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>start password session. Multiple questions might be asked multiple times on
the returned object. Info hash tries to uniquely identify the password
session, so caching implementations can save passwords properly.</p>
<div class="method-source-code" id="start-source">
<pre><span class="ruby-comment"># File lib/net/ssh/prompt.rb, line 57</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">start</span>(<span class="ruby-identifier">info</span>)
<span class="ruby-constant">Prompter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">info</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="http://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>
|
