Console: Documentation fix
[senf.git] / Console / testServer.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 testServer implementation */
25
26 // Custom includes
27 #include <iostream>
28 #include <senf/Console.hh>
29 #include <senf/Scheduler/Scheduler.hh>
30
31 namespace kw = senf::console::kw;
32
33 void echo(std::ostream & output, senf::console::ParseCommandInfo const & command)
34 {
35     typedef senf::console::ParseCommandInfo::ArgumentsRange::iterator iterator;
36     iterator i (command.arguments().begin());
37     iterator i_end (command.arguments().end());
38     for (; i != i_end; ++i) {
39         iterator::value_type::iterator j (i->begin());
40         iterator::value_type::iterator j_end (i->end());
41         for (; j != j_end; ++j) 
42             output << j->value() << ' ';
43     }
44     output << "\n";
45 }
46
47 struct TestObject
48 {
49     senf::console::ScopedDirectory<TestObject> dir;
50
51     TestObject() 
52         : dir(this) 
53         {
54             dir.add("vat", &TestObject::vat)
55                 .arg("vat", "VAT in %", kw::default_value = 19)
56                 .arg("amount", "Amount including VAT")
57                 .doc("Returns the amount of {vat}-% VAT included in {amount}");
58         }
59
60     double vat (int vat, double amount) 
61         {
62             return amount * vat/(100.0+vat);
63         }
64 };
65
66 void shutdownServer()
67 {
68     senf::Scheduler::instance().terminate();
69     throw senf::console::Executor::ExitException();
70 }
71
72 void enableLogging(std::ostream & os)
73 {
74     senf::console::Client::get(os).route<senf::log::NOTICE>();
75 }
76
77 int main(int, char **)
78 {
79     ::signal(SIGPIPE, SIG_IGN);
80     senf::log::ConsoleTarget::instance().route< senf::log::VERBOSE >();
81
82     senf::console::root()
83         .doc("This is the console test application");
84
85     senf::console::root()
86         .mkdir("console")
87         .doc("Console settings");
88
89     senf::console::DirectoryNode & serverDir (
90         senf::console::root()
91             .mkdir("server")
92             .doc("server commands") );
93
94     senf::console::ScopedDirectory<> testDir;
95     senf::console::root()
96         .add("test", testDir)
97         .doc("Test functions");
98
99     senf::console::root()["console"]
100         .add("showlog", &enableLogging)
101         .doc("Enable display of log messages on the current console");
102
103     serverDir
104         .add("shutdown", &shutdownServer)
105         .doc("Terminate server application");
106
107     testDir
108         .add("echo", &echo)
109         .doc("Example of a function utilizing manual argument parsing");
110
111     TestObject test;
112     testDir
113         .add("testob", test.dir)
114         .doc("Example of an instance directory");
115
116     senf::console::Server::start( senf::INet4SocketAddress(23232u) )
117         .name("testServer");
118
119     senf::Scheduler::instance().process();
120 }
121
122 \f
123 // Local Variables:
124 // mode: c++
125 // fill-column: 100
126 // comment-column: 40
127 // c-file-style: "senf"
128 // indent-tabs-mode: nil
129 // ispell-local-dictionary: "american"
130 // compile-command: "scons -U testServer"
131 // End: