Package org.freedesktop.wayland.server

Class Client

java.lang.Object

org.freedesktop.wayland.server.Client

public class Client
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
final MemorySegment	pointer

Method Summary

Modifier and Type	Method	Description
protected void	addDestroyListener(org.freedesktop.wayland.server.Listener listener)
static Client	create(Display display, int fd)	Create a client for the given file descriptor
void	destroy()
boolean	equals(Object o)
void	flush()	Flush pending events to the client,
static Client	get(MemorySegment pointer)
ClientCredentials	getCredentials()	Return Unix credentials for the client
Display	getDisplay()	Get the display object for the given client
Resource<?>	getObject(int id)	Look up an object in the client name space.
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

pointer

public final MemorySegment pointer

Method Details

create

public static Client create(Display display,
 int fd)

Create a client for the given file descriptor

Given a file descriptor corresponding to one end of a socket, this function will create a Client and add the new client to the compositors client list. At that point, the client is initialized and ready to run, as if the client had connected to the servers listening socket. When the client eventually sends requests to the compositor, the Client argument to the request handler will be the client returned from this function.

The other end of the socket can be passed to {link WlDisplayProxy#connectToFd(int)} on the client side or used with the WAYLAND_SOCKET environment variable on the client side.

On failure this function sets errno accordingly and returns NULL.

Parameters:

display - The display object

fd - The file descriptor for the socket to the client

Returns:

The new client object or NULL on failure.

get

public static Client get(MemorySegment pointer)

flush

public void flush()

Flush pending events to the client,

Events sent to clients are queued in a buffer and written to the socket later - typically when the compositor has handled all requests and goes back to block in the event loop. This function flushes all queued up events for a client immediately.

addDestroyListener

protected void addDestroyListener(org.freedesktop.wayland.server.Listener listener)

getDisplay

public Display getDisplay()

Get the display object for the given client

Returns:

The display object the client is associated with.

getObject

public Resource<?> getObject(int id)

Look up an object in the client name space. This looks up an object in the client object name space by its object ID.

Parameters:

id - The object id

Returns:

The object or null if there is not object for the given ID

getCredentials

public ClientCredentials getCredentials()

Return Unix credentials for the client

This function returns the process ID, the user ID and the group ID for the given client. The credentials come from getsockopt() with SO_PEERCRED, on the client socket fd.

Be aware that for clients that a compositor forks and execs and then connects using socketpair(), this function will return the credentials for the compositor. The credentials for the socketpair are set at creation time in the compositor.

destroy

public void destroy()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object