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
  24 #include <netinet/in.h>
  25
  26 #include "types.hxx"
  27
  28 namespace libt2n
  29 {
  30
  31 /** @brief a connection between client and server. abstact.
  32 */
  33 class connection
  34 {
  35     private:
  36         bool closed;
  37
  38     protected:
  39         connection()
  40             { closed=false; }
  41
  42         std::string buffer;
  43
  44         typedef uint32_t packet_size_indicator;
  45
  46         packet_size_indicator bytes_available();
  47
  48         virtual void real_write(const std::string& data)=0;
  49
  50         virtual std::ostream* get_logstream(log_level_values level)=0;
  51
  52     public:
  53         virtual ~connection()
  54             { close(); }
  55
  56         /// is this connection closed or not
  57         bool is_closed()
  58             { return closed; }
  59
  60         /// close this connection
  61         virtual void close()
  62             { closed=true; }
  63
  64         /** @brief look for new data and store it in the local buffer
  65             @param usec_timeout wait until new data is found, max timeout usecs.
  66                   -1: wait endless
  67                    0: return instantly
  68             @param usec_timeout_remaining if non-NULL the function will write the
  69                   not used time to the given target
  70             @retval true if new data was found (does not mean that the received data
  71                     is a complete packet though)
  72         */
  73         virtual bool fill_buffer(long long usec_timeout=-1,long long* usec_timeout_remaining=NULL)=0;
  74
  75         bool get_packet(std::string& data);
  76
  77         unsigned int peek_packet(std::string& data);
  78
  79         /// returns true if a complete data packet is in the buffer. retrieve it with get_packet().
  80         bool packet_available()
  81             { return bytes_available(); }
  82
  83         void write(const std::string& data);
  84 };
  85
  86 }
  87
  88 #endif