Z39.50 サーバーへの接続を準備する

# yaz_connect

(PHP 4 >= 4.0.1, PECL yaz >= 0.9.0)

yaz_connect — Z39.50 サーバーへの接続を準備する

### 説明

yaz_connect ( string `$zurl` [, mixed `$options` ] ) : mixed

この関数は、成功した場合に接続リソース、失敗した場合にゼロを返します。

yaz_connect() は Z39.50 サーバーへの接続を準備します。 この関数は非ブロックモードで動作し、接続を確立しようとしません - 単にあとで yaz_wait() がコールされた際に 接続を実行する準備を行うだけです。

> 注意:

> » YAZ プロキシ は、フリーで使用可能な Z39.50 のプロキシです。

### パラメータ

`zurl`

  host[:port][/database] という形式の文字列です。 port が省略された場合、210 が使用されます。database が省略された 場合、Default が使用されます。

`options`

  文字列が指定された場合、 Z39.50 V2 認証文字列(OpenAuth)として処理されます。

  配列が指定された場合、その配列の内容はオプションとして処理されます。

  user

    認証用のユーザー名

  group

    認証用のグループ

  password

    認証用のパスワード

  cookie

    セッションクッキー（YAZ プロキシ）

  proxy

    接続用プロキシ（YAZ プロキシ）

  persistent

    論理値。`TRUE` の場合、接続は持続的となります。`FALSE` の 場合、接続は持続的ではありません。デフォルトでは 接続は持続的です。

    > 注意:

    > 持続的な接続をオープンした場合、後でそれを yaz_close() によってクローズすることは できません。

  piggyback

    論理値。`TRUE` の場合、検索時の piggyback が有効になります。 `FALSE` の場合、piggyback が無効になります。デフォルトでは piggyback は有効です。

    piggyback を有効にするとより効率的となり、 通常、レコードを最初に取得する際のネットワーク往復時間を 節約することが可能です。しかし、少数の Z39.50 ターゲットは piggyback をサポートしていないか、エレメント集合名を無視します。 この場合、piggyback を無効とする必要があります。

  charset

    Z39.50 の言語および文字セットネゴシエーションに使用する 文字セットを指定する文字列。以下のような文字列を使用します。 ISO-8859-1、UTF-8、 UTF-16 。

    ほとんどの Z39.50 サーバーはこの機能をサポートしません（そのため、 無視されます）。ほとんどのサーバーは、クエリやメッセージに ISO-8859-1 エンコーディングを使用します。MARC21/USMARC レコードは この設定の影響を受けません。

  preferredMessageSize

    ターゲットから取得される全レコードの最大バイト数を指定する整数値。 詳細な情報は » Z39.50 standard を参照ください。

    > 注意:

    > このオプションは PECL YAZ 1.0.5 以降でサポートされます。

  maximumRecordSize

    ターゲットから取得される単一のレコードの最大バイト数を指定する 整数値。この項目は、 » Z39.50 standard の Exceptional-record-size として参照されます。

    > 注意:

    > このオプションは PECL YAZ 1.0.5 以降でサポートされます。

### 返り値

成功した場合に接続リソース、エラー時に `FALSE` を返します。

### 変更履歴

バージョン | 説明
--- | ---
4.1.0 | `options` が追加されました。

### 参考

- yaz_close() - YAZ 接続をクローズする