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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
/**
* This file is part of TelepathyQt4
*
* @copyright Copyright (C) 2011 Collabora Ltd. <http://www.collabora.co.uk/>
* @copyright Copyright (C) 2011 Nokia Corporation
* @license LGPL 2.1
*
* This library 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.
*
* 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef _TelepathyQt4_stream_tube_client_h_HEADER_GUARD_
#define _TelepathyQt4_stream_tube_client_h_HEADER_GUARD_
#include <TelepathyQt4/AccountFactory>
#include <TelepathyQt4/ChannelFactory>
#include <TelepathyQt4/ConnectionFactory>
#include <TelepathyQt4/ContactFactory>
#include <TelepathyQt4/RefCounted>
#include <TelepathyQt4/Types>
class QHostAddress;
namespace Tp
{
class PendingStreamTubeConnection;
// TODO: Turn the comments here into real doxymentation
class TELEPATHY_QT4_EXPORT StreamTubeClient : public QObject, public RefCounted
{
Q_OBJECT
Q_DISABLE_COPY(StreamTubeClient)
class TubeWrapper;
public:
class TcpSourceAddressGenerator
{
public:
virtual QPair<QHostAddress, quint16>
nextSourceAddress(const AccountPtr &account, const IncomingStreamTubeChannelPtr &tube) = 0;
protected:
virtual ~TcpSourceAddressGenerator() {}
};
class Tube : public QPair<AccountPtr, IncomingStreamTubeChannelPtr>
{
public:
Tube();
Tube(const AccountPtr &account, const IncomingStreamTubeChannelPtr &channel);
Tube(const Tube &other);
~Tube();
bool isValid() const { return mPriv.constData() != 0; }
Tube &operator=(const Tube &other);
const AccountPtr &account() const
{
return first;
}
const IncomingStreamTubeChannelPtr &channel() const
{
return second;
}
private:
struct Private;
friend struct Private;
QSharedDataPointer<Private> mPriv;
};
// The client name can be passed to allow service-activation. If service activation is not
// desired, the name can be left out, in which case an unique name will be generated.
// Different parameter order, because services is a mandatory param so it can't follow
// the factory params which have default args
static StreamTubeClientPtr create(
const QStringList &p2pServices,
const QStringList &roomServices = QStringList(),
const QString &clientName = QString(),
bool monitorConnections = false,
bool bypassApproval = false,
const AccountFactoryConstPtr &accountFactory =
AccountFactory::create(QDBusConnection::sessionBus()),
const ConnectionFactoryConstPtr &connectionFactory =
ConnectionFactory::create(QDBusConnection::sessionBus()),
const ChannelFactoryConstPtr &channelFactory =
ChannelFactory::create(QDBusConnection::sessionBus()),
const ContactFactoryConstPtr &contactFactory =
ContactFactory::create());
static StreamTubeClientPtr create(
const QDBusConnection &bus,
const AccountFactoryConstPtr &accountFactory,
const ConnectionFactoryConstPtr &connectionFactory,
const ChannelFactoryConstPtr &channelFactory,
const ContactFactoryConstPtr &contactFactory,
const QStringList &p2pServices,
const QStringList &roomServices = QStringList(),
const QString &clientName = QString(),
bool monitorConnections = false,
bool bypassApproval = false);
static StreamTubeClientPtr create(
const AccountManagerPtr &accountManager,
const QStringList &p2pServices,
const QStringList &roomServices = QStringList(),
const QString &clientName = QString(),
bool monitorConnections = false,
bool bypassApproval = false);
static StreamTubeClientPtr create(
const ClientRegistrarPtr ®istrar,
const QStringList &p2pServices,
const QStringList &roomServices = QStringList(),
const QString &clientName = QString(),
bool monitorConnections = false,
bool bypassApproval = false);
virtual ~StreamTubeClient();
ClientRegistrarPtr registrar() const;
QString clientName() const;
bool isRegistered() const;
bool monitorsConnections() const;
bool acceptsAsTcp() const; // if setToAcceptAsTCP has been used last
TcpSourceAddressGenerator *tcpGenerator() const; // warn and return NULL if !acceptsAsTCP
bool acceptsAsUnix() const; // if setToAcceptAsUnix has been used last
void setToAcceptAsTcp(TcpSourceAddressGenerator *generator = 0); // 0 -> Localhost AC used
void setToAcceptAsUnix(bool requireCredentials = false); // whether CM should req SCM_CREDENTIALS
// This will always be populated
QList<Tube> tubes() const;
QHash<Tube, QSet<uint> > connections() const;
Q_SIGNALS:
// These will always be emitted
void tubeOffered(
const Tp::AccountPtr &account,
const Tp::IncomingStreamTubeChannelPtr &tube);
void tubeClosed(
const Tp::AccountPtr &account,
const Tp::IncomingStreamTubeChannelPtr &tube,
const QString &error,
const QString &message);
// These will be emitted if a offered tube is accepted successfully, when setToAcceptAsTCP/Unix
// has been called last
void tubeAcceptedAsTcp(
const QHostAddress &listenAddress,
quint16 listenPort,
const QHostAddress &sourceAddress, // these are populated with the source address the
quint16 sourcePort, // generator, if any, yieled for this tube
const Tp::AccountPtr &account,
const Tp::IncomingStreamTubeChannelPtr &tube);
void tubeAcceptedAsUnix(
const QString &listenAddress,
bool requiresCredentials, // this is the requireCredentials param unchanged
uchar credentialByte,
const Tp::AccountPtr &account,
const Tp::IncomingStreamTubeChannelPtr &tube);
// These will be emitted if monitorConnections = true was passed to the create() method
// Sadly, there is no other possible way to associate multiple connections through a single tube
// with the actual sockets than connecting one socket at a time and waiting for newConnection()
void newConnection(
const Tp::AccountPtr &account,
const Tp::IncomingStreamTubeChannelPtr &tube,
uint connectionId);
void connectionClosed(
const Tp::AccountPtr &account,
const Tp::IncomingStreamTubeChannelPtr &tube,
uint connectionId,
const QString &error,
const QString &message);
private Q_SLOTS:
TELEPATHY_QT4_NO_EXPORT void onInvokedForTube(
const Tp::AccountPtr &account,
const Tp::StreamTubeChannelPtr &tube,
const QDateTime &userActionTime,
const Tp::ChannelRequestHints &requestHints);
TELEPATHY_QT4_NO_EXPORT void onAcceptFinished(TubeWrapper *, Tp::PendingStreamTubeConnection *);
TELEPATHY_QT4_NO_EXPORT void onTubeInvalidated(Tp::DBusProxy *, const QString &, const QString &);
TELEPATHY_QT4_NO_EXPORT void onNewConnection(
TubeWrapper *wrapper,
uint conn);
TELEPATHY_QT4_NO_EXPORT void onConnectionClosed(
TubeWrapper *wrapper,
uint conn,
const QString &error,
const QString &message);
private:
TELEPATHY_QT4_NO_EXPORT StreamTubeClient(
const ClientRegistrarPtr ®istrar,
const QStringList &p2pServices,
const QStringList &roomServices,
const QString &clientName,
bool monitorConnections,
bool bypassApproval);
struct Private;
Private *mPriv;
};
} // Tp
#endif
|
