developer.intra2net.com Git - libt2n/blob - src/server.hxx

   1 /*
   2 Copyright (C) 2006 by Intra2net AG - Gerd v. Egidy
   3
   4 The software in this package is distributed under the GNU General
   5 Public License version 2 (with a special exception described below).
   6
   7 A copy of GNU General Public License (GPL) is included in this distribution,
   8 in the file COPYING.GPL.
   9
  10 As a special exception, if other files instantiate templates or use macros
  11 or inline functions from this file, or you compile this file and link it
  12 with other works to produce a work based on this file, this file
  13 does not by itself cause the resulting work to be covered
  14 by the GNU General Public License.
  15
  16 However the source code for this file must still be made available
  17 in accordance with section (3) of the GNU General Public License.
  18
  19 This exception does not invalidate any other reasons why a work based
  20 on this file might be covered by the GNU General Public License.
  21 */
  22 #ifndef __LIBT2N_SERVER
  23 #define __LIBT2N_SERVER
  24
  25 #include <iostream>
  26 #include <string>
  27 #include <map>
  28 #include <vector>
  29 #include <list>
  30
  31 #include <boost/function.hpp>
  32
  33 #include "connection.hxx"
  34 #include "types.hxx"
  35
  36
  37 namespace libt2n
  38 {
  39
  40 class server;
  41
  42 /**
  43     @brief connection on a server
  44
  45     on a server every connection to a client is represented as server_connection.
  46     a server_connection is abstract, derived classes like socket_server_connection are used.
  47 */
  48 class server_connection : public connection
  49 {
  50     friend class server;
  51
  52     private:
  53         int timeout;
  54         int last_action_time;
  55         unsigned int connection_id;
  56
  57         void set_server(server* _my_server)
  58             { my_server=_my_server; }
  59
  60         void set_id(unsigned int _connection_id)
  61             { connection_id=_connection_id; }
  62
  63     protected:
  64         server *my_server;
  65
  66         server_connection(int _timeout);
  67         virtual ~server_connection();
  68
  69         std::ostream* get_logstream(log_level_values level);
  70
  71     public:
  72         void check_timeout();
  73         void reset_timeout();
  74         void set_timeout(int _timeout)
  75             { timeout=_timeout; }
  76
  77         /// get the id of this connection within the server object
  78         unsigned int get_id()
  79             { return connection_id; }
  80
  81         void add_callback(callback_event_type event, const boost::function<void ()>& func);
  82 };
  83
  84 /**
  85     @brief server base class
  86
  87     constitutes a server. is abstract, use derived classes like socket_server.
  88 */
  89 class server
  90 {
  91     private:
  92         int default_timeout;
  93         log_level_values log_level;
  94         std::ostream *logstream;
  95
  96         /// vector initialized for all callback-types, all elements in each list will be called
  97         std::vector<std::list<boost::function<void (unsigned int)> > > callbacks;
  98
  99         unsigned int next_id;
 100
 101     protected:
 102         std::map<unsigned int, server_connection*> connections;
 103
 104         server();
 105
 106         virtual bool fill_connection_buffers(void)=0;
 107
 108         unsigned int add_connection(server_connection* newconn);
 109
 110         void do_callbacks(callback_event_type event, unsigned int conn_id);
 111
 112     public:
 113         virtual ~server();
 114
 115         /// set the default timeout for new client connections
 116         void set_default_timeout(int _default_timeout)
 117             { default_timeout=_default_timeout; }
 118
 119         /// get the current default timeout for client connections
 120         int get_default_timeout(void)
 121             { return default_timeout; }
 122
 123         void set_logging(std::ostream *_logstream, log_level_values _log_level);
 124
 125         server_connection* get_connection(unsigned int conn_id);
 126
 127         void add_callback(callback_event_type event, const boost::function<void (unsigned int)>& func);
 128
 129         /** @brief look for new data and store it in the local buffer
 130             @param usec_timeout wait until new data is found, max timeout usecs.
 131                   -1: wait endless
 132                    0: return instantly
 133             @param usec_timeout_remaining if non-NULL the function will write the
 134                   not used time to the given target
 135             @retval true if new data was found (does not mean that the received data
 136                     is a complete packet though)
 137         */
 138         virtual bool fill_buffer(long long usec_timeout=-1, long long* usec_timeout_remaining=NULL)=0;
 139
 140         void close();
 141
 142         void cleanup();
 143
 144         /** @brief get a complete data packet from any client. The packet is removed from the
 145                    connection buffer.
 146             @param[out] data the data package
 147             @retval true if packet found
 148         */
 149         bool get_packet(std::string& data)
 150             { unsigned int x; return get_packet(data,x); }
 151
 152         bool get_packet(std::string& data, unsigned int& conn_id);
 153
 154         std::ostream* get_logstream(log_level_values level);
 155 };
 156
 157 }
 158
 159 #endif