php man page for yaz_connect

YAZ_CONNECT(3)								 1							    YAZ_CONNECT(3)

yaz_connect - Prepares for a connection to a Z39.50 server

SYNOPSIS
       mixed yaz_connect (string  $zurl, [mixed  $options])

DESCRIPTION
	This function returns a connection resource on success, zero on failure.

       yaz_connect(3) 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 yaz_wait(3) is called.

       Note

	       The YAZ proxy is a freely available Z39.50 proxy.

PARAMETERS
	      o $zurl
		- A string that takes the form host[:port][/database]. If port is omitted, port 210 is used. If database  is  omitted  Default	is
		used.

	      o $options
		-  If  given  as a string, it is treated as the Z39.50 V2 authentication string (OpenAuth).  If given as an array, the contents of
		the array serves as options.

		     o user
		       - Username for authentication.

		     o group
		       - Group for authentication.

		     o password
		       - Password for authentication.

		     o cookie
		       - Cookie for session (YAZ proxy).

		     o proxy
		       - Proxy for connection (YAZ proxy).

		     o persistent
		       - A boolean. If TRUE the connection is persistent; If FALSE the connection is not persistent. By  default  connections  are
		       persistent.

		     Note

			     If you open a persistent connection, you won't be able to close it later with yaz_close(3).

		     o piggyback
		       -  A  boolean.  If TRUE piggyback is enabled for searches; If FALSE piggyback is disabled. By default piggyback is enabled.
		       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.

		     o charset
		       -  A  string that specifies character set to be used in Z39.50 language and character set negotiation. Use strings such as:
		       ISO-8859-1, UTF-8, UTF-16.  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.

		     o preferredMessageSize
		       -  An  integer  that  specifies	the  maximum byte size of all records to be returned by a target during retrieval. See the
		       Z39.50 standard for more information.

		     Note

			     This option is supported in PECL YAZ 1.0.5 or later.

		     o maximumRecordSize
		       - 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 Z39.50 standard.

		     Note

			     This option is supported in PECL YAZ 1.0.5 or later.

RETURN VALUES
	A connection resource on success, FALSE on error.

CHANGELOG
       +--------+------------------------------------+
       |Version |				     |
       |	|				     |
       |	|	     Description	     |
       |	|				     |
       +--------+------------------------------------+
       | 4.1.0	|				     |
       |	|				     |
       |	|  The parameter $options was added. |
       |	|				     |
       +--------+------------------------------------+
SEE ALSO
       yaz_close(3).

PHP Documentation Group 													    YAZ_CONNECT(3)