libt2n: (gerd) improve docu, cleanup for public release
[libt2n] / src / client.hxx
1 /***************************************************************************
2  *   Copyright (C) 2006 by Gerd v. Egidy                                   *
3  *   gve@intra2net.com                                                     *
4  *                                                                         *
5  *   This library is free software; you can redistribute it and/or modify  *
6  *   it under the terms of the GNU Lesser General Public License version   *
7  *   2.1 as published by the Free Software Foundation.                     *
8  *                                                                         *
9  *   This library is distributed in the hope that it will be useful,       *
10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
12  *   GNU Lesser General Public License for more details.                   *
13  *                                                                         *
14  *   You should have received a copy of the GNU Lesser General Public      *
15  *   License along with this program; if not, write to the                 *
16  *   Free Software Foundation, Inc.,                                       *
17  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
18  ***************************************************************************/
19 #ifndef __LIBT2N_CLIENT
20 #define __LIBT2N_CLIENT
21
22 #include <string>
23 #include <vector>
24 #include <list>
25
26 #include <boost/function.hpp>
27
28 #include "connection.hxx"
29 #include "types.hxx"
30
31 namespace libt2n
32 {
33
34 /** @brief a (generic) connection from client to server. Abstract.
35  */
36 class client_connection : public connection
37 {
38     private:
39         log_level_values log_level;
40         std::ostream *logstream;
41
42         /// vector initialized for all callback-types, all elements in each list will be called
43         std::vector<std::list<boost::function<void ()> > > callbacks;
44
45     protected:
46         void do_callbacks(callback_event_type event);
47
48     public:
49         client_connection();
50
51         virtual ~client_connection();
52
53         void close();
54
55         void set_logging(std::ostream *_logstream, log_level_values _log_level);
56
57         std::ostream* get_logstream(log_level_values level);
58
59         void add_callback(callback_event_type event, const boost::function<void ()>& func);
60 };
61
62 }
63
64 #endif