Class Session

Copper PDF サーバーとの 1 対 1 通信セッションを管理するクラス。

CTIP/2.0 プロトコルを介してドキュメントを PDF にトランスコードし、結果をストリーム・ファイル・ディレクトリのいずれかに出力する。

基本的な使い方:

setOutput*() で出力先を設定する
必要に応じて resource() でリソースを事前送信する
transcode() で返ったストリームにドキュメントを書き込み、end() する
waitForCompletion() でトランスコード完了を待機する
連続モードの場合は reset() してステップ 1 から繰り返す
最後に close() で接続を切断する

Index

Constructors

constructor

new Session(socket: Socket | TLSSocket, options?: SessionOptions): Session
新しいセッションを作成
Parameters
- socket: Socket | TLSSocket
  接続されたソケット
- options: SessionOptions = {}
  セッションオプション
Returns Session
- Defined in src/session.ts:329

Properties

socket

socket: Socket | TLSSocket

Methods

abort

abort(mode: number): void
現在進行中のトランスコードを中断する。
Parameters
- mode: number
  中断モード。0 の場合は現在の出力をフラッシュして中断。それ以外は即座中断
Returns void
- Defined in src/session.ts:774

close

close(): void
セッションを閉じてサーバーとの接続を切断する。既に閃じている場合は何も行わない。このメソッドを呼び出した後はセッションの回復不可。次回は新しいセッションを作成すること。

Returns void
- Defined in src/session.ts:821

getServerInfo

getServerInfo(uri: string): Promise<string>
指定した URI に対するサーバー情報を取得する。サーバーのバージョン情報や属性などを確認する際に利用する。
Parameters
- uri: string
  情報取得対象の URI。空文字列の場合はサーバー機能一覧を返すことが多い
Returns Promise<string>
サーバーから返された UTF-8 文字列の情報
- Defined in src/session.ts:688

join

join(): void
join トランスコードを開始する。連続モードで送信済みの複数ドキュメントをサーバー側で結合する。完了を待機するには waitForCompletion() を呼び出すこと。

Returns void
Throws
セッションが閉じている場合
- Defined in src/session.ts:806

reset

reset(): void
セッションの各種設定を初期化して再利用可能な状態に戻す。連続モードで複数ドキュメントを変換する際、各巣終処理と次回引数のリセットに使用する。コールバックやビルダーはクリアされるため、次回の transcode() 前に再設定する必要がある。

Returns void
Throws
セッションが閉じている場合
- Defined in src/session.ts:786

resource

resource(uri: string, opts?: ResourceOptions): Writable
リソースデータをサーバーに送信するための書き込み先ストリームを返す。 transcode() 呼び出し前に使用する。返されたストリームへデータをパイプすることでリソースが送信される。
Parameters
- uri: string
  リソースの URI
- opts: ResourceOptions = {}
  MIMEタイプ、エンコーディング、コンテンツ長さなどを指定するオプション
Returns Writable
リソースデータを書き込むための書き込み可能ストリーム

Throws
トランスコード済みの場合
- Defined in src/session.ts:704

send

send(data: Buffer): boolean
サーバーにバイナリデータを送信する。ハンドシェイク完了前の場合はバッファに迏えて後送信する。
Parameters
- data: Buffer
  送信するバイナリフレーム
Returns boolean
ソケットの内部バッファがフラッシュされたかどうか (socket.write の戻り値と同じ)

Throws
セッションが閉じている場合
- Defined in src/session.ts:557

setContinuous

setContinuous(continuous: boolean): void
連続トランスコードモードを有効/無効に設定する。連続モードを有効にすると、複数のトランスコードを同一セッションで実行できる。
Parameters
- continuous: boolean
  true の場合は連続モードを有効にする
Returns void
Throws
トランスコード済みの場合
- Defined in src/session.ts:665

setMessageFunc

setMessageFunc(func: MessageCallback | null): void
サーバーからのメッセージを受け取るコールバックを設定する。 null を渡すことでメッセージ機能を無効化できる。
Parameters
- func: MessageCallback | null
  メッセージコード、メッセージ、引数配列を受け取るコールバック、または null
