docs: Update README.md badge, download for Actions
[quassel.git] / src / common / peerfactory.h
1 /***************************************************************************
2  *   Copyright (C) 2005-2020 by the Quassel Project                        *
3  *   devel@quassel-irc.org                                                 *
4  *                                                                         *
5  *   This program is free software; you can redistribute it and/or modify  *
6  *   it under the terms of the GNU General Public License as published by  *
7  *   the Free Software Foundation; either version 2 of the License, or     *
8  *   (at your option) version 3.                                           *
9  *                                                                         *
10  *   This program is distributed in the hope that it will be useful,       *
11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
13  *   GNU General Public License for more details.                          *
14  *                                                                         *
15  *   You should have received a copy of the GNU General Public License     *
16  *   along with this program; if not, write to the                         *
17  *   Free Software Foundation, Inc.,                                       *
18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
19  ***************************************************************************/
20
21 #pragma once
22
23 #include "common-export.h"
24
25 #include <QPair>
26
27 #include "compressor.h"
28 #include "protocol.h"
29
30 class QObject;
31 class QTcpSocket;
32
33 class AuthHandler;
34 class RemotePeer;
35
36 class COMMON_EXPORT PeerFactory
37 {
38 public:
39     // second value is the protocol-specific features
40     using ProtoDescriptor = QPair<Protocol::Type, quint16>;
41     using ProtoList = QVector<ProtoDescriptor>;
42
43     static ProtoList supportedProtocols();
44
45     static RemotePeer* createPeer(const ProtoDescriptor& protocol,
46                                   AuthHandler* authHandler,
47                                   QTcpSocket* socket,
48                                   Compressor::CompressionLevel level,
49                                   QObject* parent = nullptr);
50     static RemotePeer* createPeer(const ProtoList& protocols,
51                                   AuthHandler* authHandler,
52                                   QTcpSocket* socket,
53                                   Compressor::CompressionLevel level,
54                                   QObject* parent = nullptr);
55 };