remote_access_interface.h

/*
    SPDX-FileCopyrightText: 2016 Oleg Chernovskiy <[email protected]>
 
    SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/
#ifndef KWAYLAND_SERVER_REMOTE_ACCESS_INTERFACE_H
#define KWAYLAND_SERVER_REMOTE_ACCESS_INTERFACE_H
 
#include "global.h"
 
namespace KWayland
{
namespace Server
{
class Display;
class OutputInterface;
 
/**
 * The structure server should fill to use this interface.
 * Lifecycle:
 *  1. BufferHandle is filled and passed to RemoteAccessManager
 *     (stored in manager's sent list)
 *  2. Clients confirm that they wants this buffer, the RemoteBuffer
 *     interfaces are then created and wrapped around BufferHandle.
 *  3. Once all clients are done with buffer (or disconnected),
 *     RemoteBuffer notifies manager and release signal is emitted.
 *
 *     It's the responsibility of your process to delete this BufferHandle
 *     and release its' fd afterwards.
 **/
class KWAYLANDSERVER_EXPORT BufferHandle
{
public:
    explicit BufferHandle();
    virtual ~BufferHandle();
    void setFd(qint32 fd);
    void setSize(quint32 width, quint32 height);
    void setStride(quint32 stride);
    void setFormat(quint32 format);
 
    qint32 fd() const;
    quint32 height() const;
    quint32 width() const;
    quint32 stride() const;
    quint32 format() const;
 
private:
    friend class RemoteAccessManagerInterface;
    friend class RemoteBufferInterface;
    class Private;
    QScopedPointer<Private> d;
};
 
class KWAYLANDSERVER_EXPORT RemoteAccessManagerInterface : public Global
{
    Q_OBJECT
public:
    ~RemoteAccessManagerInterface() override = default;
 
    /**
     * Store buffer in sent list and notify client that we have a buffer for it
     **/
    void sendBufferReady(const OutputInterface *output, const BufferHandle *buf);
    /**
     * Check whether interface has been bound
     **/
    bool isBound() const;
 
Q_SIGNALS:
    /**
     * Previously sent buffer has been released by client
     */
    void bufferReleased(const BufferHandle *buf);
 
private:
    explicit RemoteAccessManagerInterface(Display *display, QObject *parent = nullptr);
    friend class Display;
    class Private;
};
 
}
}
 
#endif