logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

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

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  TcllibTrackers  [http://core.tcl.tk/tcllib/reportlist].
       Please also report any ideas for enhancements you may have for either package and/or documentation.

       When proposing code changes, please provide unifieddiffs, 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.

Category

       Channels

Class Api

::tcl::chan::eventsobjectName
              This command creates a new channel event core object with an associated global Tcl  command  whose
              name  is  objectName.  This  command  may  be  used to invoke various operations on the object, as
              described in the section for the InstanceAPI.

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.

Instance Api

       The API of channel event core instances provides only four methods, two corresponding to channel  handler
       commands  (For reference see TIP219 [http:/tip.tcl.tk/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.

       objectNamefinalizethechannel
              This  method  implements  standard  behaviour  for  the  finalize  method  of channel handlers. It
              overrides the behaviour inherited from tcl::chan::core and additionally disables any and all event
              generation before destroying itself.

       objectNamewatchthechanneleventmask
              This method implements standard behaviour for the watch method of channel handlers. Called by  the
              IO  system whenever the interest in event changes it updates the instance state to activate and/or
              suppress the generation of the events of (non-)interest.

       objectNamealloweventname...

       objectNamedisalloweventname...
              These two methods are exported to sub-classes, so that their instances can notify their event core
              of the events the channel they implement can (allow) or cannot (disallow) generate.  Together with
              the information about the events requested by Tcl's IO system coming in through the  watch  method
              the event core is able to determine which events it should (not) generate and act accordingly.

Keywords

       event management, reflected channel, tip 219, virtual channel

Name

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

Synopsis

       package require Tcl8.59

       package require TclOO

       package require tcl::chan::core?1.1?

       package require tcl::chan::events?1.1?::tcl::chan::eventsobjectNameobjectNamefinalizethechannelobjectNamewatchthechanneleventmaskobjectNamealloweventname...

       objectNamedisalloweventname...

________________________________________________________________________________________________________________

See Also