package wayland

  1. Overview
  2. Docs
package wayland
Legend:
Library
Module
Module type
Parameter
Class
Class type

Code for writing Wayland servers.

type t
module type TRACE = Proxy.TRACE with type role = [ `Server ]
val connect : ?trace:(module TRACE) -> S.transport -> [[ `Wl_display ], [ `V1 ], [ `Server ]] Proxy.Service_handler.t -> t

connect transport handler runs the Wayland protocol over transport (typically created with Unix_transport.of_socket). It spawns a background thread to handle incoming messages. The caller is responsible for closing transport when done.

  • parameter trace

    Used to trace all messages sent and received. The default tracer logs messages at debug level, and the log's source is set to debug level if $WAYLAND_DEBUG is "1" or "server" the first time connect is called.

val wl_display : t -> [ `V1 ] Wayland_server.Wl_display.t
val closed : t -> (unit, exn) Lwt_result.t

closed t resolves when the connection is closed (either due to the other side closing it normally or because an exception was raised.

val dump : t Fmt.t

Dump the state of the connection for debugging.