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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.16 $ -->
<refentry id="function.yaz-connect">
<refnamediv>
<refname>yaz_connect</refname>
<refpurpose>
Prepares for a connection to a Z39.50 server
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>yaz_connect</methodname>
<methodparam><type>string</type><parameter>zurl</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
This function returns a connection resource on success, zero on
failure.
</para>
<para>
<function>yaz_connect</function> prepares for a connection to a
Z39.50 server.
This function is non-blocking and does not attempt to establish
a connection - it merely prepares a connect to be performed later when
<function>yaz_wait</function> is called.
</para>
<note>
<para>
The <ulink url="&url.yaz-proxy;">YAZ proxy</ulink> is a
freely available Z39.50 proxy.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>zurl</parameter></term>
<listitem>
<para>
A string that takes the form <literal>host[:port][/database]</literal>.
If port is omitted, port 210 is used. If database is omitted
<literal>Default</literal> is used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
If given as a string, it is treated as the Z39.50 V2 authentication
string (OpenAuth).
</para>
<para>
If given as an array, the contents of the array serves as options.
<variablelist>
<varlistentry>
<term>user</term>
<listitem>
<para>
Username for authentication.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>group</term>
<listitem>
<para>
Group for authentication.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>password</term>
<listitem>
<para>
Password for authentication.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>cookie</term>
<listitem>
<para>
Cookie for session (YAZ proxy).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>proxy</term>
<listitem>
<para>
Proxy for connection (YAZ proxy).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>persistent</term>
<listitem>
<para>
A boolean. If &true; the connection is persistent; If &false; the
connection is not persistent. By default connections are persistent.
</para>
<note>
<para>
If you open a persistent connection, you won't be able to close
it later with <function>yaz_close</function>.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term>piggyback</term>
<listitem>
<para>
A boolean. If &true; piggyback is enabled for searches; If &false;
piggyback is disabled. By default piggyback is enabled.
</para>
<para>
Enabling piggyback is more efficient and usually saves a
network-round-trip for first time fetches of records. However, a
few Z39.50 servers do not support piggyback or they ignore element
set names. For those, piggyback should be disabled.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>charset</term>
<listitem>
<para>
A string that specifies character set to be used in Z39.50
language and character set negotiation. Use strings such as:
<literal>ISO-8859-1</literal>, <literal>UTF-8</literal>,
<literal>UTF-16</literal>.
</para>
<para>
Most Z39.50 servers do not support this feature (and thus, this is
ignored). Many servers use the ISO-8859-1 encoding for queries and
messages. MARC21/USMARC records are not affected by this setting.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>preferredMessageSize</term>
<listitem>
<para>
An integer that specifies the maximum byte size of all records
to be returned by a target during retrieval. See the
<ulink url="&url.yaz.z3950.4;">Z39.50 standard</ulink> for more
information.
</para>
<note>
<para>
This option is supported in PECL YAZ 1.0.5 or later.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term>maximumRecordSize</term>
<listitem>
<para>
An integer that specifies the maximum byte size of a single record
to be returned by a target during retrieval. This
entity is referred to as Exceptional-record-size in the
<ulink url="&url.yaz.z3950.4;">Z39.50 standard</ulink>.
</para>
<note>
<para>
This option is supported in PECL YAZ 1.0.5 or later.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A connection resource on success, &false; on error.
</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>4.1.0</entry>
<entry>
The parameter <parameter>options</parameter> was added.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>yaz_close</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
-->
|
