MNTCPSocket.h

Go to the documentation of this file.

/* Copyright (C) 2000 KOM/Darmstadt University of Technology
 *
 * You are allowed to use all other parts of the code under the following terms:
 *
 * For non-commercial use, code may be used in unmodified form provided
 * that this copyright notice and this permission notice appear in
 * supporting documentation.
 *
 * This software is provided "as is" and without any express or implied
 * warranties, including, without limitation, the implied warranty of
 * fitness for a particular purpose.
 *
 * The code may be subjected to the GNU General Public License, Version 2,
 * and re-distributed under the terms of this license.
 * As a special exception, permission is granted to link this code
 * with the Qt library and distribute executables, as long as you
 * follow the requirements of the GNU GPL in regard to all of the
 * software in the executable aside from Qt.
 *
 * Commercial use other than under the terms of the GNU General Public
 * License is allowed only after express negotiation of conditions
 * with the authors.
 */
#ifndef MN_TCPSOCKET_H
#define MN_TCPSOCKET_H

/***********************************************************************
 * MNTCPSocket
 *
 * The base class for all TCP sockets.
 * It does not implement any data reception functionality. This must
 * be implemented by the base classes by overloading callback().
 *
 * The functions reader() and set_buffers() are deprecated and will
 * be removed soon.
 *
 * The constructors are semantically inconsistent and need a major
 * revision.
 ***********************************************************************/


#include "MNSocket.h"
#include <sys/uio.h>
#include <sys/socket.h>
#include <netdb.h>
#include <netinet/in.h>

class MNSelector;

class MNTCPSocket : public MNSocket
{
public:
    enum CreationMode
    {
        MakeNow
    };

    enum Fail
    {
        Ok     = 0,
        Errno  = -1,
        Herrno = -2
    };
protected:
    void show_buffers (struct iovec *iov );

private:
    MNTCPSocket& operator=( const MNTCPSocket& );
    MNTCPSocket( const MNTCPSocket& );
public:
    MNTCPSocket ( );
    MNTCPSocket ( int i );
    MNTCPSocket ( int i, CreationMode mode );

    virtual ~MNTCPSocket ( );

    void warn_errors ( int errval );

    virtual void  callback( MNSelector* select, int fd ) = 0;
    virtual void tcallback() { };  /* needed for thread exit */
    
    inline virtual bool isUdp() const {return false;}

    virtual Fail connect( int port, const char *hostname );

    virtual Fail connect( const struct sockaddr_in& dest );

    int  read( char* buffer, int len );
    int  write( const char* buf, int len );

    bool getLocalSockAddr( struct sockaddr_in& addr );

    bool getRemoteSockAddr( struct sockaddr_in& addr );
};

/***********************************************************************
 * MNTCPClientSocket
 *
 * MNTCPClientSocket is a helper class to open and manage TCP sockets
 * consistently although other mechanisms are used for the actual
 * interaction with the socket. It may be used to keep a socket open
 * until its management is taken over by another class.
 *
 * Note that a standard TCPServerSocket receiver will add an object of
 * this class to its MNSelector in a standard callback() function. If
 * the user of this class does not suppress this, it will crash the
 * program.
 *
 * Write functions of this class may be used but read() functions of
 * this class are not operational.
 ***********************************************************************/


class MNTCPClientSocket : public MNTCPSocket
{
public:
    MNTCPClientSocket( )
    { }
    MNTCPClientSocket( int lsocket ) : MNTCPSocket( lsocket )
    { }

    virtual void  callback ( MNSelector* /*select*/, int /*fd*/ )
    {
       MN_FATAL("callback() not implemented for MNTCPClientSocket");
    }

private:
    virtual int reader ( struct iovec* /*iov*/ )
    {
        MN_FATAL("reader() not implemented for MNTCPClientSocket");
        return 0;
    }

    virtual void set_buffers ( struct iovec* /*iov*/, int /*iovlen*/ )
    {
        MN_FATAL("set_buffers() not implemented for MNTCPClientSocket");
    }
};

#endif /* MN_TCPSOCKET_H */

---