File: networklistener.h

package info (click to toggle)
classified-ads 0.13-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 6,772 kB
  • sloc: cpp: 34,291; tcl: 1,175; xml: 64; makefile: 40
file content (135 lines) | stat: -rw-r--r-- 4,543 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/*     -*-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 NETWORK_LISTENER_H
#define NETWORK_LISTENER_H

#include <QTcpServer>
#include <QList>
#include "connection.h" // for ConnectionObserver
#include <QUdpSocket>
#include <QNetworkSession>

class MController ;
class Model ;
class ProtocolMessageParser ;

/**
 * @brief class for listening to incoming network connections.
 *
 * This class will spawn a @ref Connection for each received
 * network connection.
 */
class NetworkListener :
    public QTcpServer,
    public Connection::ConnectionObserver {
    Q_OBJECT
public:
    /**
     * Constructor
     * @param aController application controller for app state frobnication
     * @param aModel data model reference for data storage
     * @param aIpv6 if set to true, this class will listen in Ipv6 instead
     *        of v4 and will not enumerate local network interfaces.
     */
    NetworkListener(MController *aController,
                    Model *aModel) ;
    /**
     * Destructor
     */
    ~NetworkListener() ;
    /**
     * separate method for starting the listen. this now works with qt4.8
     * but it seems like semantics of listen may change in qt5, where
     * listening in QHostAddress::Any automatically means both v4 and v6.
     * @param aIpv6 if true, tries to listen on both IPv6
     *        and ipv4.
     * @return true if listening started.
     */
    bool startListen(bool aIpv6) ;

    /**
     * from ConnectionObserver
     */
    virtual bool dataReceived(const QByteArray& aData,
                              Connection& aConnection) ;
    /**
     * From ConnectionObserver
     * this is called by peer connection at close
     */
    virtual void connectionClosed(Connection *aDeletee) ;
    /**
     * From ConnectionObserver
     * this is called by peer connection at successful open
     */
    virtual void connectionReady(Connection *aBusinessEntity)  ;
    /**
     * used in closing of app: stops accepting connections
     */
    void stopAccepting() ;
    /** 
     * Method that loops network interfaces and tries to find a valid
     * local address to advertise 
     */
    void figureOutLocalAddresses() ;
protected:
#if QT_VERSION >= 0x050000
    virtual void incomingConnection(qintptr handle);
#else
    void incomingConnection (int aSocketDescriptor ) ;
#endif
signals:
    void error(QTcpSocket::SocketError socketError);
    /**
     * this signal is used to communicate (at least to publishing engine)
     * status of connection attempt to particular node. network connection
     * engine will spawn connections to more-or-less random nodes but
     * publishing logic may ask for connections to specific nodes.
     * this signal will communicate outcome of such requests
     */
    void nodeConnectionAttemptStatus(Connection::ConnectionState aStatus,
                                     const Hash aHashOfAttemptedNode );
private slots:
    void broadCastReceived() ;
    void threadIsDeleted() ;
    void networkStateChanged( QNetworkSession::State aState ) ; 
    /**
     * This slot is used to communicate situation where connection-attempt
     * to node fails
     * @param aNodeHash fingerprint of failed node
     */
    void connectionAttemptFailed(const Hash& aNodeHash) ;
private: // data
    MController *iController ;
    Model *iModel ;
    /** This animal here knows all incoming bytearrays */
    ProtocolMessageParser *iParser ;
    QUdpSocket iBroadCastListener ;
    /**
     * used in closing of application: flag for not accepting
     * connections any more
     */
    bool iCanAccept ;
    QNetworkConfiguration iConnectionConfig ;
    QNetworkSession* iNetworkSession ; 
} ;
#endif