Package org.freedesktop.wayland.client

Class Proxy<I>

java.lang.Object

org.freedesktop.wayland.client.Proxy<I>

Type Parameters:

I - Implementation type that will act as the listener for received events.

All Implemented Interfaces:

WaylandObject

Direct Known Subclasses:

Display, WlBufferProxy, WlCallbackProxy, WlCompositorProxy, WlDataDeviceManagerProxy, WlDataDeviceProxy, WlDataOfferProxy, WlDataSourceProxy, WlKeyboardProxy, WlOutputProxy, WlPointerProxy, WlRegionProxy, WlRegistryProxy, WlSeatProxy, WlShellProxy, WlShellSurfaceProxy, WlShmPoolProxy, WlShmProxy, WlSubcompositorProxy, WlSubsurfaceProxy, WlSurfaceProxy, WlTouchProxy, WpPresentationFeedbackProxy, WpPresentationProxy, WpViewporterProxy, WpViewportProxy, XdgPopupProxy, XdgPositionerProxy, XdgSurfaceProxy, XdgToplevelProxy, XdgWmBaseProxy, ZwpLinuxBufferParamsV1Proxy, ZwpLinuxDmabufFeedbackV1Proxy, ZwpLinuxDmabufV1Proxy, ZwpTabletManagerV2Proxy, ZwpTabletPadGroupV2Proxy, ZwpTabletPadRingV2Proxy, ZwpTabletPadStripV2Proxy, ZwpTabletPadV2Proxy, ZwpTabletSeatV2Proxy, ZwpTabletToolV2Proxy, ZwpTabletV2Proxy

public abstract class Proxy<I>
extends Object
implements WaylandObject

Represents a protocol object on the client side.

A Proxy acts as a client side proxy to an object existing in the compositor. The proxy is responsible for converting requests made by the clients with marshal(int) into Wayland's wire format. Events coming from the compositor are also handled by the proxy, which will in turn call the implementation.

With the exception of function setQueue(EventQueue), functions accessing a Proxy are not normally used by client code. Clients should normally use the higher level interface generated by the scanner to interact with compositor objects.

Field Summary

Fields

Modifier and Type	Field	Description
final MemorySegment	pointer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Proxy(MemorySegment pointer)
protected	Proxy(MemorySegment pointer, I implementation, int version)

Method Summary

Modifier and Type	Method	Description
void	destroy()	Destroy a proxy object
boolean	equals(Object o)
int	getId()	Get the id of a proxy object
I	getImplementation()	Get a proxy's listener
MemorySegment	getPointer()
int	getVersion()
int	hashCode()
protected void	marshal(int opcode)
protected void	marshal(int opcode, Arguments args)	Prepare a request to be sent to the compositor
protected <J, T extends Proxy<J>> T	marshalConstructor(int opcode, J implementation, int version, Class<T> newProxyCls, Arguments args)	Prepare a request to be sent to the compositor
void	setQueue(EventQueue queue)	Assign a proxy to an event queue

Methods inherited from class java.lang.Object

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

Field Details

pointer

public final MemorySegment pointer

Constructor Details

Proxy

protected Proxy(MemorySegment pointer)

Proxy

protected Proxy(MemorySegment pointer,
 I implementation,
 int version)

Parameters:

pointer -

implementation - The listener to be added to proxy

version -

Method Details

marshal

protected void marshal(int opcode,
 Arguments args)

Prepare a request to be sent to the compositor

This function is similar to marshalConstructor(int, Object, int, Class, Arguments), except it doesn't create proxies for new-id arguments.

This should not normally be used by non-generated code.

Parameters:

opcode - Opcode of the request to be sent

args - Extra arguments for the given request

marshal

protected void marshal(int opcode)

Parameters:

opcode - Opcode of the request to be sent see {link #marshal(int, Arguments)}

marshalConstructor

protected <J,
T extends Proxy<J>> T marshalConstructor(int opcode,
 J implementation,
 int version,
 Class<T> newProxyCls,
 Arguments args)

Prepare a request to be sent to the compositor

Translates the request given by opcode and the extra arguments into the wire format and write it to the connection buffer.

For new-id arguments, this function will allocate a new Proxy and send the ID to the server. The new Proxy will be returned on success or NULL on errror with errno set accordingly.

This is intended to be used by language bindings and not in non-generated code.

Type Parameters:

J - implementation Type

T - proxy Type

Parameters:

opcode - Opcode of the request to be sent

implementation - The listener to use for the new proxy

version - The runtime version of the new proxy

newProxyCls - The type to use for the new proxy

args - Extra arguments for the given request

Returns:

a new proxy

getImplementation

public I getImplementation()

Get a proxy's listener

Gets the proxy's listener; which is the implementation set when this proxy was constructed.

This function is useful in client with multiple listeners on the same interface to allow the identification of which code to execute.

Specified by:

getImplementation in interface WaylandObject

Returns:

The proxy's listener or NULL if no listener is set

getId

public int getId()

Get the id of a proxy object

Specified by:

getId in interface WaylandObject

Returns:

The id the object associated with the proxy

getVersion

public int getVersion()

Specified by:

getVersion in interface WaylandObject

setQueue

public void setQueue(EventQueue queue)

Assign a proxy to an event queue

Assign proxy to event queue. Events coming from proxy will be queued in queue instead of the display's main queue.

Parameters:

queue - The event queue that will handle this proxy

See Also:

• Display.dispatchQueue(EventQueue)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

destroy

public void destroy()

Destroy a proxy object

getPointer

public MemorySegment getPointer()

Specified by:

getPointer in interface WaylandObject