diff options
Diffstat (limited to 'doc/refchan.n')
-rw-r--r-- | doc/refchan.n | 161 |
1 files changed, 45 insertions, 116 deletions
diff --git a/doc/refchan.n b/doc/refchan.n index 8737556..d27e464 100644 --- a/doc/refchan.n +++ b/doc/refchan.n @@ -1,4 +1,4 @@ -'\" +'\" '\" Copyright (c) 2006 Andreas Kupries <andreas_kupries@users.sourceforge.net> '\" '\" See the file "license.terms" for information on usage and redistribution @@ -9,7 +9,7 @@ .BS .\" Note: do not modify the .SH NAME line immediately below! .SH NAME -refchan \- command handler API of reflected channels +refchan \- Command handler API of reflected channels, version 1 .SH SYNOPSIS \fBcmdPrefix \fIoption\fR ?\fIarg arg ...\fR? .BE @@ -17,10 +17,9 @@ refchan \- command handler API of reflected channels .PP The Tcl-level handler for a reflected channel has to be a command with subcommands (termed an \fIensemble\fR, as it is a command such as that -created by \fBnamespace ensemble\fR \fBcreate\fR, though the implementation +created by \fBnamespace ensemble create\fR, though the implementation of handlers for reflected channel \fIis not\fR tied to \fBnamespace -ensemble\fRs in any way; see \fBEXAMPLE\fR below for how to build an -\fBoo::class\fR that supports the API). Note that \fIcmdPrefix\fR is whatever was +ensemble\fRs in any way). Note that \fIcmdPrefix\fR is whatever was specified in the call to \fBchan create\fR, and may consist of multiple arguments; this will be expanded to multiple words in place of the prefix. @@ -46,7 +45,7 @@ this command handler. Any error thrown by the method will abort the creation of the channel and no channel will be created. The thrown error will appear as error thrown by \fBchan create\fR. Any exception other than an \fBerror\fR -(e.g.,\ \fBbreak\fR, etc.) is treated as (and converted to) an error. +(e.g. \fBbreak\fR, etc.) is treated as (and converted to) an error. .PP \fBNote:\fR If the creation of the channel was aborted due to failures here, then the \fBfinalize\fR subcommand will not be called. @@ -74,8 +73,8 @@ cleaned up. The return value of this subcommand is ignored. .PP If the subcommand throws an error the command which caused its -invocation (usually \fBchan close\fR) will appear to have thrown this -error. Any exception beyond \fBerror\fR (e.g.,\ \fBbreak\fR, etc.) is +invocation (usually \fBclose\fR) will appear to have thrown this +error. Any exception beyond \fIerror\fR (e.g. \fIbreak\fR, etc.) is treated as (and converted to) an error. .PP This subcommand is not invoked if the creation of the channel was @@ -93,7 +92,7 @@ the handler should disable event generation completely. .RS .PP \fBWarning:\fR Any return value of the subcommand is ignored. This -includes all errors thrown by the subcommand, \fBbreak\fR, \fBcontinue\fR, and +includes all errors thrown by the subcommand, break, continue, and custom return codes. .PP This subcommand interacts with \fBchan postevent\fR. Trying to post an @@ -105,7 +104,7 @@ event which was not listed in the last call to \fBwatch\fR will cause \fIcmdPrefix \fBread \fIchannelId count\fR . This \fIoptional\fR subcommand is called when the user requests data from the -channel \fIchannelId\fR. \fIcount\fR specifies how many \fIbytes\fR have been +channel \fIchannelId\fR. \fIcount\fR specifies how many \fBbytes\fR have been requested. If the subcommand is not supported then it is not possible to read from the channel handled by the command. .RS @@ -131,11 +130,8 @@ error EAGAIN .PP For extensibility any error whose value is a negative integer number will cause the higher layers to set the C-level variable "\fBerrno\fR" -to the absolute value of this number, signaling a system error. -However, note that the exact mapping between these error numbers and -their meanings is operating system dependent. -.PP -For example, while on Linux both +to the absolute value of this number, signaling a system error. This +means that both .PP .CS return -code error -11 @@ -145,17 +141,13 @@ and error -11 .CE .PP -are equivalent to the examples above, using the more readable string "EAGAIN", -this is not true for BSD, where the equivalent number is -35. -.PP -The symbolic string however is the same across systems, and internally -translated to the correct number. No other error value has such a mapping -to a symbolic string. +are equivalent to the examples above, using the more readable string "EAGAIN". +No other error value has such a mapping to a symbolic string. .PP If the subcommand throws any other error, the command which caused its invocation (usually \fBgets\fR, or \fBread\fR) will appear to have -thrown this error. Any exception beyond \fBerror\fR, (e.g.,\ \fBbreak\fR, -etc.) is treated as and converted to an error. +thrown this error. Any exception beyond \fIerror\fR, (e.g. +\fIbreak\fR, etc.) is treated as and converted to an error. .RE .TP \fIcmdPrefix \fBwrite \fIchannelId data\fR @@ -211,20 +203,18 @@ to a symbolic string. .PP If the subcommand throws any other error the command which caused its invocation (usually \fBputs\fR) will appear to have thrown this error. -Any exception beyond \fBerror\fR (e.g.,\ \fBbreak\fR, etc.) is treated +Any exception beyond \fIerror\fR (e.g.\ \fIbreak\fR, etc.) is treated as and converted to an error. .RE .TP \fIcmdPrefix \fBseek \fIchannelId offset base\fR . This \fIoptional\fR subcommand is responsible for the handling of -\fBchan seek\fR and \fBchan tell\fR requests on the channel -\fIchannelId\fR. If it is not supported then seeking will not be possible for -the channel. +\fBseek\fR and \fBtell\fR requests on the channel \fIchannelId\fR. If it is not +supported then seeking will not be possible for the channel. .RS .PP -The \fIbase\fR argument is the same as the equivalent argument of the -builtin \fBchan seek\fR, namely: +The \fIbase\fR argument is one of .TP 10 \fBstart\fR . @@ -238,22 +228,27 @@ Seeking is relative to the current seek position. . Seeking is relative to the end of the channel. .PP +The \fIbase\fR argument of the builtin \fBchan seek\fR command takes +the same names. +.PP The \fIoffset\fR is an integer number specifying the amount of \fBbytes\fR to seek forward or backward. A positive number should seek forward, and a negative number should seek backward. +.PP A channel may provide only limited seeking. For example sockets can seek forward, but not backward. .PP The return value of the subcommand is taken as the (new) location of the channel, counted from the start. This has to be an integer number greater than or equal to zero. +.PP If the subcommand throws an error the command which caused its -invocation (usually \fBchan seek\fR, or \fBchan tell\fR) will appear to have -thrown this error. Any exception beyond \fBerror\fR (e.g.,\ \fBbreak\fR, +invocation (usually \fBseek\fR, or \fBtell\fR) will appear to have +thrown this error. Any exception beyond \fIerror\fR (e.g. \fIbreak\fR, etc.) is treated as and converted to an error. .PP -The offset/base combination of 0/\fBcurrent\fR signals a \fBchan tell\fR -request, i.e.,\ seek nothing relative to the current location, making +The offset/base combination of 0/\fBcurrent\fR signals a \fBtell\fR +request, i.e. seek nothing relative to the current location, making the new location identical to the current one, which is then returned. .RE .TP @@ -270,9 +265,9 @@ time; that is behavior implemented in the Tcl channel core. The return value of the subcommand is ignored. .PP If the subcommand throws an error the command which performed the -(re)configuration or query (usually \fBfconfigure\fR or -\fBchan configure\fR) will appear to have thrown this error. Any exception -beyond \fBerror\fR (e.g.,\ \fBbreak\fR, etc.) is treated as and +(re)configuration or query (usually \fBfconfigure\fR or \fBchan +configure\fR) will appear to have thrown this error. Any exception +beyond \fIerror\fR (e.g. \fIbreak\fR, etc.) is treated as and converted to an error. .RE .TP @@ -286,9 +281,9 @@ subcommand \fBcgetall\fR must be supported as well. The subcommand should return the value of the specified \fIoption\fR. .PP If the subcommand throws an error, the command which performed the -(re)configuration or query (usually \fBfconfigure\fR or \fBchan configure\fR) -will appear to have thrown this error. Any exception beyond \fIerror\fR -(e.g.,\ \fBbreak\fR, etc.) is treated as and converted to an error. +(re)configuration or query (usually \fBfconfigure\fR) will appear to +have thrown this error. Any exception beyond \fIerror\fR (e.g. +\fIbreak\fR, etc.) is treated as and converted to an error. .RE .TP \fIcmdPrefix \fBcgetall \fIchannelId\fR @@ -302,9 +297,9 @@ The subcommand should return a list of all options and their values. This list must have an even number of elements. .PP If the subcommand throws an error the command which performed the -(re)configuration or query (usually \fBfconfigure\fR or \fBchan configure\fR) -will appear to have thrown this error. Any exception beyond \fBerror\fR -(e.g.,\ \fBbreak\fR, etc.) is treated as and converted to an error. +(re)configuration or query (usually \fBfconfigure\fR) will appear to +have thrown this error. Any exception beyond \fIerror\fR (e.g. +\fIbreak\fR, etc.) is treated as and converted to an error. .RE .TP \fIcmdPrefix \fBblocking \fIchannelId mode\fR @@ -318,19 +313,19 @@ channel should be non-blocking. The return value of the subcommand is ignored. .PP If the subcommand throws an error the command which caused its -invocation (usually \fBfconfigure\fR or \fBchan configure\fR) will appear to -have thrown this error. Any exception beyond \fBerror\fR (e.g.,\ \fBbreak\fR, -etc.) is treated as and converted to an error. +invocation (usually \fBfconfigure\fR) will appear to have thrown this +error. Any exception beyond \fIerror\fR (e.g. \fIbreak\fR, etc.) is +treated as and converted to an error. .RE .SH NOTES Some of the functions supported in channels defined in Tcl's C interface are not available to channels reflected to the Tcl level. .PP -The function \fBTcl_DriverGetHandleProc\fR is not supported; -i.e.,\ reflected channels do not have OS specific handles. +The function \fBTcl_DriverGetHandleProc\fR is not supported; i.e. +reflected channels do not have OS specific handles. .PP The function \fBTcl_DriverHandlerProc\fR is not supported. This driver -function is relevant only for stacked channels, i.e.,\ transformations. +function is relevant only for stacked channels, i.e. transformations. Reflected channels are always base channels, not transformations. .PP The function \fBTcl_DriverFlushProc\fR is not supported. This is @@ -339,73 +334,7 @@ function anywhere at all. Therefore support at the Tcl level makes no sense either. This may be altered in the future (through extending the API defined here and changing its version number) should the function be used at some time in the future. -.SH EXAMPLE -.PP -This demonstrates how to make a channel that reads from a string. -.PP -.CS -oo::class create stringchan { - variable data pos - constructor {string {encoding {}}} { - if {$encoding eq ""} {set encoding [encoding system]} - set data [encoding convertto $encoding $string] - set pos 0 - } - - method \fBinitialize\fR {ch mode} { - return "initialize finalize watch read seek" - } - method \fBfinalize\fR {ch} { - my destroy - } - method \fBwatch\fR {ch events} { - # Must be present but we ignore it because we do not - # post any events - } - - # Must be present on a readable channel - method \fBread\fR {ch count} { - set d [string range $data $pos [expr {$pos+$count-1}]] - incr pos [string length $d] - return $d - } - - # This method is optional, but useful for the example below - method \fBseek\fR {ch offset base} { - switch $base { - start { - set pos $offset - } - current { - incr pos $offset - } - end { - set pos [string length $data] - incr pos $offset - } - } - if {$pos < 0} { - set pos 0 - } elseif {$pos > [string length $data]} { - set pos [string length $data] - } - return $pos - } -} - -# Now we create an instance... -set string "The quick brown fox jumps over the lazy dog.\\n" -set ch [\fBchan create\fR read [stringchan new $string]] - -puts [gets $ch]; # Prints the whole string - -seek $ch -5 end; -puts [read $ch]; # Prints just the last word -.CE .SH "SEE ALSO" -chan(n), transchan(n) +chan(n) .SH KEYWORDS -API, channel, ensemble, prefix, reflection -'\" Local Variables: -'\" mode: nroff -'\" End: +channel, reflection |