k3datagramsocket.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 KDATAGRAMSOCKET_H
#define KDATAGRAMSOCKET_H

#include <QtCore/QByteArray>

#include "k3socketaddress.h"
#include "k3clientsocketbase.h"

namespace KNetwork {

class KResolverEntry;

class KDECORE_EXPORT KDatagramPacket //krazy:exclude=dpointer,inline (lightweight; kde3)
{
  QByteArray m_data;
  KSocketAddress m_address;

public:
  KDatagramPacket()
  { }

  explicit KDatagramPacket(const QByteArray& content)
    : m_data(content)
  { }

  KDatagramPacket(const char* content, uint length)
  { setData(content, length); }

  KDatagramPacket(const QByteArray& content, const KSocketAddress& addr)
    : m_data(content), m_address(addr)
  { }

  KDatagramPacket(const char *content, uint length, const KSocketAddress& addr)
    : m_address(addr)
  { setData(content, length); }

  KDatagramPacket(const KDatagramPacket& other)
  { *this = other; }

  ~KDatagramPacket()
  { }

  const QByteArray& data() const
  { return m_data; }

  uint length() const
  { return m_data.size(); }

  uint size() const
  { return m_data.size(); }

  bool isEmpty() const
  { return m_data.isEmpty(); }

  bool isNull() const
  { return m_data.isNull(); }

  const KSocketAddress& address() const
  { return m_address; }

  void setAddress(const KSocketAddress& addr)
  { m_address = addr; }

  void detach()
  { m_data.detach(); }

  void setData(const QByteArray& data)
  { m_data = data; }

  void setData(const char* data, uint length)
  { m_data = QByteArray(data, length); }
};

class KDatagramSocketPrivate;
class KDECORE_EXPORT KDatagramSocket: public KClientSocketBase
{
  Q_OBJECT

public:
  KDatagramSocket(QObject* parent = 0L);

  virtual ~KDatagramSocket();

  //  virtual bool lookup();

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

  virtual bool bind(const KResolverEntry& entry);

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

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

  virtual KDatagramPacket receive();

  virtual qint64 send(const KDatagramPacket& packet);

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

private Q_SLOTS:
  void lookupFinishedLocal();
  void lookupFinishedPeer();

private:
  bool doBind();
  void setupSignals();

  KDatagramSocketPrivate* const d;
};

}               // namespace KNetwork

#endif