/*
 * voicecaller.h
 * Copyright (C) 2006  Remko Troncon
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 */

#ifndef VOICECALLER_H
#define VOICECALLER_H

#include <QObject>

class PsiAccount;
namespace XMPP {
    class Jid;
}

using namespace XMPP;

/**
 * \brief An abstract class for a voice call implementation.
 */
class VoiceCaller : public QObject
{
    Q_OBJECT

public:
    /**
     * \brief Base constructor.
     *
     * \param account the account to which this voice caller belongs
     */
    VoiceCaller(PsiAccount* account) : account_(account) { };

    /**
     * \brief Retrieves the account to which this voice caller belongs.
     */
    PsiAccount* account() { return account_; }

    /**
     * \brief Initializes the voice caller.
     * This should be called when the connection is open.
     */
    virtual void initialize() = 0;

    /**
     * \brief De-initializes the voice caller.
     * This should be called when the connection is about to be closed.
     */
    virtual void deinitialize() = 0;

    /**
     * \brief Call the given JID.
     */
    virtual void call(const Jid&) = 0;

    /**
     * \brief Accept a call from the given JID.
     */
    virtual void accept(const Jid&) = 0;

    /**
     * \brief Reject the call from the given JID.
     */
    virtual void reject(const Jid&) = 0;

    /**
     * \brief Terminate the call from the given JID.
     */
    virtual void terminate(const Jid&) = 0;

signals:
    /**
     * \brief Incoming call from the given JID.
     */
    void incoming(const Jid&);

    /**
     * \brief Contact accepted an incoming call.
     */
    void accepted(const Jid&);

    /**
     * \brief Contact rejected an incoming call.
     */
    void rejected(const Jid&);

    /**
     * \brief Call with given JID is in progress.
     */
    void in_progress(const Jid&);

    /**
     * \brief Call with given JID is terminated.
     */
    void terminated(const Jid&);

private:
    PsiAccount* account_;
};

#endif
