NAME

CTI::Session - セッション

概�

文書変�を実行�る���セッション��。

作者

$Date: 2011-01-20 20:01:03 +0900 (2011年01月20日 (木)) $ MIYABE Tatsuhiko

CTI::Session

new CTI::Session IOHANDLE HOST PORT [OPTIONS]

セッション�コンストラクタ��。

セッション�作��通常CTI::Driver::create_session�行���� ユーザー�コンストラクタを直接呼�出�必���り��ん。

引数

IOHANDLE
入出力ストリーム(通常�ソケット)
OPTIONS
接続オプション

CTI::Session->get_server_info

get_server_info URI

サーãƒ�ãƒ¼æƒ…å ±ã‚’è¿”ã�—ã�¾ã�™ã€‚

詳細�以下を�覧下��。

http://sourceforge.jp/projects/copper/wiki/CTIP2.0%E3%81%AE%E3%82%B5%E3%83%BC%E3%83%90%E3%83%BC%E6%83%85%E5%A0%B1

引数

URI
サー�ー情報�URI

戻り値

サーãƒ�ãƒ¼æƒ…å ±ã�®ãƒ‡ãƒ¼ã‚¿,失敗ã�ªã‚‰undef

CTI::Session->set_results

set_results RESULTS

変��果�出力先を指定���。

