libt2n: (gerd) basic command handling (still some todos)

[libt2n] / src / connection.hxx

/***************************************************************************
 *   Copyright (C) 2006 by Gerd v. Egidy                                   *
 *   gve@intra2net.com                                                     *
 *                                                                         *
 *   This library is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU Lesser General Public License version   *
 *   2.1 as published by the Free Software Foundation.                     *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU Lesser General Public License for more details.                   *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this program; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef __LIBT2N_CONNECTION
#define __LIBT2N_CONNECTION

#include <string>

namespace libt2n
{

/** @brief a connection between client and server. abstact.
*/
class connection
{
    private:
        bool closed;

    protected:
        connection()
        { closed=false; }

        std::string buffer;

        typedef unsigned int packet_size_indicator;

        packet_size_indicator bytes_available();

        virtual void real_write(const std::string& data)=0;

    public:
        virtual ~connection()
            { close(); }

        /// is this connection closed or not
        bool is_closed()
            { return closed; }

        /// close this connection
        virtual void close()
            { closed=true; }

        /** @brief look for new data and store it in the local buffer
            @param usec_timeout wait until new data is found, max timeout usecs.
                  -1: wait endless
                   NULL: no timeout
            @retval true if new data was found (does not mean that the received data 
                    is a complete packet though)
        */
        virtual bool fill_buffer(long long usec_timeout=-1)=0;
        bool get_packet(std::string& data);

        /// returns true if a complete data packet is in the buffer. retrieve it with get_packet().
        bool packet_available()
            { return bytes_available(); }

        void write(const std::string& data);
};

}

#endif