Differential D1231 Diff 16359 src/client/remote_access.h

Changeset View

Standalone View

View Options

src/client/remote_access.h

  • This file was added.
1​/****************************************************************************
2​Copyright 2016 Oleg Chernovskiy <kanedias@xaker.ru>
3​
4​This library is free software; you can redistribute it and/or
5​modify it under the terms of the GNU Lesser General Public
6​License as published by the Free Software Foundation; either
7​version 2.1 of the License, or (at your option) version 3, or any
8​later version accepted by the membership of KDE e.V. (or its
9​successor approved by the membership of KDE e.V.), which shall
10​act as a proxy defined in Section 6 of version 3 of the license.
11​
12​This library is distributed in the hope that it will be useful,
13​but WITHOUT ANY WARRANTY; without even the implied warranty of
14​MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15​Lesser General Public License for more details.
16​
17​You should have received a copy of the GNU Lesser General Public
18​License along with this library. If not, see <http://www.gnu.org/licenses/>.
19​****************************************************************************/
20​#ifndef KWAYLAND_CLIENT_REMOTE_ACCESS_H
21​#define KWAYLAND_CLIENT_REMOTE_ACCESS_H
22​
23​#include <QObject>
24​
25​#include <KWayland/Client/kwaylandclient_export.h>
26​
27​struct org_kde_kwin_remote_access_manager;
28​struct org_kde_kwin_remote_buffer;
29​struct wl_output;
30​
31​namespace KWayland
32​{
33​namespace Client
34​{
35​
36​class EventQueue;
37​class RemoteBuffer;
38​
39​/**
40​ * @short Wrapper for the org_kde_kwin_remote_access_manager interface.
41​ *
42​ * This class provides a convenient wrapper for the org_kde_kwin_remote_access_manager interface.
43​ *
44​ * To use this class one needs to interact with the Registry. There are two
45​ * possible ways to create the RemoteAccessManager interface:
46​ * @code
47​ * RemoteAccessManager *c = registry->createRemoteAccessManager(name, version);
48​ * @endcode
49​ *
50​ * This creates the RemoteAccessManager and sets it up directly. As an alternative this
51​ * can also be done in a more low level way:
52​ * @code
53​ * RemoteAccessManager *c = new RemoteAccessManager;
54​ * c->setup(registry->bindRemoteAccessManager(name, version));
55​ * @endcode
56​ *
57​ * The RemoteAccessManager can be used as a drop-in replacement for any org_kde_kwin_remote_access_manager
58​ * pointer as it provides matching cast operators.
59​ *
60​ * @see Registry
61​ **/
62​class KWAYLANDCLIENT_EXPORT RemoteAccessManager : public QObject
63​{
64​ Q_OBJECT
65​public:
66​ /**
67​ * Creates a new RemoteAccessManager.
68​ * Note: after constructing the RemoteAccessManager it is not yet valid and one needs
69​ * to call setup. In order to get a ready to use RemoteAccessManager prefer using
70​ * Registry::createRemoteAccessManager.
71​ **/
72​ explicit RemoteAccessManager(QObject *parent = nullptr);
73​ virtual ~RemoteAccessManager();
74​
75​ /**
76​ * Setup this RemoteAccessManager to manage the @p remoteaccessmanager.
77​ * When using Registry::createRemoteAccessManager there is no need to call this
78​ * method.
79​ **/
80​ void setup(org_kde_kwin_remote_access_manager *remoteaccessmanager);
81​ /**
82​ * @returns @c true if managing a org_kde_kwin_remote_access_manager.
83​ **/
84​ bool isValid() const;
85​ /**
86​ * Releases the org_kde_kwin_remote_access_manager interface.
87​ * After the interface has been released the RemoteAccessManager instance is no
88​ * longer valid and can be setup with another org_kde_kwin_remote_access_manager interface.
89​ **/
90​ void release();
91​ /**
92​ * Destroys the data held by this RemoteAccessManager.
93​ * This method is supposed to be used when the connection to the Wayland
94​ * server goes away. If the connection is not valid anymore, it's not
95​ * possible to call release anymore as that calls into the Wayland
96​ * connection and the call would fail. This method cleans up the data, so
97​ * that the instance can be deleted or set up to a new org_kde_kwin_remote_access_manager interface
98​ * once there is a new connection available.
99​ *
100​ * It is suggested to connect this method to ConnectionThread::connectionDied:
101​ * @code
102​ * connect(connection, &ConnectionThread::connectionDied, remoteaccessmanager, &RemoteAccessManager::destroy);
103​ * @endcode
104​ *
105​ * @see release
106​ **/
107​ void destroy();
108​
109​ /**
110​ * Sets the @p queue to use for creating objects with this RemoteAccessManager.
111​ **/
112​ void setEventQueue(EventQueue *queue);
113​ /**
114​ * @returns The event queue to use for creating objects with this RemoteAccessManager.
115​ **/
116​ EventQueue *eventQueue();
117​
118​ operator org_kde_kwin_remote_access_manager*();
119​ operator org_kde_kwin_remote_access_manager*() const;
120​
121​Q_SIGNALS:
122​ /**
123​ * The corresponding global for this interface on the Registry got removed.
124​ *
125​ * This signal gets only emitted if the RemoteAccessManager got created by
126​ * Registry::createRemoteAccessManager
127​ **/
128​ void removed();
129​
130​ /**
131​ * Buffer from server is ready to be delivered to this client
132​ * @param buffer_id internal buffer id to be created
133​ **/
134​ void bufferReady(const void* output, const RemoteBuffer *rbuf);
135​
136​private:
137​ class Private;
138​ QScopedPointer<Private> d;
139​};
140​
141​/**
142​ * @short Wrapper for org_kde_kwin_remote_buffer interface.
143​ * The instances of this class are created by parent RemoteAccessManager.
144​ * Deletion (by noLongerNeeded call) is in responsibility of underlying system.
145​ */
146​class KWAYLANDCLIENT_EXPORT RemoteBuffer : public QObject
147​{
148​ Q_OBJECT
149​public:
150​ virtual ~RemoteBuffer();
151​ /**
152​ * Setup this RemoteBuffer to manage the @p remotebuffer.
153​ **/
154​ void setup(org_kde_kwin_remote_buffer *remotebuffer);
155​ /**
156​ * @returns @c true if managing a org_kde_kwin_remote_buffer.
157​ **/
158​ bool isValid() const;
159​ /**
160​ * Releases the org_kde_kwin_remote_buffer interface.
161​ * After the interface has been released the RemoteBuffer instance is no
162​ * longer valid and can be setup with another org_kde_kwin_remote_buffer interface.
163​ **/
164​ void release();
165​ /**
166​ * Destroys the data held by this RemoteBuffer.
167​ * This method is supposed to be used when the connection to the Wayland
168​ * server goes away. If the connection is not valid anymore, it's not
169​ * possible to call release anymore as that calls into the Wayland
170​ * connection and the call would fail. This method cleans up the data, so
171​ * that the instance can be deleted or set up to a new org_kde_kwin_remote_buffer interface
172​ * once there is a new connection available.
173​ *
174​ * It is suggested to connect this method to ConnectionThread::connectionDied:
175​ * @code
176​ * connect(connection, &ConnectionThread::connectionDied, remotebuffer, &RemoteBuffer::destroy);
177​ * @endcode
178​ *
179​ * @see release
180​ **/
181​ void destroy();
182​
183​ operator org_kde_kwin_remote_buffer*();
184​ operator org_kde_kwin_remote_buffer*() const;
185​
186​ qint32 fd() const;
187​ quint32 width() const;
188​ quint32 height() const;
189​ quint32 stride() const;
190​ quint32 format() const;
191​
192​
graesslinUnsubmitted
Done

I would make the arguments getters in the interface and rather have an empty signal.

graesslin: I would make the arguments getters in the interface and rather have an empty signal.
193​Q_SIGNALS:
194​ void parametersObtained();
graesslinUnsubmitted
Done

hmm maybe parametersObtained?

graesslin: hmm maybe parametersObtained?
KanediasAuthorUnsubmitted
Not Done

Sounds reasonable, changed

Kanedias: Sounds reasonable, changed
195​
196​private:
197​
198​ friend class RemoteAccessManager;
199​ explicit RemoteBuffer(QObject *parent = nullptr);
200​ class Private;
201​ QScopedPointer<Private> d;
202​};
203​
204​
205​}
206​}
207​
208​#endif