Kapotah/peer.h at master · shaan7/Kapotah · GitHub

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
/*
    This file is part of the Kapotah project.
    Copyright (C) 2010 Shantanu Tushar <shaan7in@gmail.com>
    Copyright (C) 2010 Sudhendu Kumar <sudhendu.kumar.roy@gmail.com>

    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 3 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 program.  If not, see <http://www.gnu.org/licenses/>.
*/


#ifndef KAPOTAH_PEER_H
#define KAPOTAH_PEER_H

#include <QString>
#include <QHostAddress>

namespace Kapotah
{

    /**
     * \brief Stores information about a peer
     *
     * The Peer class stores information such as name and IP address
     * of a peer. Can be extended in the future to include other
     * information
     */
    class Peer
    {

        public:
            Peer();
            Peer(const QString &name, const QHostAddress &ipAddress);

            /**
             * Returns the advertised name of the peer on the network
             *
             * @return  Peer's name
             */
            QString name() const;

            /**
             * Set the advertised name of the peer on the network
             * \warning For internal purposes only, do not use from the UI
             *
             * @param   name    Peer's name
             */
            void setName (const QString &name);

            /**
             * Returns the IP address of the peer's device
             *
             * @return  Peer's IP address
             */
            QHostAddress ipAddress() const;

            /**
             * Set the IP address of the peer
             * \warning For internal purposes only, do not use from the UI
             *
             * @param   ipAddress       IP address of peer
             */
            void setIpAddress (const QHostAddress &ipAddress);

            bool operator==(const Peer &peer);

        private:
            QString m_name;
            QHostAddress m_ipAddress;
    };
}

#endif // KAPOTAH_PEER_H