developer.intra2net.com Git - libt2n/blob - src/connection.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_CONNECTION
  20 #define __LIBT2N_CONNECTION
  21
  22 #include <string>
  23 #include <vector>
  24 #include <list>
  25 #include <iostream>
  26
  27 #include <boost/function.hpp>
  28
  29 #include <netinet/in.h>
  30
  31 #include "types.hxx"
  32
  33 namespace libt2n
  34 {
  35
  36 /** @brief a connection between client and server. abstact.
  37 */
  38 class connection
  39 {
  40     private:
  41         bool closed;
  42
  43         /// vector initialized for all callback-types, all elements in each list will be called
  44         std::vector<std::list<boost::function<void ()> > > callbacks;
  45
  46     protected:
  47         connection()
  48             : callbacks(__events_end), closed(false)
  49             { }
  50
  51         std::string buffer;
  52
  53         typedef uint32_t packet_size_indicator;
  54
  55         packet_size_indicator bytes_available();
  56
  57         virtual void real_write(const std::string& data)=0;
  58
  59         virtual std::ostream* get_logstream(log_level_values level)=0;
  60
  61         void do_callbacks(callback_event_type event);
  62
  63         void reopen(void);
  64         void remove_incomplete_packets();
  65
  66     public:
  67         virtual ~connection();
  68
  69         /// is this connection closed or not
  70         bool is_closed()
  71             { return closed; }
  72
  73         /// close this connection
  74         virtual void close();
  75
  76         /** @brief look for new data and store it in the local buffer
  77             @param usec_timeout wait until new data is found, max timeout usecs.
  78                   -1: wait endless
  79                    0: return instantly
  80             @param usec_timeout_remaining if non-NULL the function will write the
  81                   not used time to the given target
  82             @retval true if new data was found (does not mean that the received data
  83                     is a complete packet though)
  84         */
  85         virtual bool fill_buffer(long long usec_timeout=-1,long long* usec_timeout_remaining=NULL)=0;
  86
  87         bool get_packet(std::string& data);
  88
  89         unsigned int peek_packet(std::string& data);
  90
  91         /// returns true if a complete data packet is in the buffer. retrieve it with get_packet().
  92         bool packet_available()
  93             { return bytes_available(); }
  94
  95         void write(const std::string& data);
  96
  97         void add_callback(callback_event_type event, const boost::function<void ()>& func);
  98
  99         std::list<boost::function<void ()> > get_callback_list(callback_event_type event);
 100 };
 101
 102 }
 103
 104 #endif