k3socketdevice.h

Go to the documentation of this file.

/*  -*- C++ -*-
 *  Copyright (C) 2003,2005 Thiago Macieira <thiago@kde.org>
 *
 *
 *  Permission is hereby granted, free of charge, to any person obtaining
 *  a copy of this software and associated documentation files (the
 *  "Software"), to deal in the Software without restriction, including
 *  without limitation the rights to use, copy, modify, merge, publish,
 *  distribute, sublicense, and/or sell copies of the Software, and to
 *  permit persons to whom the Software is furnished to do so, subject to
 *  the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included 
 *  in all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef KSOCKETDEVICE_H
#define KSOCKETDEVICE_H

#include <QtCore/QSocketNotifier>
#include "k3socketbase.h"

namespace KNetwork {

class KSocketDevice;
class KSocketDeviceFactoryBase;

class KSocketDevicePrivate;
class KDECORE_EXPORT KSocketDevice: public KActiveSocketBase, public KPassiveSocketBase
{
public:
  enum Capabilities
    {
      CanConnectString = 0x01,

      CanBindString = 0x02,

      CanNotBind = 0x04,

      CanNotListen = 0x08,

      CanMulticast = 0x10,

      CanNotUseDatagrams = 0x20
    };
protected:
  int m_sockfd;

public:
  explicit KSocketDevice(const KSocketBase* = 0L, QObject* objparent = 0L);

  explicit KSocketDevice(int fd, OpenMode mode = ReadWrite);

  KSocketDevice(QObject* parent);

  virtual ~KSocketDevice();

  int socket() const;

  virtual int capabilities() const;

  virtual bool setSocketOptions(int opts);

  virtual void close();

  virtual bool flush();

  virtual bool create(int family, int type, int protocol);

  bool create(const KResolverEntry& address);

  virtual bool bind(const KResolverEntry& address);

  virtual bool listen(int backlog = 5); // 5 is arbitrary

  virtual bool connect(const KResolverEntry& address, 
               OpenMode mode = ReadWrite);

  virtual KSocketDevice* accept();

  virtual bool disconnect();

  virtual qint64 bytesAvailable() const;

  virtual qint64 waitForMore(int msecs, bool *timeout = 0L);

  virtual KSocketAddress localAddress() const;

  virtual KSocketAddress peerAddress() const;

  virtual KSocketAddress externalAddress() const;

  QSocketNotifier* readNotifier() const;

  QSocketNotifier* writeNotifier() const;

  QSocketNotifier* exceptionNotifier() const;

  virtual qint64 readData(char *data, qint64 maxlen, KSocketAddress* from = 0L);

  virtual qint64 peekData(char *data, qint64 maxlen, KSocketAddress* from = 0L);

  virtual qint64 writeData(const char *data, qint64 len, 
               const KSocketAddress* to = 0L);

  virtual bool poll(bool* input, bool* output, bool* exception = 0L,
            int timeout = -1, bool* timedout = 0L);

  bool poll(int timeout = -1, bool* timedout = 0L);

protected:
  explicit KSocketDevice(bool, const KSocketBase* parent = 0L);

  virtual QSocketNotifier* createNotifier(QSocketNotifier::Type type) const;

public:
  static KSocketDevice* createDefault(KSocketBase* parent);

  static KSocketDevice* createDefault(KSocketBase* parent, int capabilities);

  static KSocketDeviceFactoryBase* setDefaultImpl(KSocketDeviceFactoryBase* factory);

  static void addNewImpl(KSocketDeviceFactoryBase* factory, int capabilities);

private:
  KSocketDevice(const KSocketDevice&);
  KSocketDevice& operator=(const KSocketDevice&);

  KSocketDevicePrivate* const d;
};

class KSocketDeviceFactoryBase
{
public:
  KSocketDeviceFactoryBase() {}
  virtual ~KSocketDeviceFactoryBase() {}

  virtual KSocketDevice* create(KSocketBase*) const = 0;
};

template<class Impl>
class KSocketDeviceFactory: public KSocketDeviceFactoryBase
{
public:
  KSocketDeviceFactory() {}
  virtual ~KSocketDeviceFactory() {}

  virtual KSocketDevice* create(KSocketBase* parent) const
  { return new Impl(parent); }
};

}               // namespaces

#endif