-
Notifications
You must be signed in to change notification settings - Fork 70
/
expect-expectl.xml
207 lines (203 loc) · 7.03 KB
/
expect-expectl.xml
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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 73fae4ee51b644b72028e610abefefced57c18ad Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.expect-expectl">
<refnamediv>
<refname>expect_expectl</refname>
<refpurpose>Ожидает, пока вывод потока не совпадёт с одним из шаблонов, либо пока не
закончится максимальное время ожидания, либо вернётся <acronym>EOF</acronym>
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>expect_expectl</methodname>
<methodparam><type>resource</type><parameter>expect</parameter></methodparam>
<methodparam><type>array</type><parameter>cases</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">match</parameter></methodparam>
</methodsynopsis>
<para>
Ожидает, пока вывод потока не совпадёт с одним из шаблонов, либо пока не
закончится максимальное время ожидания, либо вернётся <acronym>EOF</acronym>.
</para>
<para>
Если задан параметр <parameter>match</parameter>, то он заполняется с результатами
поиска.
Совпавшая строка будет сохранена в <parameter>match[0]</parameter>.
Совпавшие подстроки (в зависимости от скобок) в оригинальном шаблоне будут
сохранены в <parameter>match[1]</parameter>, <parameter>match[2]</parameter>, вплоть
до <parameter>match[9]</parameter> (ограничения libexpect).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>expect</parameter></term>
<listitem>
<para>
Поток Expect, открытый с помощью
<function>expect_popen</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>cases</parameter></term>
<listitem>
<para>
Массив ожидаемых значений. Каждое ожидаемое значение представляет из себя
индексированный массив, описанный в этой таблице:
<table>
<title>Expect Case Array</title>
<tgroup cols="5">
<thead>
<row>
<entry>Индекс</entry>
<entry>Тип значения</entry>
<entry>Описание</entry>
<entry>Обязательный</entry>
<entry>Значение по умолчанию</entry>
</row>
</thead>
<tbody>
<row>
<entry>0</entry>
<entry>string</entry>
<entry>шаблон, который будет сравниваться с потоком вывода</entry>
<entry>да</entry>
<entry></entry>
</row>
<row>
<entry>1</entry>
<entry>mixed</entry>
<entry>значение, которое вернёт функция, если совпадение найдено</entry>
<entry>да</entry>
<entry></entry>
</row>
<row>
<entry>2</entry>
<entry>integer</entry>
<entry>
тип шаблона:
<link linkend="constant.exp-glob"><constant>EXP_GLOB</constant></link>,
<link linkend="constant.exp-exact"><constant>EXP_EXACT</constant></link>
или
<link linkend="constant.exp-regexp"><constant>EXP_REGEXP</constant></link>
</entry>
<entry>нет</entry>
<entry><link linkend="constant.exp-glob"><constant>EXP_GLOB</constant></link></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает значение, связанное с шаблоном с которым оно совпало.
</para>
<para>
В случае возникновения ошибки функция вернёт:
<link linkend="constant.exp-eof"><constant>EXP_EOF</constant></link>,
<link linkend="constant.exp-timeout"><constant>EXP_TIMEOUT</constant></link>
или
<link linkend="constant.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>PECL expect 0.2.1</entry>
<entry>
До версии 0.2.1, в параметр <parameter>match</parameter> возвращалась строка,
а не массив совпавших строк.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>expect_expectl</function></title>
<programlisting role="php">
<![CDATA[
<?php
// Копируем файлы с сервера:
ini_set("expect.timeout", 30);
$stream = fopen("expect://scp user@remotehost:/var/log/messages /home/user/messages.txt", "r");
$cases = array(
// array(шаблон, возвращаемов в случае совпадения значение)
array("password:", "asked for password"),
array("yes/no)?", "asked for yes/no")
);
while (true) {
switch (expect_expectl($stream, $cases)) {
case "asked for password":
fwrite($stream, "my password\n");
break;
case "asked for yes/no":
fwrite($stream, "yes\n");
break;
case EXP_TIMEOUT:
case EXP_EOF:
break 2; // Прерывает как switch так и цикл while
default:
die("Произошла ошибка!");
}
}
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:"~/.phpdoc/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
-->