---

plugin.h

Go to the documentation of this file.

/*
   This file is part of the KDB libraries
   Copyright (c) 2000 Praduroux Alessandro <pradu@thekompany.com>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 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
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.
*/     
#ifndef PLUGIN_H
#define PLUGIN_H

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <qstring.h>
#include <qlist.h>

#include "kdb.h"
#include "object.h"
#include "connection.h"

namespace KDB {

class Capability;
class Connector;

class Plugin;
typedef QList<Plugin>         PluginList;
typedef QListIterator<Plugin> PluginIterator;

class Plugin: public Object {
    
    friend class Connection;
    
    Q_OBJECT

public:

    struct PluginInfo {
        QString name;
        QString description;
        QString version;
        QString author;
        QString e_mail;
        QString copyright;
    };

public:

    Plugin(const char * name = 0, QObject *parent = 0);
    virtual ~Plugin();

    virtual PluginInfo info() = 0;

    Connection * openConnection (const QString &host,
                                 int port = 0,
                                 const QString &user = QString::null,
                                 const QString &password = QString::null);

    virtual Connection * addConnection (const QString &host,
                                        int port = 0,
                                        const QString &user = QString::null,
                                        const QString &password = QString::null);

    void remove(Connection *);

    Connection * findConnection(const QString &host, const QString & user);

    ConnectionIterator begin();

    virtual bool provides(capability cap) = 0;

    virtual Capability * createObject(capability cap) = 0;


 signals:

    void closing(Plugin *);

 protected slots:
        
    void slotConnectionClose(Connection *);
        
 protected:

    void registerConnection(Connection *);
                  
    // these member functions must be overridden by implementations
    virtual Connector *createConnector() = 0;

 private:

    ConnectionList m_connections;
};

};

#endif

---