org.freedesktop.wayland.server.Client Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of stubs-server Show documentation
Wayland protocol Java-language Binding Stubs
The newest version!
//Copyright 2015 Erik De Rijcke
//
//Licensed under the Apache License,Version2.0(the"License");
//you may not use this file except in compliance with the License.
//You may obtain a copy of the License at
//
//http://www.apache.org/licenses/LICENSE-2.0
//
//Unless required by applicable law or agreed to in writing,software
//distributed under the License is distributed on an"AS IS"BASIS,
//WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,either express or implied.
//See the License for the specific language governing permissions and
//limitations under the License.
package org.freedesktop.wayland.server;

import org.freedesktop.jaccall.Pointer;
import org.freedesktop.wayland.server.jaccall.WaylandServerCore;
import org.freedesktop.wayland.util.ObjectCache;

import static org.freedesktop.jaccall.Pointer.nref;

public class Client {

    public final Long pointer;

    Client(final Long pointer) {
        this.pointer = pointer;
    }

    /**
     * Create a client for the given file descriptor
     * 
     * Given a file descriptor corresponding to one end of a socket, this
     * function will create a {@link 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 {@link 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.
     *
     * @param display The display object
     * @param fd      The file descriptor for the socket to the client
     *
     * @return The new client object or NULL on failure.
     */
    public static Client create(final Display display,
                                final int fd) {
        return Client.get(WaylandServerCore.INSTANCE()
                                           .wl_client_create(display.pointer,
                                                             fd));
    }

    public static Client get(final Long pointer) {
        return new Client(pointer);
    }

    /**
     * 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.
     */
    public void flush() {
        WaylandServerCore.INSTANCE()
                         .wl_client_flush(this.pointer);
    }

//    protected void addDestroyListener(final Listener listener) {
//        checkValid(this);
//        WaylandServerLibrary.INSTANCE()
//                            .wl_client_add_destroy_listener(this.pointer,
//                                                            listener.getNative());
//    }

//    public void register(final DestroyListener destroyListener){
//        this.destroyListeners.add(destroyListener);
//    }

//    public void unregister(final DestroyListener destroyListener){
//        this.destroyListeners.remove(destroyListener);
//    }


    //TODO wl_client_get_object
    //TODO wl_client_post_no_memory
    //TODO wl_client_get_credentials

    /**
     * Get the display object for the given client
     * 

     *
     * @return The display object the client is associated with.
     */
    public Display getDisplay() {
        return Display.get(WaylandServerCore.INSTANCE()
                                            .wl_client_get_display(this.pointer));
    }

    /**
     * Look up an object in the client name space. This looks up an object in the client object name space by its
     * object ID.
     *
     * @param id The object id
     *
     * @return The object or null if there is not object for the given ID
     */
    public Resource getObject(final int id) {
        return ObjectCache.from(WaylandServerCore.INSTANCE()
                                                 .wl_client_get_object(this.pointer,
                                                                       id));
    }

    /**
     * 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.
     */
    public ClientCredentials getCredentials() {
        final Pointer pid = nref(0);
        final Pointer uid = nref(0);
        final Pointer gid = nref(0);

        WaylandServerCore.INSTANCE()
                         .wl_client_get_credentials(this.pointer,
                                                    pid.address,
                                                    uid.address,
                                                    gid.address);

        return new ClientCredentials(pid.dref(),
                                     uid.dref(),
                                     gid.dref());
    }

    public void destroy() {
        WaylandServerCore.INSTANCE()
                         .wl_client_destroy(this.pointer);
    }

    @Override
    public int hashCode() {
        return this.pointer.hashCode();
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        final Client client = (Client) o;

        return this.pointer.equals(client.pointer);
    }
}