move files common to client/server into "base"

1 files changed, 330 insertions, 0 deletions

diff --git a/src/base/QXmppJingleIq.h b/src/base/QXmppJingleIq.h
new file mode 100644
index 00000000..ef5b66ec
--- /dev/null
+++ b/src/base/QXmppJingleIq.h
@@ -0,0 +1,330 @@
+/*
+ * Copyright (C) 2008-2011 The QXmpp developers
+ *
+ * Author:
+ *  Jeremy Lainé
+ *
+ * Source:
+ *  http://code.google.com/p/qxmpp
+ *
+ * This file is a part of QXmpp library.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ */
+
+#ifndef QXMPPJINGLEIQ_H
+#define QXMPPJINGLEIQ_H
+
+#include <QHostAddress>
+
+#include "QXmppIq.h"
+
+/// \brief The QXmppJinglePayloadType class represents a payload type
+/// as specified by XEP-0167: Jingle RTP Sessions and RFC 5245.
+///
+
+class QXmppJinglePayloadType
+{
+public:
+    QXmppJinglePayloadType();
+
+    unsigned char channels() const;
+    void setChannels(unsigned char channels);
+
+    unsigned int clockrate() const;
+    void setClockrate(unsigned int clockrate);
+
+    unsigned char id() const;
+    void setId(unsigned char id);
+
+    unsigned int maxptime() const;
+    void setMaxptime(unsigned int maxptime);
+
+    QString name() const;
+    void setName(const QString &name);
+
+    QMap<QString, QString> parameters() const;
+    void setParameters(const QMap<QString, QString> &parameters);
+
+    unsigned int ptime() const;
+    void setPtime(unsigned int ptime);
+
+    /// \cond
+    void parse(const QDomElement &element);
+    void toXml(QXmlStreamWriter *writer) const;
+    /// \endcond
+
+    bool operator==(const QXmppJinglePayloadType &other) const;
+
+private:
+    unsigned char m_channels;
+    unsigned int m_clockrate;
+    unsigned char m_id;
+    unsigned int m_maxptime;
+    QString m_name;
+    QMap<QString, QString> m_parameters;
+    unsigned int m_ptime;
+};
+
+/// \brief The QXmppJingleCandidate class represents a transport candidate
+/// as specified by XEP-0176: Jingle ICE-UDP Transport Method.
+///
+
+class QXmppJingleCandidate
+{
+public:
+    /// This enum is used to describe a candidate's type.
+    enum Type
+    {
+        HostType,               ///< Host candidate, a local address/port.
+        PeerReflexiveType,      ///< Peer-reflexive candidate,
+                                ///< the address/port as seen from the peer.
+        ServerReflexiveType,    ///< Server-reflexive candidate,
+                                ///< the address/port as seen by the STUN server
+        RelayedType,            ///< Relayed candidate, a candidate from
+                                ///< a TURN relay.
+    };
+
+    QXmppJingleCandidate();
+
+    int component() const;
+    void setComponent(int component);
+
+    int foundation() const;
+    void setFoundation(int foundation);
+
+    QHostAddress host() const;
+    void setHost(const QHostAddress &host);
+
+    QString id() const;
+    void setId(const QString &id);
+
+    int network() const;
+    void setNetwork(int network);
+
+    quint16 port() const;
+    void setPort(quint16 port);
+
+    int priority() const;
+    void setPriority(int priority);
+
+    QString protocol() const;
+    void setProtocol(const QString &protocol);
+
+    QXmppJingleCandidate::Type type() const;
+    void setType(QXmppJingleCandidate::Type);
+
+    bool isNull() const;
+
+    static QXmppJingleCandidate::Type typeFromString(const QString &typeStr, bool *ok = 0);
+    static QString typeToString(QXmppJingleCandidate::Type type);
+
+    /// \cond
+    void parse(const QDomElement &element);
+    void toXml(QXmlStreamWriter *writer) const;
+    /// \endcond
+
+private:
+    int m_component;
+    int m_foundation;
+    int m_generation;
+    QHostAddress m_host;
+    QString m_id;
+    int m_network;
+    quint16 m_port;
+    QString m_protocol;
+    int m_priority;
+    QXmppJingleCandidate::Type m_type;
+};
+
+/// \brief The QXmppJingleIq class represents an IQ used for initiating media
+/// sessions as specified by XEP-0166: Jingle.
+///
+/// \ingroup Stanzas
+
+class QXmppJingleIq : public QXmppIq
+{
+public:
+    /// This enum is used to describe a Jingle action.
+    enum Action {
+        ContentAccept,
+        ContentAdd,
+        ContentModify,
+        ContentReject,
+        ContentRemove,
+        DescriptionInfo,
+        SecurityInfo,
+        SessionAccept,
+        SessionInfo,
+        SessionInitiate,
+        SessionTerminate,
+        TransportAccept,
+        TransportInfo,
+        TransportReject,
+        TransportReplace,
+    };
+
+    /// \internal
+    ///
+    /// The QXmppJingleIq::Content class represents the "content" element of a
+    /// QXmppJingleIq.
+
+    class Content
+    {
+    public:
+        Content();
+
+        QString creator() const;
+        void setCreator(const QString &creator);
+
+        QString name() const;
+        void setName(const QString &name);
+
+        QString senders() const;
+        void setSenders(const QString &senders);
+
+        // XEP-0167: Jingle RTP Sessions
+        QString descriptionMedia() const;
+        void setDescriptionMedia(const QString &media);
+
+        void addPayloadType(const QXmppJinglePayloadType &payload);
+        QList<QXmppJinglePayloadType> payloadTypes() const;
+        void setPayloadTypes(const QList<QXmppJinglePayloadType> &payloadTypes);
+
+        void addTransportCandidate(const QXmppJingleCandidate &candidate);
+        QList<QXmppJingleCandidate> transportCandidates() const;
+
+        QString transportUser() const;
+        void setTransportUser(const QString &user);
+
+        QString transportPassword() const;
+        void setTransportPassword(const QString &password);
+
+        /// \cond
+        void parse(const QDomElement &element);
+        void toXml(QXmlStreamWriter *writer) const;
+        /// \endcond
+
+    private:
+        QString m_creator;
+        QString m_disposition;
+        QString m_name;
+        QString m_senders;
+
+        QString m_descriptionMedia;
+        QString m_descriptionType;
+        QString m_transportType;
+        QString m_transportUser;
+        QString m_transportPassword;
+        QList<QXmppJinglePayloadType> m_payloadTypes;
+        QList<QXmppJingleCandidate> m_transportCandidates;
+    };
+
+    /// \internal
+    ///
+    /// The QXmppJingleIq::Reason class represents the "reason" element of a
+    /// QXmppJingleIq.
+
+    class Reason
+    {
+    public:
+        enum Type {
+            None,
+            AlternativeSession,
+            Busy,
+            Cancel,
+            ConnectivityError,
+            Decline,
+            Expired,
+            FailedApplication,
+            FailedTransport,
+            GeneralError,
+            Gone,
+            IncompatibleParameters,
+            MediaError,
+            SecurityError,
+            Success,
+            Timeout,
+            UnsupportedApplications,
+            UnsupportedTransports,
+        };
+
+        Reason();
+
+        QString text() const;
+        void setText(const QString &text);
+
+        Type type() const;
+        void setType(Type type);
+
+        /// \cond
+        void parse(const QDomElement &element);
+        void toXml(QXmlStreamWriter *writer) const;
+        /// \endcond
+
+    private:
+        QString m_text;
+        Type m_type;
+    };
+
+    QXmppJingleIq();
+
+    Action action() const;
+    void setAction(Action action);
+
+    QString initiator() const;
+    void setInitiator(const QString &initiator);
+
+    QString responder() const;
+    void setResponder(const QString &responder);
+
+    QString sid() const;
+    void setSid(const QString &sid);
+
+    /// Returns a reference to the IQ's content element.
+    Content& content() { return m_content; };
+
+    /// Returns a const reference to the IQ's content element.
+    const Content& content() const { return m_content; };
+
+    /// Returns a reference to the IQ's reason element.
+    Reason& reason() { return m_reason; };
+
+    /// Returns a const reference to the IQ's reason element.
+    const Reason& reason() const { return m_reason; };
+
+    // XEP-0167: Jingle RTP Sessions
+    bool ringing() const;
+    void setRinging(bool ringing);
+
+    /// \cond
+    static bool isJingleIq(const QDomElement &element);
+    /// \endcond
+
+protected:
+    /// \cond
+    void parseElementFromChild(const QDomElement &element);
+    void toXmlElementFromChild(QXmlStreamWriter *writer) const;
+    /// \endcond
+
+private:
+    Action m_action;
+    QString m_initiator;
+    QString m_responder;
+    QString m_sid;
+
+    Content m_content;
+    Reason m_reason;
+    bool m_ringing;
+};
+
+#endif