transcodeã�Šã‚ˆã�³start_mainã�®å‰�ã�«å‘¼ã�³å‡ºã�—ã�¦ã��ã� ã�•ã�„。 ã�“ã�®é–¢æ•°ã‚’呼ã�³å‡ºã�•ã�ªã�„å ´å�ˆã€�出力先ã�¯CTI::Results::SingleResult->new(CTI::Builder::StreamBuilder->new(*STDOUT)ã�«ã�ªã‚Šã�¾ã�™ã€‚

引数

RESULTS
出力先 Results。

CTI::Session->set_output_as_handle

set_output_as_handle OUTPUTHANDLE

変��果�出力先ファイル�ンドルを指定���。

set_resultsã�®ç°¡æ˜“版ã�§ã�™ã€‚ ã�“ã�¡ã‚‰ã�¯ã€�1ã�¤ã� ã�‘çµ�果を出力ã�™ã‚‹ãƒ•ァイルãƒ�ンドルを直接設定出æ�¥ã�¾ã�™ã€‚

引数

OUTPUTHANDLE
出力先�ンドル。
1�らContent-Type, Content-Lengthヘッダを出力�る。

CTI::Session->set_output_as_file

set_output_as_file FILENAME>

変��果�出力先ファイル�を指定���。

set_resultsã�®ç°¡æ˜“版ã�§ã�™ã€‚ ã�“ã�¡ã‚‰ã�¯ã€�1ã�¤ã� ã�‘çµ�果を出力ã�™ã‚‹ãƒ•ァイルå��を直接設定出æ�¥ã�¾ã�™ã€‚

引数

FILENAME
出力先ファイル�。

CTI::Session->set_output_as_directory

set_output_as_directory DIRNAME PREFIX SUFFIX

変��果�出力先ディレクトリ�を指定���。

set_results�簡易版��。 ��ら��複数��果をファイル���出力�るディレクトリ�を直接設定出���。 ファイル�� PREFIX ページ番� SUFFIX を����も���。

引数

DIRNAME
出力先ディレクトリ�。
PREFIX
出力�るファイル������付�る文字列。
SUFFIX
出力�るファイル����後�付�る文字列。

CTI::Session->set_message_func

set_message_func FUNCTION

メッセージ�信����コール�ック関数を設定���。

transcodeã�Šã‚ˆã�³start_mainã�®å‰�ã�«å‘¼ã�³å‡ºã�—ã�¦ã��ã� ã�•ã�„。 コールãƒ�ック関数ã�®å¼•æ•°ã�¯ã€�メッセージコード(int)ã€�メッセージ(string)ã€�引数(array)ã�§ã�™ã€‚

引数

FUNCTION
コール�ック関数

CTI::Session->set_progress_func

set_progress_func FUNCTION

進行状��信����コール�ック関数を設定���。

transcodeã�Šã‚ˆã�³start_mainã�®å‰�ã�«å‘¼ã�³å‡ºã�—ã�¦ã��ã� ã�•ã�„。 コールãƒ�ック関数ã�®å¼•æ•°ã�¯ã€�変æ�›å‰�文書ã�®ã‚µã‚¤ã‚º(integer)ã€�読ã�¿è¾¼ã�¿æ¸ˆã�¿ãƒ�イト数(integer)ã�§ã�™ã€‚

引数

FUNCTION
コール�ック関数

CTI::Session->set_resolver_func

set_resolver_func FUNCTION

リソース解決����コール�ック関数を設定���。

transcodeã�Šã‚ˆã�³start_mainã�®å‰�ã�«å‘¼ã�³å‡ºã�—ã�¦ã��ã� ã�•ã�„。 コールãƒ�ック関数ã�®å¼•æ•°ã�¯ã€�URI(string)ã�¨ã€�リソースをサーãƒ�ーã�«é€�ã‚‹ã�Ÿã‚�ã�®ã€�ã�•らã�ªã‚‹ã‚³ãƒ¼ãƒ«ãƒ�ック関数(function)ã�§ã�™ã€‚

�ら�るコール�ック関数�URI(string)�OPTIONS(hash)を引数���出力先�ファイル�ンドルを返���。

引数

FUNCTION
コール�ック関数

CTI::Session->set_continuous

set_continuous MODE

複数ã�®çµ�果をçµ�å�ˆã�™ã‚‹ãƒ¢ãƒ¼ãƒ‰ã‚’切り替ã�ˆã�¾ã�™ã€‚ モードã�Œæœ‰åйã�ªå ´å�ˆã€�join()ã�®å‘¼ã�³å‡ºã�—ã�§è¤‡æ•°ã�®çµ�果をçµ�å�ˆã�—ã�¦è¿”ã�—ã�¾ã�™ã€‚

transcodeã�Šã‚ˆã�³start_mainã�®å‰�ã�«å‘¼ã�³å‡ºã�—ã�¦ã��ã� ã�•ã�„。

引数

MODE
有効��る��TRUE

CTI::Session->property

property NAME VALUE

プロパティを設定���。

セッションを作æˆ�ã�—ã�Ÿç›´å¾Œã�«å‘¼ã�³å‡ºã�—ã�¦ã��ã� ã�•ã�„。 利用å�¯èƒ½ã�ªãƒ—ロパティã�®ä¸€è¦§ã�¯ã€Œé–‹ç™ºè€…ガイドã€�ã‚’å�‚ç…§ã�—ã�¦ã��ã� ã�•ã�„。

引数

NAME
��
VALUE
値

戻り値

�功�ら1,失敗�らundef

CTI::Session->transcode

transcode URI

サー�ー�文書を変����。

ã�“ã�®é–¢æ•°ã�¯1ã�¤ã�®ã‚»ãƒƒã‚·ãƒ§ãƒ³ã�«ã�¤ã��1度ã� ã�‘呼ã�¶ã�“ã�¨ã�Œã�§ã��ã�¾ã�™ã€‚

引数

URI
変�対象�URI

戻り値

�功�ら1,失敗�らundef

CTI::Session->start_resource

start_resource FILEHANDLE URI [OPTIONS]

クライアント�リソース��信を開始���。

start_resource,end_resourceã�¯å¯¾ã�¨ã�ªã‚Šã�¾ã�™ã€‚ ã�“れらã�®é–¢æ•°ã�¯format_mainã�Šã‚ˆã�³start_mainã�®å‰�ã�«å‘¼ã�³å‡ºã�—ã�¦ã��ã� ã�•ã�„。

指定�れ�ファイル�ンドル�書�出�れ�データ�サー�ー��られ��。 ファイル�ンドル�新��作���も��も�既存�も��も構���ん。 例���STDOUTを設定�れ��標準出力�書�出��データ�サー�ー��られ��。 end_resourceを呼�出���ファイル�ンドル�状態�元�戻り��。

IGNORE_HEADERã�«1を設定ã�™ã‚‹ã�¨ã€�出力ã�•れる内容ã�®ãƒ˜ãƒƒãƒ€éƒ¨åˆ†ã‚’無視ã�—ã�¾ã�™ã€‚ データã�®å…ˆé ­ã�‹ã‚‰ã€�空行ã�¾ã�§ã�®é–“ã�Œãƒ˜ãƒƒãƒ€ã�¨èª�è­˜ã�•れã�¾ã�™ã€‚

引数

FILEHANDLE
ファイル�ンドル
URI
リソース�仮想URI
OPTIONS
オプション mime_type => 'MIME型', encoding => 'キャラクタ・エンコーディイング', length => 予測�れるデータサイズ(�イト), ignore_headers => ヘッダを除去�る場��1

戻り値

�功�ら1,失敗�らundef

CTI::Session->end_resource

end_resource FILEHANDLE

リソース��信を終了��ファイル�ンドル�状態を復帰���。

start_resource,end_resourceã�¯å¯¾ã�¨ã�ªã‚Šã�¾ã�™ã€‚ ã�“れらã�®é–¢æ•°ã�¯format_mainã�Šã‚ˆã�³start_mainã�®å‰�ã�«å‘¼ã�³å‡ºã�—ã�¦ã��ã� ã�•ã�„。

引数

FILEHANDLE
ファイル�ンドル

戻り値

�功�ら1,失敗�らundef

CTI::Session->start_main

start_main FILEHANDLE URI [OPTIONS]

クライアント��本体��信を開始���。

start_main,end_mainã�¯å¯¾ã�¨ã�ªã‚Šã�¾ã�™ã€‚ 本体ã�®é€�ä¿¡ã�¯1ã�¤ã�®ã‚»ãƒƒã‚·ãƒ§ãƒ³ã�«ã�¤ã��1度ã� ã�‘ã�§ã�™ã€‚

指定�れ�ファイル�ンドル�書�出�れ�データ�サー�ー��られ��。 ファイル�ンドル�新��作���も��も�既存�も��も構���ん。 例���STDOUTを設定�れ��標準出力�書�出��データ�サー�ー��られ��。 end_mainを呼�出���ファイル�ンドル�状態�元�戻り��。

IGNORE_HEADERã�«1を設定ã�™ã‚‹ã�¨ã€�出力ã�•れる内容ã�®ãƒ˜ãƒƒãƒ€éƒ¨åˆ†ã‚’無視ã�—ã�¾ã�™ã€‚ データã�®å…ˆé ­ã�‹ã‚‰ã€�空行ã�¾ã�§ã�®é–“ã�Œãƒ˜ãƒƒãƒ€ã�¨èª�è­˜ã�•れã�¾ã�™ã€‚

引数

FILEHANDLE
ファイル�ンドル
URI
リソース�仮想URI
OPTIONS
オプション mime_type => 'MIME型', encoding => 'キャラクタ・エンコーディイング', length => 予測�れるデータサイズ(�イト), ignore_headers => ヘッダを除去�る場��1

戻り値

�功�ら1,失敗�らundef

CTI::Session->end_main

end_main FILEHANDLE

本体��信を終了��ファイル�ンドル�状態を復帰���。

start_main,end_mainã�¯å¯¾ã�¨ã�ªã‚Šã�¾ã�™ã€‚ 本体ã�®é€�ä¿¡ã�¯1ã�¤ã�®ã‚»ãƒƒã‚·ãƒ§ãƒ³ã�«ã�¤ã��1度ã� ã�‘ã�§ã�™ã€‚

引数

FILEHANDLE
ファイル�ンドル

戻り値

�功�ら1,失敗�らundef

CTI::Session->abort

abort MODE

変�処��中断を�求���。

引数

MODE
中断モード 0=生�済��データを出力��中断, 1=�時中断

戻り値

�功�ら1,失敗�らundef

CTI::Session->reset

reset

全��状態をリセット���。

戻り値

�功�ら1,失敗�らundef

CTI::Session->join

join

�果を�����。

戻り値

�功�ら1,失敗�らundef

CTI::Session->close

close

セッションを閉���。

��関数�呼出�後�対象����セッション�対�る���る�作も����ん。

戻り値

�功�ら1,失敗�らundef

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 3:

Non-ASCII character seen before =encoding in 'セッション'. Assuming CP1252