Tcl Library Source Code

Documentation
Login


[ Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]

NAME

tcl::chan::events - Event support for reflected/virtual channels

Table Of Contents

SYNOPSIS

package require Tcl 8.5 9
package require TclOO
package require tcl::chan::core ?1.1?
package require tcl::chan::events ?1.1?

::tcl::chan::events objectName
objectName finalize thechannel
objectName watch thechannel eventmask
objectName allow eventname...
objectName disallow eventname...

DESCRIPTION

The tcl::chan::events package provides a TclOO class implementing common behaviour needed by virtually every reflected or virtual channel supporting event driven IO. It is a sub-class of tcl::chan::core, inheriting all of its behaviour.

This class expects to be used as either superclass of a concrete channel class, or to be mixed into such a class.

Class API

Instance API

The API of channel event core instances provides only four methods, two corresponding to channel handler commands (For reference see TIP 219), and the other two for use by sub-classes to control event generation. They former expect to be called from whichever object instance the channel event core was made a part of.

Bugs, Ideas, Feedback

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category virtchannel of the Tcllib Trackers. Please also report any ideas for enhancements you may have for either package and/or documentation.

When proposing code changes, please provide unified diffs, i.e the output of diff -u.

Note further that attachments are strongly preferred over inlined patches. Attachments can be made by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar.

KEYWORDS

event management, reflected channel, tip 219, virtual channel

CATEGORY

Channels

COPYRIGHT

Copyright © 2009 Andreas Kupries