k3bufferedsocket.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 KBUFFEREDSOCKET_H
#define KBUFFEREDSOCKET_H

#include <kdecore_export.h>
#include "k3streamsocket.h"

#include <QtCore/QObject>
#include <QtCore/QByteArray>
#include <QtCore/QList>

namespace KNetwork {

class KBufferedSocketPrivate;
class KDECORE_EXPORT KBufferedSocket: public KStreamSocket
{
  Q_OBJECT
public:
  explicit KBufferedSocket(const QString& node = QString(), const QString& service = QString(),
          QObject* parent = 0L);

  virtual ~KBufferedSocket();

  virtual void setSocketDevice(KSocketDevice* device);

protected:
  virtual bool setSocketOptions(int opts);

public:
  virtual void close();

  virtual qint64 bytesAvailable() const;

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

  virtual void enableRead(bool enable);

  virtual void enableWrite(bool enable);

  void setInputBuffering(bool enable);

  void setOutputBuffering(bool enable);

  virtual qint64 bytesToWrite() const;

  virtual void closeNow();

  virtual bool canReadLine() const;

  // KDE4: make virtual, add timeout to match the Qt4 signature
  //       and move to another class up the hierarchy
  void waitForConnect();

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

  virtual qint64 readLineData(char *data, qint64 maxSize);

  virtual void stateChanging(SocketState newState);

protected Q_SLOTS:
  virtual void slotReadActivity();

  virtual void slotWriteActivity();

#if 0
  // Already present in QIODevice
Q_SIGNALS:
  void bytesWritten(int bytes);
#endif

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

  KBufferedSocketPrivate* const d;
};

}               // namespace KNetwork

#endif