tcpsocket.h

Go to the documentation of this file.

/*
    
  This file is a part of ENUt, a library containing network
  programming utilities.
  
  Copyright (C) 2006-2008  Hasselt University - Expertise Centre for
                      Digital Media (EDM) (http://www.edm.uhasselt.be)

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  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 library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  
  USA

*/

#ifndef NUT_TCPSOCKET_H

#define NUT_TCPSOCKET_H

#include "nutconfig.h"
#include "nuttypes.h"
#include "socket.h"
#include "networklayeraddress.h"

namespace nut
{

class ENUT_IMPORTEXPORT TCPSocket : public Socket
{
protected:
        TCPSocket(NetworkLayerProtocol proto)                                           { m_protocol = proto; }
        TCPSocket(const std::string &objName, NetworkLayerProtocol proto) : Socket(objName)
                                                                                        { m_protocol = proto; }
public:
        virtual ~TCPSocket()                                                            { }

        NetworkLayerProtocol getProtocol() const                                        { return m_protocol; }

        virtual bool create(uint16_t portNumber = 0) = 0;

        virtual bool create(const NetworkLayerAddress &bindAddress, uint16_t portNumber = 0) = 0;

        virtual bool destroy() = 0;

        virtual bool setNonBlocking(bool f = true) = 0;
        
        virtual uint16_t getLocalPortNumber() = 0;

        virtual bool connect(const NetworkLayerAddress &hostAddress, uint16_t portNumber) = 0;

        virtual bool listen(int backlog) = 0;

        virtual bool accept(TCPSocket **pNewSock) = 0;

        virtual bool isConnected() = 0;
        
        virtual const NetworkLayerAddress *getDestinationAddress() const = 0;

        virtual uint16_t getDestinationPort() const = 0;
        
        virtual bool write(const void *pData, size_t &length) = 0;

        virtual bool getAvailableDataLength(size_t &length) = 0;

        virtual bool read(void *pBuffer, size_t &bufferSize) = 0;
private:
        NetworkLayerProtocol m_protocol;

        friend class TCPPacketSocket;
};

}

#endif // NUT_TCPSOCKET_H