Scheduler: Console 'events' command documentation
[senf.git] / Scheduler / EventManager.cc
1 // $Id$
2 //
3 // Copyright (C) 2008 
4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 //     Stefan Bund <g0dil@berlios.de>
7 //
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2 of the License, or
11 // (at your option) any later version.
12 //
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 // GNU General Public License for more details.
17 //
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22
23 /** \file
24     \brief EventManager non-inline non-template implementation */
25
26 //#include "EventManager.hh"
27 //#include "EventManager.ih"
28
29 // Custom includes
30 #include <boost/format.hpp>
31 #include "../Utils/membind.hh"
32 #include "Console/Console.hh"
33 #include "FIFORunner.hh"
34
35 //#include "EventManager.mpp"
36 #define prefix_
37 ///////////////////////////////cc.p////////////////////////////////////////
38
39 prefix_ senf::scheduler::detail::EventManager::EventManager()
40 {
41 #ifndef SENF_DISABLE_CONSOLE
42     consoleDir_().add("events", senf::membind(&EventManager::consoleEvents, this))
43         .doc("List all scheduler events sorted by priority\n"
44              "\n"
45              "Columns:\n"
46              "    TP      event type: fd - file descriptor, tm - timer, si - UNIX signal\n"
47              "    NAME    descriptive event name\n"
48              "    ADDRESS address of event class instance\n"
49              "    RUNCNT  number of times, the event was called\n"
50              "    S       state: R - runnable, W - Waiting, '-' - event disabled\n"
51              "    INFO    further event specific information");
52
53     senf::console::sysdir().add("scheduler", consoleDir_());
54 #endif
55 }
56
57 prefix_ void senf::scheduler::detail::EventManager::consoleEvents(std::ostream & os)
58 {
59     // On an 80 column display, this wraps nicely directly before the INFO column
60     boost::format fmt  ("%s %-55.55s 0x%08x %8d %s %s\n");
61     os << boost::format("%s %-55.55s %-10s %8s %s %s\n")
62         % "TP" % "NAME" % "ADDRESS" % "RUNCNT" % "S" % "INFO";
63     {
64         FIFORunner::iterator i (FIFORunner::instance().begin());
65         FIFORunner::iterator const i_end (FIFORunner::instance().end());
66         for (; i != i_end; ++i)
67             os << fmt 
68                 % i->type()
69                 % i->name() 
70                 % reinterpret_cast<unsigned long>(&(*i))
71                 % i->runCount()
72                 % (i->runnable() ? "R" : "W")
73                 % i->info();
74     }
75     {
76         iterator i (begin());
77         iterator const i_end (end());
78         for (; i != i_end; ++i)
79             if (! i->enabled())
80                 os << fmt
81                     % i->type()
82                     % i->name() 
83                     % reinterpret_cast<unsigned long>(&(*i))
84                     % i->runCount()
85                     % "-"
86                     % i->info();
87     }
88 }
89
90 ///////////////////////////////cc.e////////////////////////////////////////
91 #undef prefix_
92 //#include "EventManager.mpp"
93
94 \f
95 // Local Variables:
96 // mode: c++
97 // fill-column: 100
98 // comment-column: 40
99 // c-file-style: "senf"
100 // indent-tabs-mode: nil
101 // ispell-local-dictionary: "american"
102 // compile-command: "scons -u test"
103 // End: