mnodemodelprotocolinterface.h

Go to the documentation of this file.

/*     -*-C++-*- -*-coding: utf-8-unix;-*-
    Classified Ads is Copyright (c) Antti Järvinen 2013.

    This file is part of Classified Ads.

    Classified Ads 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.

    Classified Ads 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.

    You should have received a copy of the GNU Lesser General Public
    License along with Classified Ads; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/

#ifndef M_NODEMODEL_PROTOCOL_INTERFACE_H
#define M_NODEMODEL_PROTOCOL_INTERFACE_H
#include <QPair>
class Connection ;
class QHostAddress ;
class Node ;
class QSslKey ;
class QSslCertificate ;
class Hash ;


class MNodeModelProtocolInterface  {
public:
    typedef struct HostConnectQueueItemStructure {
        QHostAddress iAddress ; 
        int iPort ; 
        Hash iNodeHash ; 
        bool operator==(const struct HostConnectQueueItemStructure& a) const ;
    } HostConnectQueueItem ;
    virtual bool nodeGreetingReceived(Node& aNode ,
                                      bool aWasInitialGreeting = false ) = 0 ;
    virtual Hash& nodeFingerPrint() = 0 ; 
    virtual int listenPortOfThisNode() = 0 ; 
    virtual void setListenPortOfThisNode(int port) = 0 ;
    virtual const QSslCertificate& nodeCert()  const = 0 ;
    virtual const QSslKey& nodeKey()  const = 0 ;
    virtual QByteArray* getNextItemToSend(Connection& aConnection) = 0  ;
    virtual Node* nodeByHash(const Hash& aHash) = 0 ;
    virtual QList<Node *>* getNodesBeforeHash(const Hash& aHash,
            unsigned aMaxNodes) = 0 ;
    virtual void       closeOldestInactiveConnection() = 0 ;
    virtual QList<Node *>* getNodesAfterHash(const Hash& aHash,
            unsigned aMaxNodes,
            int aMaxInactivityMinutes = -1 ) = 0 ;
    virtual QList<HostConnectQueueItem> getHotAddresses() = 0 ;
    virtual bool updateNodeLastConnectTimeInDb(Node& aNode) =0 ;
    virtual QList<Node *>* getHotNodes(int aMaxNodes) = 0 ;
    virtual void addNodeFromBroadcast(const Hash& aNodeFingerPrint,
                                      const QHostAddress& aAddr,
                                      int aPort ) = 0 ;
    virtual bool addNodeToConnectionWishList(Node* aNode) = 0 ;

    virtual bool addNodeToConnectionWishList(const Hash& aNode) = 0 ;

    virtual Node* nextConnectionWishListItem() = 0  ;
    virtual bool isNodeAlreadyConnected(const Node& aNode) const = 0 ;
    virtual bool isNodeAlreadyConnected(const Hash& aHash) const = 0 ;
    virtual Hash bucketEndHash(const Hash& aFingerPrintOfNodeAsking) = 0 ;
    virtual bool updateNodeLastMutualConnectTimeInDb(const Hash& aNodeFp,
            quint32 aTime ) = 0 ;
    virtual void setDnsName(QString aName) = 0 ;
    virtual QString getDnsName() = 0 ;
    virtual void offerNodeToRecentlyFailedList(const Hash& aFailedNodeHash) = 0 ;
};
#endif