KWayland::Server::ClientConnection Class Reference

#include <clientconnection.h>

Inheritance diagram for KWayland::Server::ClientConnection:

Signals
void	disconnected (KWayland::Server::ClientConnection *)

Public Member Functions
wl_client *	client ()
wl_resource *	createResource (const wl_interface *interface, quint32 version, quint32 id)
void	destroy ()
Display *	display ()
QString	executablePath () const
void	flush ()
wl_resource *	getResource (quint32 id)
gid_t	groupId () const
	operator wl_client * ()
	operator wl_client * () const
pid_t	processId () const
uid_t	userId () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const
bool	disconnect (const QObject *receiver, const char *method) const
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const
bool	inherits (const char *className) const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const
bool	isWindowType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
QString	objectName () const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const
QVariant	property (const char *name) const
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval, Qt::TimerType timerType)
QThread *	thread () const

Additional Inherited Members
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Convenient Class which represents a wl_client.

The ClientConnection gets automatically created for a wl_client when a wl_client is first used in the context of KWayland::Server. In particular the signal Display::clientConnected will be emitted.

See also

Display

Definition at line 49 of file clientconnection.h.

Member Function Documentation

wl_client * KWayland::Server::ClientConnection::client

(

)

Returns

the native wl_client this ClientConnection represents.

Definition at line 133 of file clientconnection.cpp.

wl_resource * KWayland::Server::ClientConnection::createResource	(	const wl_interface *	interface,
		quint32	version,
		quint32	id
	)

Creates a new wl_resource for the provided interface.

Thus a convenient wrapper around wl_resource_create

Parameters

interface
version
id

Returns

the created native wl_resource

Definition at line 117 of file clientconnection.cpp.

void KWayland::Server::ClientConnection::destroy

(

)

Destroys this ClientConnection.

This is a convenient wrapper around wl_client_destroy. The use case is in combination with ClientConnections created through Display::createClient. E.g. once the process for the ClientConnection exited, the ClientConnection needs to be destroyed, too.

Since

5.5

Definition at line 109 of file clientconnection.cpp.

void KWayland::Server::ClientConnection::disconnected ( KWayland::Server::ClientConnection *  )

signal

Signal emitted when the ClientConnection got disconnected from the server.

Display * KWayland::Server::ClientConnection::display

(

)

Returns

The Display this ClientConnection is connected to

Definition at line 148 of file clientconnection.cpp.

QString KWayland::Server::ClientConnection::executablePath

(

)

const

The absolute path to the executable.

Please note: if the ClientConnection got created with Display::createClient the executablePath will be identical to the process running the KWayland::Server::Display.

If the executable path cannot be resolved an empty QString is returned.

See also

processId

Since

5.6

Definition at line 168 of file clientconnection.cpp.

void KWayland::Server::ClientConnection::flush

(

)

Flushes the connection to this client.

Ensures that all events are pushed to the client.

Definition at line 101 of file clientconnection.cpp.

wl_resource * KWayland::Server::ClientConnection::getResource

(

quint32

id

)

Get the wl_resource associated with the given id.

Since

5.3

Definition at line 125 of file clientconnection.cpp.

gid_t KWayland::Server::ClientConnection::groupId

(

)

const

The gid of the ClientConnection endpoint.

Please note: if the ClientConnection got created with Display::createClient the gid will be identical to the process running the KWayland::Server::Display.

Returns

The gid of the connection.

Definition at line 153 of file clientconnection.cpp.

KWayland::Server::ClientConnection::operator wl_client *

(

)

Cast operator the native wl_client this ClientConnection represents.

Definition at line 138 of file clientconnection.cpp.

KWayland::Server::ClientConnection::operator wl_client *

(

)

const

Cast operator the native wl_client this ClientConnection represents.

Definition at line 143 of file clientconnection.cpp.

pid_t KWayland::Server::ClientConnection::processId

(

)

const

The pid of the ClientConnection endpoint.

Please note: if the ClientConnection got created with Display::createClient the pid will be identical to the process running the KWayland::Server::Display.

Returns

The pid of the connection.

Definition at line 158 of file clientconnection.cpp.

uid_t KWayland::Server::ClientConnection::userId

(

)

const

The uid of the ClientConnection endpoint.

Please note: if the ClientConnection got created with Display::createClient the uid will be identical to the process running the KWayland::Server::Display.

Returns

The uid of the connection.

Definition at line 163 of file clientconnection.cpp.

---

The documentation for this class was generated from the following files:

• clientconnection.h
• clientconnection.cpp