k3clientsocketbase.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 KCLIENTSOCKETBASE_H
#define KCLIENTSOCKETBASE_H

#include <QtCore/QObject>
#include <QtCore/QString>

#include <kdecore_export.h>
#include "k3socketbase.h"
#include "k3resolver.h"

namespace KNetwork {

class KClientSocketBasePrivate;
class KDECORE_EXPORT KClientSocketBase : public KActiveSocketBase
{
  Q_OBJECT

public:
  enum SocketState
  {
    Idle,
    HostLookup,
    HostFound,
    Bound,
    Connecting,
    Open,
    Closing,

    Unconnected = Bound,
    Connected = Open,
    Connection = Open
  };

public:
  KClientSocketBase(QObject* parent);

  virtual ~KClientSocketBase();

  SocketState state() const;

protected:
  virtual bool setSocketOptions(int opts);

public:
  KResolver& peerResolver() const;

  const KResolverResults& peerResults() const;

  KResolver& localResolver() const;

  const KResolverResults& localResults() const;

  void setResolutionEnabled(bool enable);

  void setFamily(int families);

  virtual bool lookup();

  virtual bool bind(const QString& node = QString(),
            const QString& service = QString()) = 0;

  virtual bool bind(const KResolverEntry& address);

  virtual bool connect(const QString& node = QString(),
               const QString& service = QString(),
               OpenMode mode = ReadWrite) = 0;

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

  virtual bool disconnect();

  virtual bool open(OpenMode mode);

  virtual void close();

  virtual bool flush();

  virtual qint64 bytesAvailable() const;

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

  virtual KSocketAddress localAddress() const;

  virtual KSocketAddress peerAddress() const;

  bool emitsReadyRead() const;

  virtual void enableRead(bool enable);

  bool emitsReadyWrite() const;

  virtual void enableWrite(bool enable);

protected Q_SLOTS:
  // protected slots

  virtual void slotReadActivity();

  virtual void slotWriteActivity();

private Q_SLOTS:
  void lookupFinishedSlot();

Q_SIGNALS:
  void stateChanged(int newstate);

  void gotError(int code);

  void hostFound();

  void bound(const KNetwork::KResolverEntry& local);

  void aboutToConnect(const KNetwork::KResolverEntry& remote, bool& skip);

  void connected(const KNetwork::KResolverEntry& remote);

  void closed();

#if 0
  // QIODevice already has this
  void readyRead();
#endif

  void readyWrite();

protected:
  virtual qint64 readData(char *data, qint64 maxlen, KSocketAddress *from);

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

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

  void setState(SocketState state);

  virtual void stateChanging(SocketState newState);

  void copyError();

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

  KClientSocketBasePrivate* const d;
};

}               // namespace KNetwork

#endif