diff options
| author | dkf <donal.k.fellows@manchester.ac.uk> | 2009-01-30 11:18:38 (GMT) |
|---|---|---|
| committer | dkf <donal.k.fellows@manchester.ac.uk> | 2009-01-30 11:18:38 (GMT) |
| commit | b52edeeca3ae9b5a5c62fbe5d718f7c8035232a3 (patch) | |
| tree | 8e00d45fad26c6c2f3b38704948d48881aa6e2f4 | |
| parent | 1ded7d18ee9da0c3312afb777ea2036a69265d36 (diff) | |
| download | tcl-b52edeeca3ae9b5a5c62fbe5d718f7c8035232a3.zip tcl-b52edeeca3ae9b5a5c62fbe5d718f7c8035232a3.tar.gz tcl-b52edeeca3ae9b5a5c62fbe5d718f7c8035232a3.tar.bz2 | |
Added example.
| -rw-r--r-- | ChangeLog | 4 | ||||
| -rw-r--r-- | doc/refchan.n | 38 |
2 files changed, 40 insertions, 2 deletions
@@ -1,3 +1,7 @@ +2009-01-30 Donal K. Fellows <dkf@users.sf.net> + + * doc/refchan.n: Added an example of how to build a scripted channel. + 2009-01-29 Donal K. Fellows <dkf@users.sf.net> * tests/stringObj.test: [Bug 2006888]: Remove non-ASCII chars from diff --git a/doc/refchan.n b/doc/refchan.n index 4365512..0ed6a20 100644 --- a/doc/refchan.n +++ b/doc/refchan.n @@ -4,11 +4,11 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: refchan.n,v 1.12 2008/10/07 14:10:29 dkf Exp $ +'\" RCS: @(#) $Id: refchan.n,v 1.13 2009/01/30 11:18:38 dkf Exp $ .so man.macros .TH refchan n 8.5 Tcl "Tcl Built-In Commands" .BS -.\" Note: do not modify the .SH NAME line immediately below! +1.\" Note: do not modify the .SH NAME line immediately below! .SH NAME refchan \- command handler API of reflected channels .SH SYNOPSIS @@ -272,7 +272,41 @@ 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 offset + constructor {string {encoding {}}} { + if {$encoding eq ""} {set encoding [encoding system]} + set data [encoding convertto $encoding $string] + set offset 0 + } + method \fBinitialize\fR {ch mode} { + return "initialize finalize watch read" + } + 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 + } + method \fBread\fR {ch count} { + set d [string range $data $offset [expr {$offset+$count-1}]] + incr offset [string length $d] + return $d + } +} +set string "The quick brown fox jumps over the lazy dog.\n" +set ch [\fBchan create\fR read [stringchan new $string]] +.CE .SH "SEE ALSO" chan(n), transchan(n) .SH KEYWORDS API, channel, ensemble, prefix, reflection +'\" Local Variables: +'\" mode: nroff +'\" End: |