CSSJ::Session - セッション

- NAME

- 概要
- 作者

- 定数

- WARN
- ERROR
- FATAL
- INFO

- CSSJ::Session

- 引数

- CSSJ::Session->set_output

- 引数

- CSSJ::Session->set_error_func

- 引数

- CSSJ::Session->set_progress_func

- 引数

- CSSJ::Session->set_content_length_func

- 引数

- CSSJ::Session->set_property

- 引数
- 戻り値

- CSSJ::Session->include_resource

- 引数
- 戻り値

- CSSJ::Session->exclude_resource

- 引数
- 戻り値

- CSSJ::Session->format_main

- 引数
- 戻り値

- CSSJ::Session->start_resource

- 引数
- 戻り値

- CSSJ::Session->end_resource

- 引数
- 戻り値

- CSSJ::Session->start_main

- 引数
- 戻り値

- CSSJ::Session->end_main

- 引数
- 戻り値

- CSSJ::Session->close

- 戻り値

# NAME

CSSJ::Session - セッション

## 概要

CSSJで1回の変換を実行するためのセッションです。

## 作者

$Date: 2005/11/07 05:40:47 $ MIYABE Tatsuhiko

# 定数

## WARN

エラーレベル定数:警告

## ERROR

エラーレベル定数:エラー

## FATAL

エラーレベル定数:致命的エラー

## INFO

エラーレベル定数:情報

# CSSJ::Session

`new CSSJ::Session IOHANDLE`

セッションのコンストラクタです。

セッションの作成は通常CSSJ::Driver::create_sessionで行うため、 ユーザーがコンストラクタを直接呼び出す必要はありません。

## 引数

IOHANDLE 入出力ストリーム(通常はソケット)

# CSSJ::Session->set_output

`set_output OUTPUTHANDLE [MIME_TYPE]`

変換結果の出力先を指定します。

format_mainおよびstart_mainの前に呼び出してください。 この関数を呼び出さない場合、出力先はSTDOUTになります。

## 引数

OUTPUTHANDLE 出力先ハンドル。
MIME_TYPE 出力形式。省略時は'application/pdf'。

# CSSJ::Session->set_error_func

`set_error_func FUNCTION`

エラーメッセージ受信のためのコールバック関数を設定します。

format_mainおよびob_start_mainの前に呼び出してください。 コールバック関数の引数は、エラーレベル(int)、メッセージ(string)です。

## 引数

FUNCTION コールバック関数

# CSSJ::Session->set_progress_func

`set_progress_func FUNCTION`

進行状況受信のためのコールバック関数を設定します。

format_mainおよびob_start_mainの前に呼び出してください。 コールバック関数の引数は、読み込み済みバイト数(int)です。

## 引数

FUNCTION コールバック関数

# CSSJ::Session->set_content_length_func

`set_content_length_func FUNCTION`

出力結果の長さを得るためのコールバック関数を設定します。

format_mainおよびob_start_mainの前に呼び出してください。 コールバック関数の引数は、出力結果のバイト数(int)です。 この関数は、結果が出力されはじめる直前に呼ばれます。 CGIでContent-Lengthヘッダを出力するために有用です。

## 引数

FUNCTION コールバック関数

# CSSJ::Session->set_property

`set_property NAME VALUE`

プロパティを設定します。

セッションを作成した直後に呼び出してください。 利用可能なプロパティの一覧は「開発者ガイド」を参照してください。

## 引数

NAME 名前
VALUE 値

## 戻り値

成功なら1,失敗ならundef

# CSSJ::Session->include_resource

`include_resource URI_PATTERN`

アクセス可能なサーバー側リソースを設定します。

format_mainおよびstart_mainの前に呼び出してください。

## 引数

URI_PATTERN URIパターン

## 戻り値

成功なら1,失敗ならundef

# CSSJ::Session->exclude_resource

`exclude_resource URI_PATTERN`

除外するサーバー側リソースを設定します。

format_mainおよびstart_mainの前に呼び出してください。

## 引数

URI_PATTERN URIパターン

## 戻り値

成功なら1,失敗ならundef

# CSSJ::Session->format_main

`format_main URI`

サーバー側リソースを変換します。

この関数は1つのセッションにつき1度だけ呼ぶことができます。 その後、対象のセッションに対してclose以外の操作はできません。

## 引数

URI 変換対象のURI

## 戻り値

成功なら1,失敗ならundef

# CSSJ::Session->start_resource

`start_resource FILEHANDLE URI [MIME_TYPE ENCODING　IGNORE_HEADER]`

クライアント側リソースの送信を開始します。

start_resource,end_resourceは対となります。 これらの関数はformat_mainおよびstart_mainの前に呼び出してください。

指定されたファイルハンドルに書き出されたデータがサーバーに送られます。 ファイルハンドルは新しく作成したものでも、既存のものでも構いません。 例えば、STDOUTを設定すれば、標準出力に書き出したデータがサーバーに送られます。 end_resourceを呼び出すと、ファイルハンドルの状態は元に戻ります。

IGNORE_HEADERに1を設定すると、出力される内容のヘッダ部分を無視します。 データの先頭から、空行までの間がヘッダと認識されます。

## 引数

FILEHANDLE ファイルハンドル
URI リソースの仮想URI
MIME_TYPE リソースのタイプ(省略時は'text/css')
ENCODING リソースのキャラクタ・エンコーディング
IGNORE_HEADER ヘッダを無視する

## 戻り値

成功なら1,失敗ならundef

# CSSJ::Session->end_resource

`end_resource FILEHANDLE`

リソースの送信を終了し、ファイルハンドルの状態を復帰します。

start_resource,end_resourceは対となります。 これらの関数はformat_mainおよびstart_mainの前に呼び出してください。

## 引数

FILEHANDLE ファイルハンドル

## 戻り値

成功なら1,失敗ならundef

# CSSJ::Session->start_main

`start_main FILEHANDLE URI [MIME_TYPE ENCODING　IGNORE_HEADER]`

クライアント側の本体の送信を開始します。

start_main,end_mainは対となります。 本体の送信は1つのセッションにつき1度だけです。 その後、対象のセッションに対してclose以外の操作はできません。

指定されたファイルハンドルに書き出されたデータがサーバーに送られます。 ファイルハンドルは新しく作成したものでも、既存のものでも構いません。 例えば、STDOUTを設定すれば、標準出力に書き出したデータがサーバーに送られます。 end_mainを呼び出すと、ファイルハンドルの状態は元に戻ります。

IGNORE_HEADERに1を設定すると、出力される内容のヘッダ部分を無視します。 データの先頭から、空行までの間がヘッダと認識されます。

## 引数

FILEHANDLE ファイルハンドル
URI リソースの仮想URI
MIME_TYPE リソースのタイプ(省略時は'text/html')
ENCODING リソースのキャラクタ・エンコーディング
IGNORE_HEADER ヘッダを無視する

## 戻り値

成功なら1,失敗ならundef

# CSSJ::Session->end_main

`end_main FILEHANDLE`

本体の送信を終了し、ファイルハンドルの状態を復帰します。

start_main,end_mainは対となります。 本体の送信は1つのセッションにつき1度だけです。 その後、対象のセッションに対してclose以外の操作はできません。

## 引数

FILEHANDLE ファイルハンドル

## 戻り値

成功なら1,失敗ならundef

# CSSJ::Session->close

`close`

セッションを閉じます。

この関数の呼出し後、対象となったセッションに対するいかなる操作もできません。

## 戻り値

成功なら1,失敗ならundef