Help-Site Computer Manuals
Software
Hardware
Programming
Networking
  Algorithms & Data Structures   Programming Languages   Revision Control
  Protocols
  Cameras   Computers   Displays   Keyboards & Mice   Motherboards   Networking   Printers & Scanners   Storage
  Windows   Linux & Unix   Mac

POE::API::Hooks
Implement lightweight hooks into POE

POE::API::Hooks - Implement lightweight hooks into POE



NAME

POE::API::Hooks - Implement lightweight hooks into POE


SYNOPSIS


  use POE;

  use POE::API::Hooks;

  POE::API::Hooks->add(

      before_event_dispatch  => \&do_something,

      after_event_dispatch   => \&do_something,

      before_session_create  => \&do_something,

      after_session_create   => \&do_something,

      before_event_enqueue   => \&do_something,

      after_event_enqueue    => \&do_something,

  );

  # ... carry on with life as normal ...


DISCUSSION

This module adds lightweight hooks into the inner workings of POE. Currently, one can add hooks into POE that get called before/after an event is dispatched, before/after a Session is created, and/or before/after an event is enqueued. These callbacks receive the exact same argument list as their Kernel/Session counterpart. For event dispatch related callbacks, see _dispatch_event and _data_ev_enqueue in the POE::Kernel manpage. For session related callbacks, see create in the POE::Session manpage.


BUGS

When $_[KERNEL]->call($_[SESSION], ``event'') is used, _event_dispatch is bypassed. This is an optimization, not a bug, but it will cause the event_dispatch hook to be bypassed under this condition. Someone relying on the event_dispatch hook may call this a bug.


AUTHOR

Matt Cashner (sungo@pobox.com)


DATE

$Date: 2004-12-12 14:48:04 -0500 (Sun, 12 Dec 2004) $


REVISION

$Rev: 443 $


LICENSE

Copyright (c) 2004, Matt Cashner. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Programminig
Wy
Wy
yW
Wy
Programming
Wy
Wy
Wy
Wy