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