kbufferedsocket.h

/*
 *  Copyright (C) 2003 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 <tqobject.h>
#include <tqcstring.h>
#include <tqvaluelist.h>
#include "kstreamsocket.h"
#include <tdelibs_export.h>
 
class TDEIOBufferBase;
 
namespace KNetwork {
 
class TDEBufferedSocketPrivate;
class TDECORE_EXPORT TDEBufferedSocket: public KStreamSocket
{
  TQ_OBJECT
  
public:
  TDEBufferedSocket(const TQString& node = TQString::null, const TQString& service = TQString::null,
          TQObject* parent = 0L, const char *name = 0L);

  virtual ~TDEBufferedSocket();

  virtual void setSocketDevice(TDESocketDevice* device);
 
protected:
  virtual bool setSocketOptions(int opts);
 
public:
  virtual void close();

  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 void enableRead(bool enable);

  virtual void enableWrite(bool enable);

  void setInputBuffering(bool enable);

  TDEIOBufferBase* inputBuffer();

  void setOutputBuffering(bool enable);

  TDEIOBufferBase* outputBuffer();

  virtual TQ_ULONG bytesToWrite() const;

  virtual void closeNow();

  bool canReadLine() const;

  TQCString readLine();

  void waitForConnect();
 
protected:
  virtual void stateChanging(SocketState newState);
 
protected slots:
  virtual void slotReadActivity();

  virtual void slotWriteActivity();
 
signals:
  void bytesWritten(int bytes);
 
private:
  TDEBufferedSocket(const TDEBufferedSocket&);
  TDEBufferedSocket& operator=(const TDEBufferedSocket&);
 
  TDEBufferedSocketPrivate *d;
 
public:
  // KDE4: remove this function
  inline void reset()
  { closeNow(); }
};
 
}               // namespace KNetwork
 
#endif