## Tcl8.6.17/Tk8.6.17 Documentation > Tcl Commands > transchan

### Tcl/Tk Applications | Tcl Commands | Tk Commands | [incr Tcl] Package Commands | SQLite3 Package Commands | TDBC Package Commands | tdbc::mysql Package Commands | tdbc::odbc Package Commands | tdbc::postgres Package Commands | tdbc::sqlite3 Package Commands | Thread Package Commands | Tcl C API | Tk C API | [incr Tcl] Package C API | TDBC Package C API

  NAME
    transchan — 通信路変換に関する命令処理用 呼出し機能 command handler API of channel transforms
  構文 SYNOPSIS
  説明 DESCRIPTION
  共通副命令　　GENERIC SUBCOMMANDS
    cmdPrefix clear handle
    cmdPrefix finalize handle
    cmdPrefix initialize handle mode
      write
      read
  読込み関連副命令　READ-RELATED SUBCOMMANDS
    cmdPrefix drain handle
    cmdPrefix limit? handle
    cmdPrefix read handle buffer
  書込み関連副命令　 WRITE-RELATED SUBCOMMANDS
    cmdPrefix flush handle
    cmdPrefix write handle buffer
  SEE ALSO
  KEYWORDS

### NAME

transchan — 通信路変換に関する命令処理用 呼出し機能 command handler API of channel transforms

### 構文 SYNOPSIS

cmdPrefix option ?arg arg ...?

### 説明 DESCRIPTION

通信路変換の為の Tcl-水準の操作子は､やはり､副命令を伴う命令である( namespace ensemble create ［＝名前空間全体の生成］によって生成されるべきことを示唆しないにも拘らず全体[= ensemble ]と名付れられた; この仕組みはどういう意味に於いても namespace ensemble [=名前空間全体]に束縛されてはいない)｡註意すべきは､ cmdPrefix は何時であれ､ chan push の呼出しの中で指定され､そして複数の引数から構成される; これは前置辞の代りに複数の語に拡張されるであろう｡ The Tcl-level handler for a channel transformation has to be a command with subcommands (termed an ensemble despite not implying that it must be created with namespace ensemble create; this mechanism is not tied to namespace ensemble in any way). Note that cmdPrefix is whatever was specified in the call to chan push, and may consist of multiple arguments; this will be expanded to multiple words in place of the prefix.

可能な副命令の中で､処理子は開始と終了に対応せねばならない｡書込み可能な通信路の為の変換は write に対応せねばならないし､読出し可能な通信路の為の変換は read に対応せねばならない｡ Of all the possible subcommands, the handler must support initialize and finalize. Transformations for writable channels must also support write, and transformations for readable channels must also support read.

註意すべきは下で述べる cmdPrefix は複数の語であるかもしれない､又 handle は変換を作成する為に使われた chan push 呼出しによる返り値である｡ Note that in the descriptions below cmdPrefix may be more than one word, and handle is the value returned by the chan push call used to create the transformation.

#### 共通副命令　　GENERIC SUBCOMMANDS

次の副命令は全ての型の通信路に有効である｡ The following subcommands are relevant to all types of channel.

cmdPrefix clear handle
  この任意附加的な副命令は､内部緩衝域に保存されたどのデータも(入って来る方も､出て行く方も)消去しなければならないことをその変換に通知する為に呼出される｡変換途上の通信路上で chan seek が遂行される時に呼出される｡ This optional subcommand is called to signify to the transformation that any data stored in internal buffers (either incoming or outgoing) must be cleared. It is called when a chan seek is performed on the channel being transformed.

cmdPrefix finalize handle
  この必須副命令は与えられた handle に関して最後に呼出され､以降呼出されることはなく､変換に関連するどのような Tcl-水準のデータ構造も消去する為に存在が許容される｡註意! この副命令によって発生されたどの不具合も無視される｡もし解釈実行機能が削除された場合は呼出しは保証されない｡　 This mandatory subcommand is called last for the given handle, and then never again, and it exists to allow for cleaning up any Tcl-level data structures associated with the transformation. Warning! Any errors thrown by this subcommand will be ignored. It is not guaranteed to be called if the interpreter is deleted.

cmdPrefix initialize handle mode
  この必須副命令は最初に呼ばれ､以降に再び呼ばれることはない(その handle 就いては)｡それが担当する事は､ Tcl 水準での変換の部分の初期化である｡ mode は read と write のどれかを含むリストである｡ This mandatory subcommand is called first, and then never again (for the given handle). Its responsibility is to initialize all parts of the transformation at the Tcl level. The mode is a list containing any of read and write.

  write
    その通信路に書込み可を強制する｡ implies that the channel is writable.

  read
    その通信路に読込み可を強制する｡ implies that the channel is readable.

  この副命令の返り値はこの操作子に対応している全ての名前を含んだリストである｡この副命令によって発生されたどのような不具合も変換の作成を妨げる｡発生された不具合は chan push によって発生されたかのように現れる｡ The return value of the subcommand should be a list containing the names of all subcommands supported by this handler. Any error thrown by the subcommand will prevent the creation of the transformation. The thrown error will appear as error thrown by chan push.

#### 読込み関連副命令　READ-RELATED SUBCOMMANDS

この副命令は読込み可能な通信路に適用する変換を取り扱う為に使われる; 読込みは厳密には任意であるが､どれか違うものであったり､その通信路が読込み不能に作成されていたりする場合には､読込みに対応していなければならない｡ These subcommands are used for handling transformations applied to readable channels; though strictly read is optional, it must be supported if any of the others is or the channel will be made non-readable.

