developer.intra2net.com Git - libt2n/blob - src/server.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_SERVER
  20 #define __LIBT2N_SERVER
  21
  22 #include <iostream>
  23 #include <string>
  24 #include <map>
  25 #include <vector>
  26 #include <list>
  27
  28 #include <boost/function.hpp>
  29
  30 #include "connection.hxx"
  31 #include "types.hxx"
  32
  33 namespace libt2n
  34 {
  35
  36 class server;
  37
  38 /**
  39     @brief connection on a server
  40
  41     on a server every connection to a client is represented as server_connection.
  42     a server_connection is abstract, derived classes like socket_server_connection are used.
  43 */
  44 class server_connection : public connection
  45 {
  46     friend class server;
  47
  48     private:
  49         int timeout;
  50         int last_action_time;
  51         unsigned int connection_id;
  52
  53         void set_server(server* _my_server)
  54             { my_server=_my_server; }
  55
  56         void set_id(unsigned int _connection_id)
  57             { connection_id=_connection_id; }
  58
  59         /// vector initialized for all callback-types, all elements in each list will be called
  60         std::vector<std::list<boost::function<void ()> > > callbacks;
  61
  62     protected:
  63         server *my_server;
  64
  65         server_connection(int _timeout);
  66
  67         std::ostream* get_logstream(log_level_values level);
  68
  69         void do_callbacks(callback_event_type event);
  70
  71     public:
  72         virtual ~server_connection();
  73
  74         void check_timeout();
  75         void reset_timeout();
  76         void set_timeout(int _timeout)
  77             { timeout=_timeout; }
  78
  79         /// get the id of this connection within the server object
  80         unsigned int get_id()
  81             { return connection_id; }
  82
  83         void close();
  84
  85         void add_callback(callback_event_type event, const boost::function<void ()>& func);
  86 };
  87
  88 /**
  89     @brief server base class
  90
  91     constitutes a server. is abstract, use derived classes like socket_server.
  92 */
  93 class server
  94 {
  95     private:
  96         int default_timeout;
  97         log_level_values log_level;
  98         std::ostream *logstream;
  99
 100         /// vector initialized for all callback-types, all elements in each list will be called
 101         std::vector<std::list<boost::function<void (unsigned int)> > > callbacks;
 102
 103         unsigned int next_id;
 104
 105     protected:
 106         std::map<unsigned int, server_connection*> connections;
 107
 108         server();
 109
 110         virtual bool fill_connection_buffers(void)=0;
 111
 112         int add_connection(server_connection* newconn);
 113
 114         void do_callbacks(callback_event_type event, unsigned int conn_id);
 115
 116     public:
 117         virtual ~server();
 118
 119         /// set the default timeout for new client connections
 120         void set_default_timeout(int _default_timeout)
 121             { default_timeout=_default_timeout; }
 122
 123         /// get the current default timeout for client connections
 124         int get_default_timeout(void)
 125             { return default_timeout; }
 126
 127         void set_logging(std::ostream *_logstream, log_level_values _log_level);
 128
 129         server_connection* get_connection(unsigned int conn_id);
 130
 131         void add_callback(callback_event_type event, const boost::function<void (unsigned int)>& func);
 132
 133         /** @brief look for new data and store it in the local buffer
 134             @param usec_timeout wait until new data is found, max timeout usecs.
 135                   -1: wait endless
 136                    0: return instantly
 137             @param usec_timeout_remaining if non-NULL the function will write the
 138                   not used time to the given target
 139             @retval true if new data was found (does not mean that the received data
 140                     is a complete packet though)
 141         */
 142         virtual bool fill_buffer(long long usec_timeout=-1, long long* timeout_remaining=NULL)=0;
 143
 144         void cleanup();
 145
 146         /** @brief get a complete data packet from any client. The packet is removed from the
 147                    connection buffer.
 148             @param[out] data the data package
 149             @retval true if packet found
 150         */
 151         bool get_packet(std::string& data)
 152             { unsigned int x; return get_packet(data,x); }
 153
 154         bool get_packet(std::string& data, unsigned int& conn_id);
 155
 156         std::ostream* get_logstream(log_level_values level);
 157 };
 158
 159 }
 160
 161 #endif