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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<refentry id="function.expect-expectl">
<refnamediv>
<refname>expect_expectl</refname>
<refpurpose>Waits until the output from a process matches one
of the patterns, a specified time period has passed, or an EOF is seen
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>expect_expectl</methodname>
<methodparam><type>resource</type><parameter>expect</parameter></methodparam>
<methodparam><type>array</type><parameter>cases</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">match</parameter></methodparam>
</methodsynopsis>
<para>
Waits until the output from a process matches one of the patterns,
a specified time period has passed, or an EOF is seen.
</para>
<para>
If <parameter>match</parameter> is provided, then it is filled with the result of search.
The matched string can be found in <parameter>match[0]</parameter>.
The match substrings (according to the parentheses) in the original pattern can be found
in <parameter>match[1]</parameter>, <parameter>match[2]</parameter>, and so
on, up to <parameter>match[9]</parameter> (the limitation of libexpect).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>expect</parameter></term>
<listitem>
<para>
An Expect stream, previously opened with
<function>expect_popen</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>cases</parameter></term>
<listitem>
<para>
An array of expect cases. Each expect case is an indexed array,
as described in the following table:
<table>
<title>Expect Case Array</title>
<tgroup cols="5">
<thead>
<row>
<entry>Index Key</entry>
<entry>Value Type</entry>
<entry>Description</entry>
<entry>Is Mandatory</entry>
<entry>Default Value</entry>
</row>
</thead>
<tbody>
<row>
<entry>0</entry>
<entry>string</entry>
<entry>pattern, that will be matched against the output from the stream</entry>
<entry>yes</entry>
<entry></entry>
</row>
<row>
<entry>1</entry>
<entry>mixed</entry>
<entry>value, that will be returned by this function, if the pattern matches</entry>
<entry>yes</entry>
<entry></entry>
</row>
<row>
<entry>2</entry>
<entry>integer</entry>
<entry>
pattern type, one of:
<link linkend="constants.expect.exp_glob"><constant>EXP_GLOB</constant></link>,
<link linkend="constants.expect.exp_exact"><constant>EXP_EXACT</constant></link>
or
<link linkend="constants.expect.exp_regexp"><constant>EXP_REGEXP</constant></link>
</entry>
<entry>no</entry>
<entry><link linkend="constants.expect.exp_glob"><constant>EXP_GLOB</constant></link></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns value associated with the pattern that was matched.
</para>
<para>
On failure this function returns:
<link linkend="constants.expect.exp_eof"><constant>EXP_EOF</constant></link>,
<link linkend="constants.expect.exp_timeout"><constant>EXP_TIMEOUT</constant></link>
or
<link linkend="constants.expect.exp_fullbuffer"><constant>EXP_FULLBUFFER</constant></link>
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>0.2.1</entry>
<entry>
Prior to version 0.2.1, in <parameter>match</parameter> parameter a match string was returned,
not an array of match substrings.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>expect_expectl</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Copies file from remote host:
ini_set ("expect.timeout", 30);
$stream = fopen ("expect://scp user@remotehost:/var/log/messages /home/user/messages.txt", "r");
$cases = array (
array (0 => "password:", 1 => PASSWORD),
array (0 => "yes/no)?", 1 => YESNO)
);
while (true) {
switch (expect_expectl ($stream, $cases))
{
case PASSWORD:
fwrite ($stream, "password\n");
break;
case YESNO:
fwrite ($stream, "yes\n");
break;
case EXP_TIMEOUT:
case EXP_EOF:
break 2;
default:
die ("Error has occurred!\n");
}
}
fclose ($stream);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>expect_popen</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