cmdPrefix drain handle
  この任意的副命令は入力(即ち､読込み)緩衝領域内のデータを上流向きに､即ち使用者や記述譜の向きに､強制にされるときにいつも呼出されるのものである｡手順方法により返される結果は二進データとして扱われ､この変換(読込み用または高水準変換)の上の水準に上流向きに押し込む｡ This optional subcommand is called whenever data in the transformation input (i.e. read) buffer has to be forced upward, i.e. towards the user or script. The result returned by the method is taken as the binary data to push upward to the level above this transformation (the reader or a higher-level transformation).

  言い換えるとこの手順方法が呼ばれる時､変換は実際の変換操作と異なることは全くありえないし､内部読込み緩衝域内で待機している全てのデータを変換してその活動の結果を返すことになる｡ In other words, when this method is called the transformation cannot defer the actual transformation operation anymore and has to transform all data waiting in its internal read buffers and return the result of that action.

cmdPrefix limit? handle
  この任意的副命令は Tcl I/O 処理機能にどれだけむこうまで読むかを定めることを許容する為に呼出す｡もし存在すると､零より大きい整数値を返し､それは読むべきバイト数を指し示す､又は零より小さい整数は I/O 機能が好む先迄読み込んで好いことを指し示す｡ This optional subcommand is called to allow the Tcl I/O engine to determine how far ahead it should read. If present, it should return an integer number greater than zero which indicates how many bytes ahead should be read, or an integer less than zero to indicate that the I/O engine may read as far ahead as it likes.

cmdPrefix read handle buffer
  もし変換が読取り可能な通信路と共に働く場合､基本となる通信又はこの変換の基礎の変換がデータを上流方向に押上げた時は何時でも､この副命令が呼ばれる｡この buffer は下から我々に与えられた二進データを含んでいる｡この副命令の担当はデータを実際に変換することである｡この副命令により返される結果は､二進データとして､この変換の上にある更なる変換に押上げられる｡これは又通信路から最初に読みこまれた使用者または記述譜かもしれない｡ This subcommand, which must be present if the transformation is to work with readable channels, is called whenever the base channel, or a transformation below this transformation, pushes data upward. The buffer contains the binary data which has been given to us from below. It is the responsibility of this subcommand to actually transform the data. The result returned by the subcommand is taken as the binary data to push further upward to the transformation above this transformation. This can also be the user or script that originally read from the channel.

  註意すべきは､結果は空であること､或は受取ったデータより少ないことも許容される; 変換は､与えられて直ぐに全部を変換することを要求してはいない｡入力したデータを内部緩衝域に保存することと､更なるデータを得るまで実際の変換と異なってことも許容されている｡ Note that the result is allowed to be empty, or even less than the data we received; the transformation is not required to transform everything given to it right now. It is allowed to store incoming data in internal buffers and to defer the actual transformation until it has more data.

#### 書込み関連副命令　 WRITE-RELATED SUBCOMMANDS

この副命令は書込み可能な通信路に適用する変換を取り扱う為に使われる; 書込みは厳密には任意であるが､どれか違うものであったり､その通信路が書込み不能に作成されていたりする場合には､書込みに対応していなければならない｡ These subcommands are used for handling transformations applied to writable channels; though strictly write is optional, it must be supported if any of the others is or the channel will be made non-writable.

cmdPrefix flush handle
  この任意的副命令は'書込み'緩衝領域内のデータを下流向きに､即ち基本通信路の向きに､強制にされるときにいつも呼出されるのものである｡この副命令により返される結果は二進データとして､現在の変換の下に変換するために書込むよう扱われる｡これは基礎の通信路であってもよい｡ This optional subcommand is called whenever data in the transformation 'write' buffer has to be forced downward, i.e. towards the base channel. The result returned by the subcommand is taken as the binary data to write to the transformation below the current transformation. This can be the base channel as well.

  言い換えるとこの副命令が呼ばれる時､変換は実際の変換操作と異なることは全くありえないし､内部書込みみ緩衝域内で待機している全てのデータを変換してその活動の結果を返すことになる｡ In other words, when this subcommand is called the transformation cannot defer the actual transformation operation anymore and has to transform all data waiting in its internal write buffers and return the result of that action.

cmdPrefix write handle buffer
  もし変換が書込み可能な通信路と共に働く場合､使用者又はこの変換の上の変換がデータを下流向きに書いた時は何時でも､この副命令が呼ばれる｡この buffer は下から我々に書かれた二進データを含んでいる｡この副命令の担当はデータを実際に変換することである｡ This subcommand, which must be present if the transformation is to work with writable channels, is called whenever the user, or a transformation above this transformation, writes data downward. The buffer contains the binary data which has been written to us. It is the responsibility of this subcommand to actually transform the data.

  この副命令により返される結果は､二進データとして､この変換の下にある更なる変換に書かれる｡これは基礎の通信路であってもよい｡註意すべきは､結果は空であること､或は得たデータより少ないことも許容される; 変換は､書き込んだ全部をすぐさま変換することを要求してはいない｡このデータを内部緩衝域に保存することと､更なるデータを得るまで実際の変換と異なってことも許容されている｡ The result returned by the subcommand is taken as the binary data to write to the transformation below this transformation. This can be the base channel as well. Note that the result is allowed to be empty, or less than the data we got; the transformation is not required to transform everything which was written to it right now. It is allowed to store this data in internal buffers and to defer the actual transformation until it has more data.

### SEE ALSO

chan, refchan

### KEYWORDS

API, channel, ensemble, prefix, transformation
Copyright © 2008 Donal K. Fellows