kclientsocketbase.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 KCLIENTSOCKETBASE_H
#define KCLIENTSOCKETBASE_H
 
#include <tqobject.h>
#include <tqstring.h>
 
#include "tdesocketbase.h"
#include "kresolver.h"
#include <tdelibs_export.h>
 
namespace KNetwork {
 
class KClientSocketBasePrivate;
class TDECORE_EXPORT KClientSocketBase : public TQObject, public KActiveSocketBase
{
  TQ_OBJECT
  
 
public:
  enum SocketState
  {
    Idle,
    HostLookup,
    HostFound,
    Bound,
    Connecting,
    Open,
    Closing,
 
    Unconnected = Bound,
    Connected = Open,
    Connection = Open
  };
 
public:
  KClientSocketBase(TQObject* parent, const char *name);

  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 TQString& node = TQString::null,
            const TQString& service = TQString::null) = 0;

  virtual bool bind(const KResolverEntry& address);

  virtual bool connect(const TQString& node = TQString::null,
               const TQString& service = TQString::null) = 0;

  virtual bool connect(const KResolverEntry& address);

  inline void connectToHost(const TQString& host, TQ_UINT16 port)
  { connect(host, TQString::number(port)); }

  virtual bool disconnect();

  virtual inline bool open(int)
  { return connect(); }

  virtual void close();

  virtual void flush()
  { }

  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;

  bool emitsReadyRead() const;

  virtual void enableRead(bool enable);

  bool emitsReadyWrite() const;

  virtual void enableWrite(bool enable);
 
protected slots:
  // protected slots

  virtual void slotReadActivity();

  virtual void slotWriteActivity();
 
private slots:
  void lookupFinishedSlot();
 
signals:
  void stateChanged(int newstate);

  void gotError(int code);

  void hostFound();

  void bound(const KResolverEntry& local);

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

  void connected(const KResolverEntry& remote);

  void closed();

  void readyRead();

  void readyWrite();
 
protected:
  void setState(SocketState state);

  virtual void stateChanging(SocketState newState);

  void copyError();
 
private:
  KClientSocketBase(const KClientSocketBase&);
  KClientSocketBase& operator=(const KClientSocketBase&);
 
  KClientSocketBasePrivate *d;
};
 
}               // namespace KNetwork
 
#endif