Returns void
Throws
トランスコード済みの場合
- Defined in src/session.ts:629

setOutputAsDirectory

setOutputAsDirectory(dir: string, prefix?: string, suffix?: string): void
PDF出力先ディレクトリを指定するショートカットメソッド。トランスコードごとに {prefix}{n}{suffix} 形式のファイルが生成される。
Parameters
- dir: string
  出力先ディレクトリのパス
- prefix: string = ''
  ファイル名のプレフィックス (デフォルト: 空文字列)
- suffix: string = ''
  ファイル名のサフィックス (デフォルト: 空文字列)
Returns void
Throws
トランスコード済みの場合
- Defined in src/session.ts:609

setOutputAsFile

setOutputAsFile(file: string): void
PDF出力先ファイルパスを指定するショートカットメソッド。内部で FileBuilder を使用する。
Parameters
- file: string
  出力先ファイルのパス
Returns void
Throws
トランスコード済みの場合
- Defined in src/session.ts:597

setOutputAsStream

setOutputAsStream(stream: Writable): void
PDF出力先ストリームを指定するショートカットメソッド。 HTTPレスポンスのストリームなど任意の Writable を指定できる。
Parameters
- stream: Writable
  出力先の書き込み可能ストリーム
Returns void
Throws
トランスコード済みの場合
- Defined in src/session.ts:619

setProgressFunc

setProgressFunc(func: ProgressCallback | null): void
トランスコードの進捗を受け取るコールバックを設定する。法剆コンテンツの全体バイト数 (total) と読み込み完了バイト数 (read) が渡される。 total が null の場合はまだ全体さが不明。
Parameters
- func: ProgressCallback | null
  進捗情報を受け取るコールバック、または null
Returns void
Throws
トランスコード済みの場合
- Defined in src/session.ts:641

setProperty

setProperty(name: string, value: string): void
トランスコードプロパティを設定する。サーバー側で認識される各種制御パラメータを指定するために使用する。
Parameters
- name: string
  プロパティ名
- value: string
  プロパティ値
Returns void
Throws
トランスコード済みの場合
- Defined in src/session.ts:677

setResolverFunc

setResolverFunc(func: ResolverCallback | null): void
リソースリゾルバコールバックを設定する。コールバックが設定されている場合、CSS画像などの外部リソースの取得要求時に呼び出される。 null を渡すとクライアントリソース機能が無効化される。
Parameters
- func: ResolverCallback | null
  URI と Resource オブジェクトを受け取るコールバック、または null
Returns void
Throws
トランスコード済みの場合
- Defined in src/session.ts:653

setResults

setResults(results: Results): void
出力先の結果ハンドラを設定する。 transcode() 呼び出し前に設定する必要がある。
Parameters
- results: Results
  使用する Results 実装
Returns void
Throws
トランスコード済みの場合
- Defined in src/session.ts:586

transcode

transcode(uri?: string, opts?: TranscodeOptions): Writable
トランスコードを開始
Parameters
- uri: string = '.'
  ドキュメントURI
- opts: TranscodeOptions = {}
  トランスコードオプション
Returns Writable
ドキュメントコンテンツ用の書き込み可能ストリーム
- Defined in src/session.ts:720

transcodeServer

transcodeServer(uri: string): void
サーバー内URLのドキュメントをトランスコードする。コンテンツはサーバー側から直接取得されるため、クライアントからデータを送信する必要はない。完了を待機するには waitForCompletion() を呼び出すこと。
Parameters
- uri: string
  サーバー内ドキュメントの URI
Returns void
Throws
セッションが閉じているか、トランスコード済みの場合
- Defined in src/session.ts:748

waitForCompletion

waitForCompletion(): Promise<void>
現在進行中のトランスコードまたは結合処理の完了を待機する。 transcode()、transcodeServer()、join() の後に呼び出すこと。トランスコードが失敗した場合はエラーで reject される。

Returns Promise<void>
- Defined in src/session.ts:764