tdesocketdevice.h

/*
 *  Copyright (C) 2003 Thiago Macieira <thiago.macieira@kdemail.net>
 *
 *
 *  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 TDESOCKETDEVICE_H
#define TDESOCKETDEVICE_H
 
#include <tqsocketnotifier.h>
#include "tdesocketbase.h"
 
namespace KNetwork {
 
class TDESocketDevice;
class TDESocketDeviceFactoryBase;
 
class TDESocketDevicePrivate;
class TDECORE_EXPORT TDESocketDevice: 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 TDESocketDevice(const TDESocketBase* = 0L);

  explicit TDESocketDevice(int fd);

  virtual ~TDESocketDevice();

  inline int socket() const
  { return m_sockfd; }

  virtual int capabilities() const
  { return 0; }

  virtual bool setSocketOptions(int opts);

  virtual bool open(int mode);

  virtual void close();

  virtual void 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);

  virtual TDESocketDevice* accept();

  virtual bool disconnect();

  virtual TQ_LONG bytesAvailable() const;

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

  virtual TQ_LONG readBlock(char *data, TQ_ULONG maxlen);

  virtual TQ_LONG readBlock(char *data, TQ_ULONG maxlen, TDESocketAddress& from);

  virtual TQ_LONG peekBlock(char *data, TQ_ULONG maxlen);

  virtual TQ_LONG peekBlock(char *data, TQ_ULONG maxlen, TDESocketAddress& from);

  virtual TQ_LONG writeBlock(const char *data, TQ_ULONG len);

  virtual TQ_LONG writeBlock(const char *data, TQ_ULONG len, const TDESocketAddress& to);

  virtual TDESocketAddress localAddress() const;

  virtual TDESocketAddress peerAddress() const;

  virtual TDESocketAddress externalAddress() const;

  TQSocketNotifier* readNotifier() const;

  TQSocketNotifier* writeNotifier() const;

  TQSocketNotifier* exceptionNotifier() const;

  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:
  TDESocketDevice(bool, const TDESocketBase* parent = 0L);

  virtual TQSocketNotifier* createNotifier(TQSocketNotifier::Type type) const;
 
public:
  static TDESocketDevice* createDefault(TDESocketBase* parent);

  static TDESocketDevice* createDefault(TDESocketBase* parent, int capabilities);

  static TDESocketDeviceFactoryBase* setDefaultImpl(TDESocketDeviceFactoryBase* factory);

  static void addNewImpl(TDESocketDeviceFactoryBase* factory, int capabilities);
 
private:
  TDESocketDevice(const TDESocketDevice&);
  TDESocketDevice& operator=(const TDESocketDevice&);
 
  TDESocketDevicePrivate *d;
};

class TDESocketDeviceFactoryBase
{
public:
  TDESocketDeviceFactoryBase() {}
  virtual ~TDESocketDeviceFactoryBase() {}
 
  virtual TDESocketDevice* create(TDESocketBase*) const = 0;
};

template<class Impl>
class TDESocketDeviceFactory: public TDESocketDeviceFactoryBase
{
public:
  TDESocketDeviceFactory() {}
  virtual ~TDESocketDeviceFactory() {}
 
  virtual TDESocketDevice* create(TDESocketBase* parent) const
  { return new Impl(parent); }
};
 
}               // namespaces
 
#endif